@aidc-toolkit/dev 0.9.2 → 0.9.3

package/README.md

@@ -6,7 +6,7 @@ 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
+configuration. This is supported by the [`tsconfig.json` file](tsconfig.json) in this package. Core changes should be managed
 in that file, with other packages declaring their own `tsconfig.json` as follows:
 
 ```json
@@ -15,32 +15,36 @@ in that file, with other packages declaring their own `tsconfig.json` as follows
 }
 ```
 
+Options specific to the package may override or supplement core options if required.
+
 ## 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
+file](src/eslint.config.template.ts) in this package. Core changes should be managed in that file, with other packages
 declaring their own `eslint.config.js` file as follows:
 
+```javascript
+import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";
+
+export default esLintConfigAIDCToolkit;
+```
+
+Rules specific to the package may override or supplement core rules if required. If so, the `eslint.config.js` file
+should be declared as follows:
+
 ```javascript
 import tseslint from "typescript-eslint";
-import stylistic from "@stylistic/eslint-plugin";
-import jsdoc from "eslint-plugin-jsdoc";
-import esLintConfigLove from "eslint-config-love";
 import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";
+// Additional imports here as required.
+// ...
 
 export default tseslint.config(
-    ...tseslint.configs.strictTypeChecked,
-    stylistic.configs["recommended-flat"],
-    jsdoc.configs["flat/recommended-typescript"],
-    esLintConfigLove,
-    esLintConfigAIDCToolkit
+    ...esLintConfigAIDCToolkit,
+    // Additional rules here as required.
+    // ...
 );
 ```
 
-The ESLint configuration requires the installation of the following development dependencies:
-
-- @stylistic/eslint-plugin
-- eslint-config-love
-- eslint-plugin-jsdoc
-- typescript-eslint
+ESLint requires the installation of the `eslint` package as a development dependency. Other development dependencies may
+be required if overriding or supplementing the core rules.

package/eslint.config.js

@@ -1,13 +1,3 @@
-import tseslint from "typescript-eslint";
-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(
-    ...tseslint.configs.strictTypeChecked,
-    stylistic.configs["recommended-flat"],
-    jsdoc.configs["flat/recommended-typescript"],
-    esLintConfigLove,
-    ...esLintConfigAIDCToolkit
-);
+export default esLintConfigAIDCToolkit;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/dev",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "Shared development artefacts for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -20,16 +20,23 @@
   },
   "scripts": {
     "eslint": "eslint .",
-    "build": "tsup src/index.ts --format cjs,esm --dts"
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build-doc": "npm run build"
   },
   "devDependencies": {
+    "eslint": "^9.14.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "dependencies": {
     "@eslint/js": "^9.14.0",
     "@stylistic/eslint-plugin": "^2.10.1",
     "eslint-config-love": "^98.0.2",
     "eslint-plugin-jsdoc": "^50.5.0",
-    "ts-node": "^10.9.2",
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
     "typescript-eslint": "^8.14.0"
   }
 }

package/src/eslint.config.template.ts

@@ -1,11 +1,18 @@
 import js from "@eslint/js";
-import type { ConfigWithExtends } from "typescript-eslint";
+import stylistic from "@stylistic/eslint-plugin";
+import esLintConfigLove from "eslint-config-love";
+import jsdoc from "eslint-plugin-jsdoc";
+import tseslint from "typescript-eslint";
 
-export const esLintConfigAIDCToolkit: ConfigWithExtends[] = [
+export const esLintConfigAIDCToolkit = tseslint.config(
     {
         ignores: ["eslint.config.js", "dist"]
     },
     js.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    stylistic.configs["recommended-flat"],
+    jsdoc.configs["flat/recommended-typescript"],
+    esLintConfigLove,
     {
         languageOptions: {
             parserOptions: {
@@ -98,4 +105,4 @@ export const esLintConfigAIDCToolkit: ConfigWithExtends[] = [
             "@typescript-eslint/dot-notation": "off"
         }
     }
-];
+);