init

Author: plc-dev

.github/workflows/images.yaml

@@ -0,0 +1,63 @@
+name: Create and publish Docker images
+
+on:
+  push:
+    branches: ["master"]
+
+env:
+  REGISTRY: ghcr.io
+
+jobs:
+  build-and-push-images:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    strategy:
+      matrix:
+        image:
+          - name: sql_to_text
+            context: ./sql_to_text
+          - name: sql_generator
+            context: ./sql_generator
+          - name: sql_validation
+            context: ./sql_feedback
+          - name: sql_feedback
+            context: ./sql_feedback
+          - name: sql_runner
+            context: ./sql_runner
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository }}-${{ matrix.image.name }}
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@v5
+        with:
+          context: ${{ matrix.image.context }}
+          file: ${{ matrix.image.dockerfile }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ github.repository }}-${{ matrix.image.name }}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

.gitignore

@@ -0,0 +1,33 @@
+# dependencies
+node_modules/
+
+# testing
+/coverage/
+
+# production
+/dist/
+
+# environment
+.env
+.env.*
+!.env.example
+
+# editor
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea/
+
+# typescript
+*.tsbuildinfo
+
+# debug
+.pnpm-debug.log*
+
+# os
+.DS_Store
+Thumbs.db
+
+**/log/*
+
+test.json

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+	"editor.rulers": [100],
+	"editor.formatOnSave": true,
+	"biome.enabled": true,
+	"editor.defaultFormatter": "biomejs.biome",
+	"editor.codeActionsOnSave": {
+		"source.organizeImports.biome": "explicit"
+	},
+	"typescript.tsdk": "node_modules/typescript/lib"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Paul Christ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,31 @@
+# SQL-Assessment
+
+## This repository holds multiple functions to generate, evaluate and give feedback on SQL-assessments
+
+- DB_introspection
+- DB_annotation
+- SQL_executor
+- SQL_generator
+- SQL_to_text
+- SQL_feedback
+- compare_tabular_results
+
+### SQL_executor
+
+```bash
+npx tsx src/sql_executor/Executor.ts "{\"args\": {\"query\": \"select * from ang_pro limit 5;\"}}" > test.json
+```
+
+### compare_tabular_results
+
+```bash
+npx tsx src/compare_tabular_results/Comparator.ts "{\"args\": {\"referenceResult\": [{\"COLUMN_A\":50}], \"studentResult\": [{\"COLUMN_A\":50}]}}" > test.json
+```
+
+###  DB_introspection
+
+```bash
+npx tsx src/db_introspection/Introspector.ts > test.json
+```
+
+## Run tests

commitlint.config.js

@@ -0,0 +1 @@
+export default { extends: ["@commitlint/config-conventional"] };

esbuild.config.js

@@ -0,0 +1,17 @@
+import { spawn } from "node:child_process";
+import { join } from "node:path";
+import { build, context } from "esbuild";
+import { esbuildVersion } from "vitest/node";
+
+const buildOptions = {
+	entryPoints: ["./src/sql_executor/Executor.ts", "./src/compare_tabular_results/Comparator.ts"],
+	bundle: true,
+	outdir: "dist",
+	format: "esm",
+	platform: "node",
+	target: "node22",
+	sourcemap: true,
+	plugins: [],
+};
+
+await build(buildOptions);