complete-cli 1.0.26 → 1.0.27

package/dist/commands/PublishCommand.js

@@ -1,6 +1,6 @@
 import { Command, Option } from "clipanion";
 import { isSemanticVersion } from "complete-common";
-import { $, fatalError, getPackageJSONField, getPackageJSONVersion, getPackageManagerInstallCommand, getPackageManagerLockFileName, getPackageManagersForProject, isFileAsync, isGitRepository, isGitRepositoryClean, isLoggedInToNPM, readFile, updatePackageJSONDependencies, writeFileAsync, } from "complete-node";
+import { $, fatalError, getPackageJSONFieldsMandatory, getPackageManagerInstallCommand, getPackageManagerLockFileName, getPackageManagersForProject, isFileAsync, isGitRepository, isGitRepositoryClean, isLoggedInToNPM, readFile, updatePackageJSONDependencies, writeFileAsync, } from "complete-node";
 import path from "node:path";
 import { CWD, DEFAULT_PACKAGE_MANAGER } from "../constants.js";
 export class PublishCommand extends Command {
@@ -140,8 +140,7 @@ async function tryRunNPMScript(scriptName) {
     }
 }
 async function publish(dryRun) {
-    const projectName = getPackageJSONField(undefined, "name");
-    const version = getPackageJSONVersion(undefined);
+    const { name, version } = await getPackageJSONFieldsMandatory(undefined, "name", "version");
     if (dryRun) {
         await $ `git reset --hard`; // Revert the version changes.
     }
@@ -155,7 +154,7 @@ async function publish(dryRun) {
         await $ `npm publish --access=public --ignore-scripts`;
     }
     const dryRunSuffix = dryRun ? " (dry-run)" : "";
-    console.log(`Published ${projectName} version ${version} successfully${dryRunSuffix}.`);
+    console.log(`Published ${name} version ${version} successfully${dryRunSuffix}.`);
 }
 function getReleaseGitCommitMessage(version) {
     return `chore: release ${version}`;

package/dist/commands/init/createProject.js

@@ -1,10 +1,11 @@
 import chalk from "chalk";
-import { repeat } from "complete-common";
-import { $q, copyFileOrDirectory, getFileNamesInDirectory, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, isFile, makeDirectory, readFile, renameFile, updatePackageJSONDependencies, writeFile, } from "complete-node";
+import { assertObject, repeat } from "complete-common";
+import { $q, copyFileOrDirectory, formatWithPrettier, getFileNamesInDirectory, getPackageJSON, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, isFile, makeDirectory, readFile, renameFile, updatePackageJSONDependencies, writeFile, writeFileAsync, } from "complete-node";
 import path from "node:path";
 import { ACTION_YML, ACTION_YML_TEMPLATE_PATH, TEMPLATES_DYNAMIC_DIR, TEMPLATES_STATIC_DIR, } from "../../constants.js";
 import { initGitRepository } from "../../git.js";
 import { promptError, promptLog, promptSpinnerStart } from "../../prompt.js";
+import { LOCKED_DEPENDENCIES } from "./lockedDependencies.js";
 export async function createProject(projectName, authorName, projectPath, createNewDir, gitRemoteURL, skipInstall, packageManager) {
     if (createNewDir) {
         makeDirectory(projectPath);
@@ -16,6 +17,11 @@ export async function createProject(projectName, authorName, projectPath, create
     if (!updated) {
         promptError('Failed to update the dependencies in the "package.json" file.');
     }
+    // There may be one or more dependencies that should not be updated to the latest version.
+    if (LOCKED_DEPENDENCIES.length > 0) {
+        await revertVersionsInPackageJSON(projectPath);
+        await createPackageMetadataJSON(projectPath);
+    }
     await installNodeModules(projectPath, skipInstall, packageManager);
     await formatFiles(projectPath);
     // Only make the initial commit once all of the files have been copied and formatted.
@@ -107,6 +113,33 @@ function copyDynamicFiles(projectName, authorName, projectPath, packageManager)
     const srcPath = path.join(projectPath, "src");
     makeDirectory(srcPath);
 }
+async function revertVersionsInPackageJSON(projectPath) {
+    const packageJSONPath = path.join(projectPath, "package.json");
+    const packageJSON = await getPackageJSON(packageJSONPath);
+    const { devDependencies } = packageJSON;
+    assertObject(devDependencies, 'The "devDependencies" in the "package.json" file was not an object.');
+    for (const { name, version } of LOCKED_DEPENDENCIES) {
+        devDependencies[name] = version;
+    }
+    const packageJSONText = JSON.stringify(packageJSON);
+    await formatWithPrettier(packageJSONText, "json", projectPath);
+    await writeFileAsync(packageJSONPath, packageJSONText);
+}
+async function createPackageMetadataJSON(projectPath) {
+    const packageMetadata = {
+        devDependencies: {},
+    };
+    for (const { name, reason } of LOCKED_DEPENDENCIES) {
+        packageMetadata.devDependencies[name] = {
+            "lock-version": true,
+            "lock-reason": reason,
+        };
+    }
+    const packageMetadataText = JSON.stringify(packageMetadata);
+    await formatWithPrettier(packageMetadataText, "json", projectPath);
+    const packageMetadataPath = path.join(projectPath, "package-metadata.json");
+    await writeFileAsync(packageMetadataPath, packageMetadataText);
+}
 async function installNodeModules(projectPath, skipInstall, packageManager) {
     if (skipInstall) {
         return;

package/dist/commands/init/lockedDependencies.js

@@ -0,0 +1,8 @@
+// eslint-disable-next-line complete/require-capital-const-assertions
+export const LOCKED_DEPENDENCIES = [
+    {
+        name: "typescript",
+        version: "5.7.3",
+        reason: "https://github.com/typescript-eslint/typescript-eslint/issues/10884",
+    },
+];

package/dist/constants.js

@@ -5,7 +5,7 @@ export const CWD = process.cwd();
 export const CURRENT_DIRECTORY_NAME = path.basename(CWD);
 export const HOME_DIR = os.homedir();
 const packageRoot = findPackageRoot();
-const { name, version } = getPackageJSONFieldsMandatory(packageRoot, "name", "version");
+const { name, version } = await getPackageJSONFieldsMandatory(packageRoot, "name", "version");
 export const PROJECT_NAME = name;
 export const PROJECT_VERSION = version;
 export const DEFAULT_PACKAGE_MANAGER = PackageManager.npm;

package/file-templates/dynamic/package.json

@@ -31,6 +31,6 @@
     "complete-cli": "0.0.1",
     "complete-lint": "0.0.1",
     "complete-node": "0.0.1",
-    "typescript": "5.7.3"
+    "typescript": "0.0.1"
   }
 }

package/file-templates/static/.github/workflows/ci.yml

@@ -16,3 +16,15 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/workflows/setup
       - run: npm run lint
+
+  discord:
+    name: Discord Failure Notification
+    needs: [build, lint]
+    if: failure()
+    runs-on: ubuntu-latest
+    steps:
+      - uses: sarisia/actions-status-discord@v1
+        with:
+          webhook: ${{ secrets.DISCORD_WEBHOOK }}
+          status: failure
+          title: ""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-cli",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "description": "A command line tool for bootstrapping TypeScript projects.",
   "keywords": [
     "typescript"
@@ -38,7 +38,7 @@
     "chalk": "5.4.1",
     "clipanion": "4.0.0-rc.4",
     "complete-common": "1.3.0",
-    "complete-node": "3.1.9",
+    "complete-node": "4.0.1",
     "klaw-sync": "6.0.0",
     "yaml": "2.7.0"
   },

package/src/commands/PublishCommand.ts

@@ -4,8 +4,7 @@ import type { PackageManager } from "complete-node";
 import {
   $,
   fatalError,
-  getPackageJSONField,
-  getPackageJSONVersion,
+  getPackageJSONFieldsMandatory,
   getPackageManagerInstallCommand,
   getPackageManagerLockFileName,
   getPackageManagersForProject,
@@ -218,8 +217,11 @@ async function tryRunNPMScript(scriptName: string) {
 }
 
 async function publish(dryRun: boolean) {
-  const projectName = getPackageJSONField(undefined, "name");
-  const version = getPackageJSONVersion(undefined);
+  const { name, version } = await getPackageJSONFieldsMandatory(
+    undefined,
+    "name",
+    "version",
+  );
 
   if (dryRun) {
     await $`git reset --hard`; // Revert the version changes.
@@ -236,7 +238,7 @@ async function publish(dryRun: boolean) {
 
   const dryRunSuffix = dryRun ? " (dry-run)" : "";
   console.log(
-    `Published ${projectName} version ${version} successfully${dryRunSuffix}.`,
+    `Published ${name} version ${version} successfully${dryRunSuffix}.`,
   );
 }
 

package/src/commands/init/createProject.ts

@@ -1,10 +1,12 @@
 import chalk from "chalk";
-import { repeat } from "complete-common";
+import { assertObject, repeat } from "complete-common";
 import type { PackageManager } from "complete-node";
 import {
   $q,
   copyFileOrDirectory,
+  formatWithPrettier,
   getFileNamesInDirectory,
+  getPackageJSON,
   getPackageManagerInstallCICommand,
   getPackageManagerInstallCommand,
   isFile,
@@ -13,6 +15,7 @@ import {
   renameFile,
   updatePackageJSONDependencies,
   writeFile,
+  writeFileAsync,
 } from "complete-node";
 import path from "node:path";
 import {
@@ -23,6 +26,7 @@ import {
 } from "../../constants.js";
 import { initGitRepository } from "../../git.js";
 import { promptError, promptLog, promptSpinnerStart } from "../../prompt.js";
+import { LOCKED_DEPENDENCIES } from "./lockedDependencies.js";
 
 export async function createProject(
   projectName: string,
@@ -48,6 +52,12 @@ export async function createProject(
     );
   }
 
+  // There may be one or more dependencies that should not be updated to the latest version.
+  if (LOCKED_DEPENDENCIES.length > 0) {
+    await revertVersionsInPackageJSON(projectPath);
+    await createPackageMetadataJSON(projectPath);
+  }
+
   await installNodeModules(projectPath, skipInstall, packageManager);
   await formatFiles(projectPath);
 
@@ -173,6 +183,38 @@ function copyDynamicFiles(
   makeDirectory(srcPath);
 }
 
+async function revertVersionsInPackageJSON(projectPath: string) {
+  const packageJSONPath = path.join(projectPath, "package.json");
+  const packageJSON = await getPackageJSON(packageJSONPath);
+  const { devDependencies } = packageJSON;
+  assertObject(
+    devDependencies,
+    'The "devDependencies" in the "package.json" file was not an object.',
+  );
+  for (const { name, version } of LOCKED_DEPENDENCIES) {
+    devDependencies[name] = version;
+  }
+  const packageJSONText = JSON.stringify(packageJSON);
+  await formatWithPrettier(packageJSONText, "json", projectPath);
+  await writeFileAsync(packageJSONPath, packageJSONText);
+}
+
+async function createPackageMetadataJSON(projectPath: string) {
+  const packageMetadata = {
+    devDependencies: {} as Record<string, unknown>,
+  };
+  for (const { name, reason } of LOCKED_DEPENDENCIES) {
+    packageMetadata.devDependencies[name] = {
+      "lock-version": true,
+      "lock-reason": reason,
+    };
+  }
+  const packageMetadataText = JSON.stringify(packageMetadata);
+  await formatWithPrettier(packageMetadataText, "json", projectPath);
+  const packageMetadataPath = path.join(projectPath, "package-metadata.json");
+  await writeFileAsync(packageMetadataPath, packageMetadataText);
+}
+
 async function installNodeModules(
   projectPath: string,
   skipInstall: boolean,

package/src/commands/init/lockedDependencies.ts

@@ -0,0 +1,15 @@
+interface LockedDependency {
+  name: string;
+  version: string;
+  reason: string;
+}
+
+// eslint-disable-next-line complete/require-capital-const-assertions
+export const LOCKED_DEPENDENCIES: readonly LockedDependency[] = [
+  {
+    name: "typescript",
+    version: "5.7.3",
+    reason:
+      "https://github.com/typescript-eslint/typescript-eslint/issues/10884",
+  },
+];

package/src/constants.ts

@@ -12,7 +12,7 @@ export const CURRENT_DIRECTORY_NAME = path.basename(CWD);
 export const HOME_DIR = os.homedir();
 
 const packageRoot = findPackageRoot();
-const { name, version } = getPackageJSONFieldsMandatory(
+const { name, version } = await getPackageJSONFieldsMandatory(
   packageRoot,
   "name",
   "version",

package/file-templates/static/package-metadata.json

@@ -1,8 +0,0 @@
-{
-  "devDependencies": {
-    "typescript": {
-      "lock-version": true,
-      "lock-reason": "https://github.com/typescript-eslint/typescript-eslint/issues/10884"
-    }
-  }
-}