Merge pull request #61 from sebastianwessel/repo_config

Allow Override of Container Image Name #60

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test-and-build:
+    name: TypeScript Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+        with:
+          version: latest
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+
+      - name: Install Dependencies
+        id: npm-ci
+        run: npm ci
+
+      - name: Run Biome
+        run: biome ci .
+
+      - name: Test
+        id: npm-ci-test
+        run: npm test
+
+      - name: Build
+        id: npm-ci-build
+        run: npm run build

.nvmrc

@@ -1 +1 @@
-20.11
+20.17

README.md

@@ -80,6 +80,8 @@ Options:
   -o, --outputFolder    output folder (default: client_generated)
   -g, --generateClient  generate client (default: true)
   --no-generateClient   no client generation
+  -i, --surrealImage    SurrealDB docker image (default: surrealdb/surrealdb:latest)
+
   -h, --help            display help for command
 ```
 
@@ -100,7 +102,9 @@ Example:
   "db": "my_database",
   "outputFolder": "./out",
   "generateClient": true,
-  "lib": "surrealdb"
+  "lib": "surrealdb",
+  "surrealImage": "surrealdb/surrealdb:latest"
+
 }
 ```
 
@@ -119,6 +123,14 @@ or you can specify the path in the config file:
 }
 ```
 
+using a schema file utilises a temporary in-memory SurrealDB instance to generate the zod schemas; this instance runs in a docker container.
+If you want to use a different image, you can specify it in the config file:
+```json
+{
+  "surrealImage": "surrealdb/surrealdb:latest"
+}
+```
+
 ## Connecting to an Existing SurrealDB Instance
 
 To connect to an existing SurrealDB instance, simply omit the `-f` option, or omit the `schemaFile` in the config file.