complete-cli 1.3.0 → 1.3.2

package/dist/commands/MetadataCommand.js

@@ -1,5 +1,6 @@
 import { Command, Option } from "clipanion";
-import { getPackageRoot, writeFileAsync } from "complete-node";
+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"]];
@@ -14,17 +15,36 @@ export class MetadataCommand extends Command {
         description: 'Creates a "package-metadata.json" file to document locked dependencies. (The "update" command will respect the contents of this file.)',
     });
     async execute() {
-        const packageMetadata = {
-            dependencies: {},
-        };
-        packageMetadata.dependencies[this.dependencyName] = {
+        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 packageRoot = await getPackageRoot();
-        const packageMetadataPath = path.join(packageRoot, "package-metadata.json");
         const packageMetadataJSON = JSON.stringify(packageMetadata, undefined, 2);
         await writeFileAsync(packageMetadataPath, packageMetadataJSON);
-        console.log(`Successfully created: ${packageMetadataPath}`);
+        const verb = packageMetadataExists ? "modified" : "created";
+        console.log(`Successfully ${verb}: ${packageMetadataPath}`);
     }
 }

package/file-templates/static/.vscode/settings.json

@@ -50,8 +50,8 @@
   "typescript.suggest.completeFunctionCalls": true,
 
   // By default, VSCode will prefer non-relative paths for deeply nested files.
-  "javascript.preferences.importModuleSpecifier": "relative",
-  "typescript.preferences.importModuleSpecifier": "relative",
+  "javascript.preferences.importModuleSpecifier": "project-relative",
+  "typescript.preferences.importModuleSpecifier": "project-relative",
 
   // By default, VSCode will not add `import type` automatically.
   "typescript.preferences.preferTypeOnlyAutoImports": true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-cli",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A command line tool for bootstrapping TypeScript projects.",
   "keywords": [
     "typescript"
@@ -38,17 +38,17 @@
     "chalk": "5.5.0",
     "clipanion": "4.0.0-rc.4",
     "complete-common": "2.5.0",
-    "complete-node": "7.4.4",
+    "complete-node": "7.4.6",
     "klaw-sync": "7.0.0",
-    "yaml": "2.8.0"
+    "yaml": "2.8.1"
   },
   "devDependencies": {
     "@types/klaw-sync": "6.0.5",
     "@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

@@ -1,5 +1,11 @@
 import { Command, Option } from "clipanion";
-import { getPackageRoot, writeFileAsync } from "complete-node";
+import { assertObject, isObject } from "complete-common";
+import {
+  getFilePath,
+  isFileAsync,
+  readFileAsync,
+  writeFileAsync,
+} from "complete-node";
 import path from "node:path";
 
 export class MetadataCommand extends Command {
@@ -20,20 +26,44 @@ export class MetadataCommand extends Command {
   });
 
   async execute(): Promise<void> {
-    const packageMetadata = {
-      dependencies: {} as Record<string, unknown>,
-    };
+    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 = {};
+    }
 
-    packageMetadata.dependencies[this.dependencyName] = {
+    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 packageRoot = await getPackageRoot();
-    const packageMetadataPath = path.join(packageRoot, "package-metadata.json");
     const packageMetadataJSON = JSON.stringify(packageMetadata, undefined, 2);
     await writeFileAsync(packageMetadataPath, packageMetadataJSON);
 
-    console.log(`Successfully created: ${packageMetadataPath}`);
+    const verb = packageMetadataExists ? "modified" : "created";
+    console.log(`Successfully ${verb}: ${packageMetadataPath}`);
   }
 }