complete-cli 1.2.4 → 1.3.1

package/dist/commands/MetadataCommand.js

@@ -0,0 +1,50 @@
+import { Command, Option } from "clipanion";
+import { assertObject, isObject } from "complete-common";
+import { getFilePath, isFileAsync, readFileAsync, writeFileAsync, } from "complete-node";
+import path from "node:path";
+export class MetadataCommand extends Command {
+    static paths = [["metadata"], ["m"]];
+    // The first positional argument.
+    dependencyName = Option.String({
+        required: true,
+    });
+    reason = Option.String({
+        required: false,
+    });
+    static usage = Command.Usage({
+        description: 'Creates a "package-metadata.json" file to document locked dependencies. (The "update" command will respect the contents of this file.)',
+    });
+    async execute() {
+        const packageJSONPath = await getFilePath("package.json", undefined);
+        const packageRoot = path.dirname(packageJSONPath);
+        const packageMetadataPath = path.join(packageRoot, "package-metadata.json");
+        const packageMetadataExists = await isFileAsync(packageMetadataPath);
+        let packageMetadata;
+        if (packageMetadataExists) {
+            const packageMetadataContents = await readFileAsync(packageMetadataPath);
+            const packageMetadataUnknown = JSON.parse(packageMetadataContents);
+            assertObject(packageMetadataUnknown, `Failed to parse the metadata file at: ${packageMetadataPath}`);
+            packageMetadata = packageMetadataUnknown;
+        }
+        else {
+            packageMetadata = {};
+        }
+        let dependencies;
+        if (isObject(packageMetadata["dependencies"])) {
+            // eslint-disable-next-line @typescript-eslint/prefer-destructuring
+            dependencies = packageMetadata["dependencies"];
+        }
+        else {
+            dependencies = {};
+            packageMetadata["dependencies"] = dependencies;
+        }
+        dependencies[this.dependencyName] = {
+            "lock-version": true,
+            "lock-reason": this.reason ?? "",
+        };
+        const packageMetadataJSON = JSON.stringify(packageMetadata, undefined, 2);
+        await writeFileAsync(packageMetadataPath, packageMetadataJSON);
+        const verb = packageMetadataExists ? "modified" : "created";
+        console.log(`Successfully ${verb}: ${packageMetadataPath}`);
+    }
+}

package/dist/main.js

@@ -2,6 +2,7 @@
 import { Builtins, Cli } from "clipanion";
 import { CheckCommand } from "./commands/CheckCommand.js";
 import { InitCommand } from "./commands/InitCommand.js";
+import { MetadataCommand } from "./commands/MetadataCommand.js";
 import { NukeCommand } from "./commands/NukeCommand.js";
 import { PublishCommand } from "./commands/PublishCommand.js";
 import { UpdateCommand } from "./commands/UpdateCommand.js";
@@ -16,6 +17,7 @@ async function main() {
     });
     cli.register(CheckCommand);
     cli.register(InitCommand);
+    cli.register(MetadataCommand);
     cli.register(NukeCommand);
     cli.register(PublishCommand);
     cli.register(UpdateCommand);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-cli",
-  "version": "1.2.4",
+  "version": "1.3.1",
   "description": "A command line tool for bootstrapping TypeScript projects.",
   "keywords": [
     "typescript"
@@ -35,20 +35,20 @@
   },
   "dependencies": {
     "@zamiell/clack-prompts": "0.10.2",
-    "chalk": "5.4.1",
+    "chalk": "5.5.0",
     "clipanion": "4.0.0-rc.4",
     "complete-common": "2.5.0",
-    "complete-node": "7.4.4-dev.1",
+    "complete-node": "7.4.4",
     "klaw-sync": "7.0.0",
     "yaml": "2.8.0"
   },
   "devDependencies": {
     "@types/klaw-sync": "6.0.5",
-    "@types/node": "24.1.0",
+    "@types/node": "24.2.0",
     "ts-loader": "9.5.2",
     "tsconfig-paths-webpack-plugin": "4.2.0",
-    "typescript": "5.8.3",
-    "typescript-eslint": "8.38.0",
+    "typescript": "5.9.2",
+    "typescript-eslint": "8.39.0",
     "webpack": "5.101.0",
     "webpack-cli": "6.0.1",
     "webpack-shebang-plugin": "1.1.8"

package/src/commands/MetadataCommand.ts

@@ -0,0 +1,69 @@
+import { Command, Option } from "clipanion";
+import { assertObject, isObject } from "complete-common";
+import {
+  getFilePath,
+  isFileAsync,
+  readFileAsync,
+  writeFileAsync,
+} from "complete-node";
+import path from "node:path";
+
+export class MetadataCommand extends Command {
+  static override paths = [["metadata"], ["m"]];
+
+  // The first positional argument.
+  dependencyName = Option.String({
+    required: true,
+  });
+
+  reason = Option.String({
+    required: false,
+  });
+
+  static override usage = Command.Usage({
+    description:
+      'Creates a "package-metadata.json" file to document locked dependencies. (The "update" command will respect the contents of this file.)',
+  });
+
+  async execute(): Promise<void> {
+    const packageJSONPath = await getFilePath("package.json", undefined);
+    const packageRoot = path.dirname(packageJSONPath);
+    const packageMetadataPath = path.join(packageRoot, "package-metadata.json");
+    const packageMetadataExists = await isFileAsync(packageMetadataPath);
+
+    let packageMetadata: Record<string, unknown>;
+    if (packageMetadataExists) {
+      const packageMetadataContents = await readFileAsync(packageMetadataPath);
+      const packageMetadataUnknown = JSON.parse(
+        packageMetadataContents,
+      ) as unknown;
+      assertObject(
+        packageMetadataUnknown,
+        `Failed to parse the metadata file at: ${packageMetadataPath}`,
+      );
+      packageMetadata = packageMetadataUnknown;
+    } else {
+      packageMetadata = {};
+    }
+
+    let dependencies: Record<string, unknown>;
+    if (isObject(packageMetadata["dependencies"])) {
+      // eslint-disable-next-line @typescript-eslint/prefer-destructuring
+      dependencies = packageMetadata["dependencies"];
+    } else {
+      dependencies = {};
+      packageMetadata["dependencies"] = dependencies;
+    }
+
+    dependencies[this.dependencyName] = {
+      "lock-version": true,
+      "lock-reason": this.reason ?? "",
+    };
+
+    const packageMetadataJSON = JSON.stringify(packageMetadata, undefined, 2);
+    await writeFileAsync(packageMetadataPath, packageMetadataJSON);
+
+    const verb = packageMetadataExists ? "modified" : "created";
+    console.log(`Successfully ${verb}: ${packageMetadataPath}`);
+  }
+}

package/src/main.ts

@@ -3,6 +3,7 @@
 import { Builtins, Cli } from "clipanion";
 import { CheckCommand } from "./commands/CheckCommand.js";
 import { InitCommand } from "./commands/InitCommand.js";
+import { MetadataCommand } from "./commands/MetadataCommand.js";
 import { NukeCommand } from "./commands/NukeCommand.js";
 import { PublishCommand } from "./commands/PublishCommand.js";
 import { UpdateCommand } from "./commands/UpdateCommand.js";
@@ -21,6 +22,7 @@ async function main() {
 
   cli.register(CheckCommand);
   cli.register(InitCommand);
+  cli.register(MetadataCommand);
   cli.register(NukeCommand);
   cli.register(PublishCommand);
   cli.register(UpdateCommand);