feat: working draft

.czrc

@@ -0,0 +1,3 @@
+{
+    "path": "./node_modules/cz-conventional-changelog"
+}

.eslintrc

@@ -5,13 +5,12 @@
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended" // uses the recommended rules from the @typescript-eslint/eslint-plugin
   ],
+  "plugins": ["eslint-plugin-unicorn/expiring-todo-comments"],
   "parserOptions": {
     "ecmaVersion": 2018,
     "sourceType": "module"
   },
-  "ignorePatterns": [
-    "dist"
-  ],
+  "ignorePatterns": ["dist"],
   "rules": {
     "quotes": ["warn", "single"],
     "indent": ["warn", 2, { "SwitchCase": 1 }],
@@ -33,6 +32,7 @@
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/semi": ["warn"],
-    "@typescript-eslint/member-delimiter-style": ["warn"]
+    "@typescript-eslint/member-delimiter-style": "warn",
+    "eslint-plugin-unicorn/expiring-todo-comments": "off"
   }
 }

.github/workflows/build.yml

@@ -9,7 +9,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # the Node.js versions to build on
         node-version: [18.x, 20.x]
 
     steps:

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+on:
+  push:
+    branches:
+      - latest
+  repository_dispatch:
+    types: [semantic-release]
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.npmignore

@@ -127,8 +127,10 @@ web_modules/
 .vscode-test
 
 # yarn v2
-
 .yarn/cache
 .yarn/unplugged
 .yarn/build-state.yml
 .pnp.*
+
+# dev-only local executables
+bin/

.releaserc

@@ -0,0 +1,14 @@
+{
+    "branches": ["latest"],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/npm",
+        [
+            "@semantic-release/github",
+            {
+                "assets": ["dist/**"]
+            }
+        ]
+    ]
+}

.vscode/settings.json

@@ -7,5 +7,7 @@
   "editor.rulers": [100],
   "files.autoSave": "onFocusChange",
   "files.eol": "\n",
-  "vs-code-prettier-eslint.prettierLast": false
+  "vs-code-prettier-eslint.prettierLast": false,
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "sarif-viewer.connectToGithubCodeScanning": "off"
 }

bin/schema2ts.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+CWD=$(dirname $(readlink -f "$0"))
+
+rm -f "$CWD"/*.js
+tsc -p "$CWD"
+chmod 744 "$CWD/schema2ts.js"
+node "$CWD/schema2ts.js"

bin/schema2ts.ts

@@ -0,0 +1,83 @@
+import { join } from 'path';
+import { exit, stdout } from 'process';
+import { writeFile, readFile } from 'fs/promises';
+import { compile, Options } from 'json-schema-to-typescript';
+
+import { schema } from '../config.schema.json';
+
+const configInterfaceName = 'ShortcutsButtonsUserConfig';
+const moduleName = 'SchemaForm2Ts';
+const outputRootPath = '/src/config.ts';
+const outputRelativePath = join(__dirname, '../', outputRootPath);
+const prettierrcPath = join(__dirname, '../.prettierrc');
+
+async function main(): Promise<void> {
+  const config = await compile(
+    schema as never,
+    configInterfaceName,
+    await getCompileOptions(),
+  );
+
+  await writeConfig(config);
+
+  stdout.write(
+    `🚀 ${moduleName}: Plugin configuration interface generated at ${outputRootPath}\n\n`,
+  );
+
+  exit(0);
+}
+
+async function getCompileOptions(): Promise<Partial<Options>> {
+  let style: Options['style'];
+  try {
+    const prettierConfig = await readFile(prettierrcPath);
+    style = await JSON.parse(prettierConfig.toString());
+  } catch (e) {
+    throw new SchemaForm2TsError(
+      `Unable to read Prettier configuration from ${prettierrcPath}`,
+      e,
+    );
+  }
+
+  return {
+    additionalProperties: false,
+    bannerComment:
+      '/**\n* DO NOT EDIT MANUALLY.\n' +
+      '* This file was automatically generated from `/config.schema.json`.\n' +
+      '* Update the source schema file and run `schema2ts` to regenerate this file.\n*/',
+    ignoreMinAndMaxItems: true,
+    strictIndexSignatures: true,
+    style,
+  };
+}
+
+async function writeConfig(config: string): Promise<void> {
+  try {
+    return await writeFile(outputRelativePath, config, {
+      flag: 'w+',
+      mode: 0o644,
+    });
+  } catch (e) {
+    throw new SchemaForm2TsError(
+      `Unable to write output at ${outputRootPath}`,
+      e,
+    );
+  }
+}
+
+@frozen
+class SchemaForm2TsError extends Error {
+  constructor(message: string, exception: unknown) {
+    require('source-map-support').install();
+    super(`${message}\n\n   ${exception}\n`);
+    Error.captureStackTrace(this, this.constructor);
+    this.name = `💥 ${moduleName}`;
+  }
+}
+
+function frozen(constructor: Function) {
+  Object.freeze(constructor);
+  Object.freeze(constructor.prototype);
+}
+
+(async (): Promise<void> => main()).call(null);

bin/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "inlineSourceMap": true,
+    "noEmitOnError": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["**/*.spec.ts"]
+}