@aidc-toolkit/dev 0.9.7-beta → 0.9.9-beta

package/LICENSE

@@ -172,30 +172,3 @@
       defend, and hold each Contributor harmless for any liability
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright © 2024 Dolphin Data Development Ltd.
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

package/README.md

@@ -1,5 +1,20 @@
 # Development Package
 
+**Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit contributors**
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
+License. You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+## Overview
+
+⚠️ **This software is in beta**, with production release is scheduled for 2024Q4. To follow the status of that and other
+projects, go to the AIDC Toolkit [projects](https://github.com/orgs/aidc-toolkit/projects) page.
+
 The AIDC Toolkit `dev` package contains development artefacts only; it is not intended to be used as anything other than
 a development dependency.
 
@@ -20,8 +35,8 @@ Options specific to the package may override or supplement core options if requi
 ## 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. Core changes should be managed in that file, with other packages
+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. Core changes should be managed in that file, with other packages
 declaring their own `eslint.config.js` file as follows:
 
 ```javascript

package/config/release.json

@@ -2,24 +2,24 @@
   "organization": "aidc-toolkit",
   "repositories": {
     "dev": {
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     },
     "core": {
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     },
     "utility": {
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     },
     "gs1": {
       "name": "gs1",
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     },
     "demo": {
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     },
     "aidc-toolkit.github.io": {
       "directory": "doc",
-      "version": "0.9.7-beta"
+      "version": "0.9.9-beta"
     }
   }
 }

package/dist/index.cjs

@@ -28,13 +28,13 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   esLintConfigAIDCToolkit: () => esLintConfigAIDCToolkit
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
-// src/eslint.config.template.ts
+// src/eslint-config-template.ts
 var import_js = __toESM(require("@eslint/js"), 1);
 var import_eslint_plugin = __toESM(require("@stylistic/eslint-plugin"), 1);
 var import_eslint_config_love = __toESM(require("eslint-config-love"), 1);
@@ -60,6 +60,7 @@ var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
     },
     rules: {
       "complexity": "off",
+      "max-lines": "off",
       "no-dupe-class-members": "off",
       "no-redeclare": "off",
       "no-unused-vars": "off",
@@ -133,6 +134,7 @@ var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
       "test/**/*"
     ],
     rules: {
+      "max-nested-callbacks": "off",
       "jsdoc/require-jsdoc": "off",
       "@typescript-eslint/dot-notation": "off",
       "@typescript-eslint/no-unsafe-type-assertion": "off"
@@ -143,3 +145,19 @@ var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
 0 && (module.exports = {
   esLintConfigAIDCToolkit
 });
+/*!
+ * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

package/dist/index.js

@@ -1,4 +1,4 @@
-// src/eslint.config.template.ts
+// src/eslint-config-template.ts
 import js from "@eslint/js";
 import stylistic from "@stylistic/eslint-plugin";
 import esLintConfigLove from "eslint-config-love";
@@ -24,6 +24,7 @@ var esLintConfigAIDCToolkit = tseslint.config(
     },
     rules: {
       "complexity": "off",
+      "max-lines": "off",
       "no-dupe-class-members": "off",
       "no-redeclare": "off",
       "no-unused-vars": "off",
@@ -97,6 +98,7 @@ var esLintConfigAIDCToolkit = tseslint.config(
       "test/**/*"
     ],
     rules: {
+      "max-nested-callbacks": "off",
       "jsdoc/require-jsdoc": "off",
       "@typescript-eslint/dot-notation": "off",
       "@typescript-eslint/no-unsafe-type-assertion": "off"
@@ -106,3 +108,19 @@ var esLintConfigAIDCToolkit = tseslint.config(
 export {
   esLintConfigAIDCToolkit
 };
+/*!
+ * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/dev",
-  "version": "0.9.7-beta",
+  "version": "0.9.9-beta",
   "description": "Shared development artefacts for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -22,26 +22,26 @@
     "copy-workflows": "copy-files-from-to --config copy-workflows.json",
     "lint": "eslint .",
     "release": "tsx src/release.ts",
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "build-doc": "npm run build"
+    "build-dist": "tsup src/index.ts --format cjs,esm --dts",
+    "build-doc": "npm run build-dist"
   },
   "devDependencies": {
     "copy-files-from-to": "^3.12.0",
-    "eslint": "^9.16.0",
+    "eslint": "^9.17.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2"
   },
   "dependencies": {
-    "@eslint/js": "^9.16.0",
+    "@eslint/js": "^9.17.0",
     "@octokit/types": "^13.6.2",
-    "@rollup/rollup-linux-x64-gnu": "^4.28.1",
-    "@stylistic/eslint-plugin": "^2.12.0",
-    "eslint-config-love": "^110.0.0",
-    "eslint-plugin-jsdoc": "^50.6.0",
-    "octokit": "^4.0.2",
-    "typescript-eslint": "^8.17.0",
+    "@rollup/rollup-linux-x64-gnu": "^4.29.1",
+    "@stylistic/eslint-plugin": "^2.12.1",
+    "eslint-config-love": "^114.0.0",
+    "eslint-plugin-jsdoc": "^50.6.1",
+    "octokit": "^4.0.3",
+    "typescript-eslint": "^8.19.0",
     "yaml": "^2.6.1"
   }
 }

package/src/{eslint.config.template.ts → eslint-config-template.ts}

@@ -26,6 +26,7 @@ export const esLintConfigAIDCToolkit = tseslint.config(
 
         rules: {
             "complexity": "off",
+            "max-lines": "off",
             "no-dupe-class-members": "off",
             "no-redeclare": "off",
             "no-unused-vars": "off",
@@ -102,6 +103,7 @@ export const esLintConfigAIDCToolkit = tseslint.config(
             "test/**/*"
         ],
         rules: {
+            "max-nested-callbacks": "off",
             "jsdoc/require-jsdoc": "off",
             "@typescript-eslint/dot-notation": "off",
             "@typescript-eslint/no-unsafe-type-assertion": "off"

package/src/index.ts

@@ -1 +1,17 @@
-export * from "./eslint.config.template.js";
+/*!
+ * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from "./eslint-config-template.js";

package/src/release.ts

@@ -1,6 +1,7 @@
 import { spawnSync } from "child_process";
 import * as fs from "fs";
 import * as path from "node:path";
+import * as util from "node:util";
 import { Octokit } from "octokit";
 import { parse as yamlParse } from "yaml";
 
@@ -16,6 +17,11 @@ interface Configuration {
      */
     organization: string;
 
+    /**
+     * If true, the fact that the repository is uncommitted is ignored. For development and testing purposes only.
+     */
+    ignoreUncommitted?: boolean;
+
     /**
      * Repositories.
      */
@@ -30,11 +36,6 @@ interface Configuration {
          */
         version: string;
     }>;
-
-    /**
-     * If true, the fact that the repository is uncommitted is ignored. For development and testing purposes only.
-     */
-    ignoreUncommitted?: boolean;
 }
 
 /**
@@ -208,6 +209,7 @@ async function release(): Promise<void> {
     });
 
     let allSkipped = true;
+    let firstRepository = true;
 
     for (const name of Object.keys(configuration.repositories)) {
         const repository = configuration.repositories[name];
@@ -289,8 +291,15 @@ async function release(): Promise<void> {
                     for (const dependency of linkDependencies) {
                         run(false, "npm", "link", dependency);
                     }
-                } else if (!allSkipped) {
-                    throw new Error(`Repository ${name} is supposed to be skipped but at least one prior repository has been updated`);
+                } else {
+                    if (!allSkipped) {
+                        throw new Error(`Repository ${name} is supposed to be skipped but at least one prior repository has been updated`);
+                    }
+
+                    // First repository is excluded as it hosts development artefacts only, including the configuration file for this process.
+                    if (!firstRepository && run(true, "git", "tag", "--points-at", "HEAD", tag).length === 0) {
+                        throw new Error(`Repository ${name} has at least one commit since version ${repository.version}`);
+                    }
                 }
                 break;
 
@@ -321,18 +330,16 @@ async function release(): Promise<void> {
             let hasReleaseWorkflow = false;
 
             if (fs.existsSync(workflowsPath)) {
-                for (const workflowFile of fs.readdirSync(workflowsPath)) {
-                    if (workflowFile.endsWith(".yml")) {
-                        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Workflow configuration format is known.
-                        const workflowOn = (yamlParse(fs.readFileSync(path.resolve(workflowsPath, workflowFile)).toString()) as WorkflowConfiguration).on;
+                for (const workflowFile of fs.readdirSync(workflowsPath).filter(workflowFile => workflowFile.endsWith(".yml"))) {
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Workflow configuration format is known.
+                    const workflowOn = (yamlParse(fs.readFileSync(path.resolve(workflowsPath, workflowFile)).toString()) as WorkflowConfiguration).on;
 
-                        if (workflowOn.push !== undefined && (workflowOn.push.branches === undefined || workflowOn.push.branches.includes("main"))) {
-                            hasPushWorkflow = true;
-                        }
+                    if (workflowOn.push !== undefined && (workflowOn.push.branches === undefined || workflowOn.push.branches.includes("main"))) {
+                        hasPushWorkflow = true;
+                    }
 
-                        if (workflowOn.release !== undefined && (workflowOn.release.types === undefined || workflowOn.release.types.includes("published"))) {
-                            hasReleaseWorkflow = true;
-                        }
+                    if (workflowOn.release !== undefined && (workflowOn.release.types === undefined || workflowOn.release.types.includes("published"))) {
+                        hasReleaseWorkflow = true;
                     }
                 }
             }
@@ -348,9 +355,7 @@ async function release(): Promise<void> {
                 let workflowRunID = -1;
 
                 do {
-                    await new Promise<void>((resolve) => {
-                        setTimeout(resolve, 2000);
-                    });
+                    await util.promisify(setTimeout)(2000);
 
                     const response = await octokit.rest.actions.listWorkflowRunsForRepo({
                         ...octokitParameterBase,
@@ -443,6 +448,8 @@ async function release(): Promise<void> {
         }
 
         saveState();
+
+        firstRepository = false;
     }
 
     // All repositories released.