@aidc-toolkit/dev 0.0.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,32 @@
+# 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://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm ci
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.idea/dev.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,7 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="UpdateDependencyToLatestVersion" enabled="true" level="WARNING" enabled_by_default="true" editorAttributes="WARNING_ATTRIBUTES" />
+  </profile>
+</component>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="openjdk-21" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/dev.iml" filepath="$PROJECT_DIR$/.idea/dev.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/runConfigurations/build.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="build" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="build" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/eslint.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="eslint" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="eslint" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,49 @@
+# Development Package
+
+The AIDC Toolkit `dev` package contains development artefacts only; it is not intended to be used as anything other than
+a development dependency.
+
+## TypeScript Configuration
+
+All AIDC Toolkit packages are expected to be built the same way, which implies that they all have the same TypeScript
+configuration. This is supported by the [`tsconfig.json` file](tsconfig.json) in this package. All changes should be managed
+in that file, with other packages declaring their own `tsconfig.json` as follows:
+
+```json
+{
+  "extends": "@aidc-toolkit/dev/tsconfig.json"
+}
+```
+
+## ESLint Configuration
+
+All AIDC Toolkit packages are expected to follow a common coding style (enforced by [ESLint](https://eslint.org/)),
+which implies that they all have the same ESLint configuration. This is supported by the [`eslint.config.template.ts`
+file](src/eslint.config.template.ts) in this package. All changes should be managed in that file, with other packages
+declaring their own `eslint.config.js` file as follows:
+
+```javascript
+import tseslint from "typescript-eslint";
+import js from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import jsdoc from "eslint-plugin-jsdoc";
+import esLintConfigLove from "eslint-config-love";
+import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";
+
+export default tseslint.config(
+    js.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    stylistic.configs["recommended-flat"],
+    jsdoc.configs["flat/recommended-typescript"],
+    esLintConfigLove,
+    esLintConfigAIDCToolkit
+);
+```
+
+The ESLint configuration requires the installation of the following development dependencies:
+
+- @eslint/js
+- @stylistic/eslint-plugin
+- eslint-config-love
+- eslint-plugin-jsdoc
+- typescript-eslint

package/eslint.config.js

@@ -0,0 +1,15 @@
+import tseslint from "typescript-eslint"
+import js from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import jsdoc from "eslint-plugin-jsdoc";
+import esLintConfigLove from "eslint-config-love";
+import { esLintConfigAIDCToolkit } from "./dist/index.js";
+
+export default tseslint.config(
+    js.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    stylistic.configs["recommended-flat"],
+    jsdoc.configs["flat/recommended-typescript"],
+    esLintConfigLove,
+    esLintConfigAIDCToolkit
+);

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@aidc-toolkit/dev",
+  "version": "0.0.1",
+  "description": "Shared development artefacts for AIDC Toolkit",
+  "type": "module",
+  "main": "dist/index.js",
+  "homepage": "https://github.com/aidc-toolkit",
+  "repository": "github:aidc-toolkit/dev",
+  "bugs": {
+    "url": "https://github.com/aidc-toolkit/dev/issues"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Kevin Dean",
+    "email": "Kevin.Dean@datadevelopment.com",
+    "url": "https://www.linkedin.com/in/kdean"
+  },
+  "scripts": {
+    "eslint": "eslint .",
+    "build": "tsup src/index.ts --format cjs,esm --dts"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.10.0",
+    "@stylistic/eslint-plugin": "^2.7.2",
+    "eslint-config-love": "^64.0.0",
+    "eslint-plugin-jsdoc": "^50.2.2",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.4.0"
+  }
+}

package/src/eslint.config.template.ts

@@ -0,0 +1,64 @@
+import type { ConfigWithExtends } from "typescript-eslint";
+
+export const esLintConfigAIDCToolkit: ConfigWithExtends = {
+    languageOptions: {
+        parserOptions: {
+            projectService: true
+        }
+    },
+
+    linterOptions: {
+        reportUnusedDisableDirectives: "error"
+    },
+
+    rules: {
+        "@typescript-eslint/class-literal-property-style": "off",
+        "@typescript-eslint/class-methods-use-this": "off",
+        "@typescript-eslint/init-declarations": "off",
+        "@typescript-eslint/max-params": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-empty-object-type": "off",
+        "@typescript-eslint/no-unnecessary-type-parameters": "off",
+        "@typescript-eslint/unbound-method": ["error", {
+            ignoreStatic: true
+        }],
+
+        "@stylistic/array-bracket-newline": ["error", "consistent"],
+        "@stylistic/brace-style": ["error", "1tbs", {
+            allowSingleLine: false
+        }],
+        "@stylistic/comma-dangle": ["error", "never"],
+        "@stylistic/indent": ["error", 4],
+        "@stylistic/member-delimiter-style": ["error", {
+            multiline: {
+                delimiter: "semi",
+                requireLast: true
+            },
+            singleline: {
+                delimiter: "semi"
+            }
+        }],
+        "@stylistic/operator-linebreak": ["error", "after"],
+        "@stylistic/quotes": ["error", "double"],
+        "@stylistic/semi": ["error", "always"],
+        "@stylistic/object-curly-newline": ["error", {
+            ObjectExpression: {
+                multiline: true,
+                minProperties: 1
+            },
+            ObjectPattern: {
+                multiline: true,
+                minProperties: 1
+            }
+        }],
+        "@stylistic/object-property-newline": "error",
+
+        "jsdoc/require-returns": ["warn", {
+            checkGetters: false
+        }],
+        "jsdoc/tag-lines": ["warn", "any", {
+            count: 1,
+            startLines: 1
+        }]
+    }
+};

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./eslint.config.template.js";

package/tsconfig.json

@@ -0,0 +1,26 @@
+// https://aka.ms/tsconfig
+{
+  "compilerOptions": {
+    // Type checking.
+    "strict": true,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+
+    // Modules.
+    "module": "nodenext",
+    "resolveJsonModule": true,
+
+    // Interop constraints.
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+
+    // Language and environment.
+    "target": "es2020",
+    "useDefineForClassFields": true,
+
+    // Completeness.
+    "skipLibCheck": true
+  }
+}

package/typedoc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "sourceLinkExternal": true,
+  "groupOrder": [
+    "Enumerations",
+    "Type Aliases",
+    "Interfaces",
+    "Classes",
+    "Variables",
+    "Enumeration Members",
+    "Properties",
+    "Constructors",
+    "Accessors",
+    "Methods",
+    "*"
+  ],
+  "sort": []
+}