Initial project structure

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+
+jobs:
+  # test:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: actions/setup-node@v3
+  #       with:
+  #         node-version: 22
+  #     - run: npm ci
+  #     - run: npm test
+
+  publish-npm:
+    # needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,3 @@
+*.tsbuildinfo
+node_modules
+lib

.npmignore

@@ -0,0 +1,9 @@
+.github
+*.tsbuildinfo
+.versionrc.json
+.vscode
+CODEOWNERS
+libtest
+src
+test
+tsconfig.json

.prettierrc.yml

@@ -0,0 +1 @@
+semi: false

.versionrc.json

@@ -0,0 +1,3 @@
+{
+  "releaseCommitMessageFormat": "build(release): {{currentTag}}"
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "watch",
+      "type": "shell",
+      "command": "npm run watch",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

AUTHORS

@@ -0,0 +1 @@
+Lukas Obermann <lukas.obermann@icloud.com>

CODEOWNERS

@@ -0,0 +1 @@
+* @elyukai

README.md

@@ -0,0 +1 @@
+# Optolith Entity Descriptions

package.json

@@ -4,6 +4,9 @@
   "description": "An interface for generating descriptions for The Dark Eye entities.",
   "main": "lib/index.js",
   "scripts": {
+    "build": "tsc -b",
+    "watch": "tsc -b -w",
+    "release": "standard-version",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -15,5 +18,10 @@
   "bugs": {
     "url": "https://github.com/Optolith/entity-descriptions/issues"
   },
-  "homepage": "https://github.com/Optolith/entity-descriptions#readme"
+  "homepage": "https://github.com/Optolith/entity-descriptions#readme",
+  "dependencies": {
+    "optolith-database-schema": "^0.17.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^5.6.2"
+  }
 }

src/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "NodeNext",
+    "noEmitHelpers": true,
+    "noErrorTruncation": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "outDir": "../lib",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ESNext",
+    "useUnknownInCatchVariables": true,
+  }
+}

tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "files": [],
+  "references": [
+    { "path": "src" },
+  ],
+}