@aidc-toolkit/dev 0.9.15-beta → 0.9.17-beta

package/src/publish.ts

@@ -0,0 +1,273 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import configurationJSON from "../config/publish.json";
+import secureConfigurationJSON from "../config/publish.secure.json";
+import { logger, run } from "./utility";
+
+/**
+ * Repository.
+ */
+export interface Repository {
+    /**
+     * Directory in which repository resides, if different from repository name.
+     */
+    directory?: string;
+
+    /**
+     * Dependency type, dictating how it is published.
+     */
+    dependencyType: string;
+
+    /**
+     * Files excluded from consideration when checking for changes.
+     */
+    excludeFiles?: string[];
+
+    /**
+     * Date/time the package was last published internally in ISO format.
+     */
+    lastInternalPublished?: string;
+
+    /**
+     * Date/time the package was last published externally in ISO format.
+     */
+    lastExternalPublished?: string;
+
+    /**
+     * Last external published version.
+     */
+    lastExternalVersion?: string;
+
+    /**
+     * Current step in external publication; used to resume after failure recovery.
+     */
+    publishExternalStep?: string | undefined;
+}
+
+/**
+ * Configuration layout of publish.json.
+ */
+export interface Configuration {
+    /**
+     * Organization that owns the repositories.
+     */
+    organization: string;
+
+    /**
+     * Repositories.
+     */
+    repositories: Record<string, Repository>;
+}
+
+/**
+ * Configuration layout of publish.secure.json.
+ */
+interface SecureConfiguration {
+    token: string;
+}
+
+/**
+ * Configuration layout of package.json (relevant attributes only).
+ */
+export interface PackageConfiguration {
+    /**
+     * Name.
+     */
+    name: string;
+
+    /**
+     * Version.
+     */
+    version: string;
+
+    /**
+     * Development dependencies.
+     */
+    devDependencies?: Record<string, string>;
+
+    /**
+     * Dependencies.
+     */
+    dependencies?: Record<string, string>;
+}
+
+export const configuration: Configuration = configurationJSON;
+export const secureConfiguration: SecureConfiguration = secureConfigurationJSON;
+
+const atOrganization = `@${configuration.organization}`;
+
+/**
+ * Get the organization repository name or a dependency if it belongs to the organization or null if not.
+ *
+ * @param dependency
+ * Dependency.
+ *
+ * @returns
+ * Organization repository name or null.
+ */
+export function organizationRepository(dependency: string): string | null {
+    const [dependencyAtOrganization, dependencyRepositoryName] = dependency.split("/");
+
+    return dependencyAtOrganization === atOrganization ? dependencyRepositoryName : null;
+}
+
+/**
+ * Determine if there have been any changes to a repository.
+ *
+ * @param repository
+ * Repository configuration.
+ *
+ * @param external
+ * False if comparing to the last internal published date/time, true if comparing to the last external published
+ * date/time.
+ *
+ * @returns
+ * True if there is no last published date/time or if there have been any changes since then.
+ */
+export function anyChanges(repository: Repository, external: boolean): boolean {
+    let anyChanges: boolean;
+
+    const lastPublishedString = !external ? repository.lastInternalPublished : repository.lastExternalPublished;
+
+    const changedFilesSet = new Set<string>();
+
+    if (lastPublishedString !== undefined) {
+        for (const line of run(true, "git", "log", `--since="${lastPublishedString}"`, "--name-status", "--pretty=oneline")) {
+            // Header starts with 40-character SHA.
+            if (!/^[0-9a-f]{40} /.test(line)) {
+                const [status, file] = line.split("\t");
+
+                // Ignore deleted files; anything that depends on a deleted file will have been modified.
+                if (status !== "D") {
+                    logger.debug(`+File: ${file}`);
+
+                    changedFilesSet.add(file);
+                }
+            } else {
+                logger.debug(`Commit SHA ${line.substring(0, 40)}`);
+            }
+        }
+    }
+
+    if (lastPublishedString !== undefined || external) {
+        const output = run(true, "git", "status", "--porcelain");
+
+        if (output.length !== 0) {
+            if (external) {
+                throw new Error("Repository has uncommitted changes");
+            }
+
+            logger.debug("Uncommitted");
+
+            for (const line of output) {
+                // Line is two-character status, space, and detail.
+                const status = line.substring(0, 2);
+                const detail = line.substring(3);
+
+                // Ignore deleted files; anything that depends on a deleted file will have been modified.
+                if (status !== "D ") {
+                    let file: string;
+
+                    if (status.startsWith("R")) {
+                        // File has been renamed; get old and new file names.
+                        const [oldFile, newFile] = detail.split(" -> ");
+
+                        logger.debug(`-File: ${oldFile}`);
+
+                        changedFilesSet.delete(oldFile);
+
+                        file = newFile;
+                    } else {
+                        file = detail;
+                    }
+
+                    logger.debug(`+File: ${file}`);
+
+                    changedFilesSet.add(file);
+                }
+            }
+        }
+    }
+
+    if (lastPublishedString !== undefined) {
+        logger.debug("Excluded");
+
+        const hiddenFiles = [];
+
+        // Get list of hidden files and directories.
+        for (const changedFile of changedFilesSet) {
+            if (changedFile.startsWith(".") || changedFile.includes("/.")) {
+                hiddenFiles.push(changedFile);
+            }
+        }
+
+        // Exclude hidden files and directories.
+        for (const hiddenFile of hiddenFiles) {
+            logger.debug(`-File: ${hiddenFile}`);
+
+            changedFilesSet.delete(hiddenFile);
+        }
+
+        if (repository.excludeFiles !== undefined) {
+            for (const excludeFile of repository.excludeFiles) {
+                if (changedFilesSet.delete(excludeFile)) {
+                    logger.debug(`-File: ${excludeFile}`);
+                }
+            }
+        }
+
+        logger.info("Changed");
+
+        const lastPublished = new Date(lastPublishedString);
+
+        anyChanges = false;
+
+        for (const changedFile of changedFilesSet) {
+            if (fs.lstatSync(changedFile).mtime > lastPublished) {
+                logger.info(`File: ${changedFile}`);
+
+                anyChanges = true;
+            }
+        }
+    } else {
+        // No last published, so there must have been changes.
+        anyChanges = true;
+    }
+
+    if (!anyChanges) {
+        logger.debug("No changes");
+    }
+
+    return anyChanges;
+}
+
+// Configuration may be written from any directory so full path is required.
+const configurationPath = path.resolve("config/publish.json");
+
+/**
+ * Save the current configuration.
+ */
+export function saveConfiguration(): void {
+    fs.writeFileSync(configurationPath, `${JSON.stringify(configuration, null, 2)}\n`);
+}
+
+/**
+ * Publish all repositories.
+ *
+ * @param callback
+ * Callback taking the name and properties of the repository to publish.
+ */
+export async function publishRepositories(callback: (name: string, repository: Repository) => void | Promise<void>): Promise<void> {
+    logger.settings.minLevel = 2;
+
+    for (const [name, repository] of Object.entries(configuration.repositories)) {
+        logger.info(`Repository ${name}...`);
+
+        // All repositories are expected to be children of the parent of this repository.
+        process.chdir(`../${repository.directory ?? name}`);
+
+        await callback(name, repository);
+
+        saveConfiguration();
+    }
+}

package/src/{command-util.ts → utility.ts}

@@ -1,4 +1,19 @@
 import { spawnSync } from "child_process";
+import { Logger } from "tslog";
+
+/**
+ * Log level.
+ */
+enum LogLevel {
+    Silly, Trace, Debug, Info, Warn, Error, Fatal
+}
+
+/**
+ * Logger with a default minimum level of Info.
+ */
+export const logger = new Logger({
+    minLevel: LogLevel.Info
+});
 
 /**
  * Run a command and optionally capture its output.
@@ -16,6 +31,8 @@ import { spawnSync } from "child_process";
  * Output if captured or empty array if not.
  */
 export function run(captureOutput: boolean, command: string, ...args: string[]): string[] {
+    logger.debug(`Running command "${command}" with arguments ${JSON.stringify(args)}.`);
+
     const spawnResult = spawnSync(command, args, {
         stdio: ["inherit", captureOutput ? "pipe" : "inherit", "inherit"]
     });
@@ -32,5 +49,11 @@ export function run(captureOutput: boolean, command: string, ...args: string[]):
         throw new Error(`Failed with status ${spawnResult.status}`);
     }
 
-    return captureOutput ? spawnResult.stdout.toString().split("\n").slice(0, -1) : [];
+    const output = captureOutput ? spawnResult.stdout.toString().split("\n").slice(0, -1) : [];
+
+    if (captureOutput) {
+        logger.debug(`Output is ${JSON.stringify(output)}.`);
+    }
+
+    return output;
 }

package/tsconfig-build-dev-local.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig-build-local.json",
+
+  "compilerOptions": {
+    // Emit.
+    "declarationMap": true,
+    "sourceMap": true
+  }
+}

package/tsconfig-build-dev.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig-build.json",
+
+  "compilerOptions": {
+    // Emit.
+    "declarationMap": true,
+    "sourceMap": true
+  }
+}

package/tsconfig-build-local.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+
+  "files": [
+    "./src/index.ts"
+  ],
+
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}

package/{tsconfig-declaration.json → tsconfig-build.json}

@@ -6,9 +6,6 @@
   ],
 
   "compilerOptions": {
-    "outDir": "../../../dist",
-    "emitDeclarationOnly": true,
-    "declaration": true,
-    "declarationMap": true
+    "outDir": "../../../dist"
   }
 }

package/tsconfig.json

@@ -9,16 +9,19 @@
     "noPropertyAccessFromIndexSignature": true,
 
     // Modules.
-    "module": "NodeNext",
+    "module": "ES2022",
+    "moduleResolution": "bundler",
     "resolveJsonModule": true,
 
+    // Emit.
+    "declaration": true,
+
     // Interop constraints.
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
 
     // Language and environment.
-    "target": "ESNext",
-    "useDefineForClassFields": true,
+    "target": "ES2022",
 
     // Completeness.
     "skipLibCheck": true

package/bin/publish-dev

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-import { publishDev } from "@aidc-toolkit/dev";
-
-try {
-    publishDev();
-} catch (e) {
-    console.error(e);
-}

package/bin/publish-dev-local

@@ -1,8 +0,0 @@
-#!/usr/bin/env tsx
-import { publishDev } from "../src/publish-dev.js";
-
-try {
-    publishDev();
-} catch (e) {
-    console.error(e);
-}

package/config/release.json

@@ -1,27 +0,0 @@
-{
-  "organization": "aidc-toolkit",
-  "repositories": {
-    "dev": {
-      "version": "0.9.15-beta"
-    },
-    "core": {
-      "version": "0.9.15-beta"
-    },
-    "utility": {
-      "version": "0.9.15-beta"
-    },
-    "gs1": {
-      "version": "0.9.15-beta"
-    },
-    "demo": {
-      "version": "0.9.15-beta"
-    },
-    "app-extension": {
-      "version": "0.9.15-beta"
-    },
-    "aidc-toolkit.github.io": {
-      "directory": "doc",
-      "version": "0.9.15-beta"
-    }
-  }
-}

package/dist/command-util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"command-util.d.ts","sourceRoot":"","sources":["../src/command-util.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAkBxF"}

package/dist/index.cjs

@@ -1,225 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  esLintConfigAIDCToolkit: () => esLintConfigAIDCToolkit,
-  publishDev: () => publishDev
-});
-module.exports = __toCommonJS(index_exports);
-
-// 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);
-var import_eslint_plugin_jsdoc = __toESM(require("eslint-plugin-jsdoc"), 1);
-var import_typescript_eslint = __toESM(require("typescript-eslint"), 1);
-var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
-  {
-    ignores: ["dist"]
-  },
-  import_js.default.configs.recommended,
-  ...import_typescript_eslint.default.configs.strictTypeChecked,
-  import_eslint_plugin.default.configs.recommended,
-  import_eslint_plugin_jsdoc.default.configs["flat/recommended-typescript"],
-  import_eslint_config_love.default,
-  {
-    languageOptions: {
-      parserOptions: {
-        projectService: true
-      }
-    },
-    linterOptions: {
-      reportUnusedDisableDirectives: "error"
-    },
-    rules: {
-      "complexity": "off",
-      "max-depth": ["error", 10],
-      "max-lines": "off",
-      "no-dupe-class-members": "off",
-      "no-redeclare": "off",
-      "no-unused-vars": "off",
-      "@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-magic-numbers": "off",
-      "@typescript-eslint/no-unnecessary-type-parameters": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          argsIgnorePattern: "^_",
-          varsIgnorePattern: "^_",
-          caughtErrorsIgnorePattern: "^_"
-        }
-      ],
-      "@typescript-eslint/prefer-destructuring": "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/no-trailing-spaces": ["off"],
-      "@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-description": ["warn", {
-        contexts: ["ClassDeclaration", "ClassProperty", "FunctionDeclaration", "MethodDefinition", "TSEnumDeclaration", "TSInterfaceDeclaration", "TSModuleDeclaration", "TSTypeAliasDeclaration"]
-      }],
-      "jsdoc/require-jsdoc": ["warn", {
-        contexts: ["ClassDeclaration", "ClassProperty", "FunctionDeclaration", "MethodDefinition", "TSEnumDeclaration", "TSInterfaceDeclaration", "TSModuleDeclaration", "TSTypeAliasDeclaration"]
-      }],
-      "jsdoc/require-returns": ["warn", {
-        checkGetters: false
-      }],
-      "jsdoc/tag-lines": ["warn", "any", {
-        count: 1,
-        startLines: 1
-      }]
-    }
-  },
-  {
-    files: [
-      "test/**/*"
-    ],
-    rules: {
-      "max-nested-callbacks": "off",
-      "jsdoc/require-jsdoc": "off",
-      "@typescript-eslint/dot-notation": "off",
-      "@typescript-eslint/no-unsafe-type-assertion": "off"
-    }
-  }
-);
-
-// src/publish-dev.ts
-var fs = __toESM(require("fs"), 1);
-
-// src/command-util.ts
-var import_child_process = require("child_process");
-function run(captureOutput, command, ...args) {
-  const spawnResult = (0, import_child_process.spawnSync)(command, args, {
-    stdio: ["inherit", captureOutput ? "pipe" : "inherit", "inherit"]
-  });
-  if (spawnResult.error !== void 0) {
-    throw spawnResult.error;
-  }
-  if (spawnResult.status === null) {
-    throw new Error(`Terminated by signal ${spawnResult.signal}`);
-  }
-  if (spawnResult.status !== 0) {
-    throw new Error(`Failed with status ${spawnResult.status}`);
-  }
-  return captureOutput ? spawnResult.stdout.toString().split("\n").slice(0, -1) : [];
-}
-
-// src/publish-dev.ts
-function zeroPadded(n, length) {
-  return `${"0".repeat(length - 1)}${n}`.slice(-length);
-}
-function fixAlphaDependencies(atOrganization, dependencies) {
-  if (dependencies !== void 0) {
-    for (const dependency in dependencies) {
-      if (dependency.split("/")[0] === atOrganization) {
-        dependencies[dependency] = "alpha";
-      }
-    }
-  }
-}
-function publishDev() {
-  run(false, "npm", "update", "--save");
-  const now = /* @__PURE__ */ new Date();
-  const packageConfigurationPath = "package.json";
-  const backupPackageConfigurationPath = "_package.json";
-  const packageConfiguration = JSON.parse(fs.readFileSync(packageConfigurationPath).toString());
-  const atOrganization = packageConfiguration.name.split("/")[0];
-  fixAlphaDependencies(atOrganization, packageConfiguration.devDependencies);
-  fixAlphaDependencies(atOrganization, packageConfiguration.dependencies);
-  fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}
-`);
-  fs.renameSync(packageConfigurationPath, backupPackageConfigurationPath);
-  try {
-    const [majorVersion, minorVersion, patchVersion] = packageConfiguration.version.split("-")[0].split(".").map((versionString) => Number(versionString));
-    packageConfiguration.version = `${majorVersion}.${minorVersion}.${patchVersion + 1}-alpha.${now.getFullYear()}${zeroPadded(now.getMonth() + 1, 2)}${zeroPadded(now.getDate(), 2)}${zeroPadded(now.getHours(), 2)}${zeroPadded(now.getMinutes(), 2)}`;
-    fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}
-`);
-    run(false, "npm", "run", "build:dev");
-    run(false, "npm", "publish", "--tag", "alpha");
-  } finally {
-    fs.rmSync(packageConfigurationPath);
-    fs.renameSync(backupPackageConfigurationPath, packageConfigurationPath);
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  esLintConfigAIDCToolkit,
-  publishDev
-});
-/*!
- * 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.d.cts

@@ -1,10 +0,0 @@
-import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
-
-declare const esLintConfigAIDCToolkit: _typescript_eslint_utils_ts_eslint.FlatConfig.ConfigArray;
-
-/**
- * Publish to development npm registry.
- */
-declare function publishDev(): void;
-
-export { esLintConfigAIDCToolkit, publishDev };

package/dist/publish-dev.d.ts

@@ -1,5 +0,0 @@
-/**
- * Publish to development npm registry.
- */
-export declare function publishDev(): void;
-//# sourceMappingURL=publish-dev.d.ts.map

package/dist/publish-dev.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"publish-dev.d.ts","sourceRoot":"","sources":["../src/publish-dev.ts"],"names":[],"mappings":"AA+DA;;GAEG;AACH,wBAAgB,UAAU,IAAI,IAAI,CA2CjC"}