complete-cli 1.0.1-dev.3 → 1.0.1-dev.5

package/dist/commands/CheckCommand.js

@@ -1,7 +1,8 @@
 import chalk from "chalk";
 import { Command, Option } from "clipanion";
 import { ReadonlySet } from "complete-common";
-import { $s, deleteFileOrDirectory, fatalError, isDirectory, isFile, readFile, writeFile, } from "complete-node";
+import { deleteFileOrDirectory, fatalError, isDirectory, isFile, readFile, writeFile, } from "complete-node";
+import { $ } from "execa";
 import klawSync from "klaw-sync";
 import path from "node:path";
 import { ACTION_YML, ACTION_YML_TEMPLATE_PATH, CWD, TEMPLATES_DYNAMIC_DIR, TEMPLATES_STATIC_DIR, } from "../constants.js";
@@ -120,7 +121,7 @@ function compareTextFiles(projectFilePath, templateFilePath, verbose) {
     const tempTemplateFilePath = path.join(CWD, "tempTemplateFile.txt");
     writeFile(tempProjectFilePath, projectFileObject.text);
     writeFile(tempTemplateFilePath, templateFileObject.text);
-    $s `diff ${tempProjectFilePath} ${tempTemplateFilePath} --ignore-blank-lines`;
+    $.sync `diff ${tempProjectFilePath} ${tempTemplateFilePath} --ignore-blank-lines`;
     deleteFileOrDirectory(tempProjectFilePath);
     deleteFileOrDirectory(tempTemplateFilePath);
     return false;

package/dist/commands/PublishCommand.js

@@ -1,6 +1,7 @@
 import { Command, Option } from "clipanion";
 import { isSemanticVersion } from "complete-common";
-import { $, $s, fatalError, getPackageJSONField, getPackageJSONVersion, getPackageManagerInstallCommand, getPackageManagerLockFileName, getPackageManagersForProject, isFile, isGitRepository, isGitRepositoryClean, isLoggedInToNPM, readFile, updatePackageJSONDependencies, writeFile, } from "complete-node";
+import { fatalError, getPackageJSONField, getPackageJSONVersion, getPackageManagerInstallCommand, getPackageManagerLockFileName, getPackageManagersForProject, isFileAsync, isGitRepository, isGitRepositoryClean, isLoggedInToNPM, readFile, updatePackageJSONDependencies, writeFileAsync, } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import { CWD, DEFAULT_PACKAGE_MANAGER } from "../constants.js";
 export class PublishCommand extends Command {
@@ -21,24 +22,27 @@ export class PublishCommand extends Command {
     static usage = Command.Usage({
         description: "Bump the version & publish a new release.",
     });
-    // eslint-disable-next-line @typescript-eslint/require-await
     async execute() {
-        validate();
-        prePublish(this.versionBumpType, this.dryRun, this.skipLint, this.skipUpdate);
-        publish(this.dryRun);
+        await validate();
+        await prePublish(this.versionBumpType, this.dryRun, this.skipLint, this.skipUpdate);
+        await publish(this.dryRun);
     }
 }
-function validate() {
-    if (!isGitRepository(CWD)) {
+async function validate() {
+    const isRepository = await isGitRepository(CWD);
+    if (!isRepository) {
         fatalError("Failed to publish since the current working directory is not inside of a git repository.");
     }
-    if (!isGitRepositoryClean(CWD)) {
+    const isRepositoryClean = await isGitRepositoryClean(CWD);
+    if (!isRepositoryClean) {
         fatalError("Failed to publish since the Git repository was dirty. Before publishing, you must push any current changes to git. (Version commits should not contain any code changes.)");
     }
-    if (!isFile("package.json")) {
+    const packageJSONExists = await isFileAsync("package.json");
+    if (!packageJSONExists) {
         fatalError('Failed to find the "package.json" file in the current working directory.');
     }
-    if (!isLoggedInToNPM()) {
+    const isLoggedIn = await isLoggedInToNPM();
+    if (!isLoggedIn) {
         fatalError('Failed to publish since you are not logged in to npm. Try doing "npm login".');
     }
 }
@@ -46,16 +50,16 @@ function validate() {
  * Before uploading the project, we want to update dependencies, increment the version, and perform
  * some other steps.
  */
-function prePublish(versionBumpType, dryRun, skipLint, skipUpdate) {
+async function prePublish(versionBumpType, dryRun, skipLint, skipUpdate) {
     const packageManager = getPackageManagerUsedForExistingProject();
-    $s `git pull --rebase`;
-    $s `git push`;
-    updateDependencies(skipUpdate, dryRun, packageManager);
-    incrementVersion(versionBumpType);
-    unsetDevelopmentConstants();
-    tryRunNPMScript("build");
+    await $ `git pull --rebase`;
+    await $ `git push`;
+    await updateDependencies(skipUpdate, dryRun, packageManager);
+    await incrementVersion(versionBumpType);
+    await unsetDevelopmentConstants();
+    await tryRunNPMScript("build");
     if (!skipLint) {
-        tryRunNPMScript("lint");
+        await tryRunNPMScript("lint");
     }
 }
 function getPackageManagerUsedForExistingProject() {
@@ -73,7 +77,7 @@ function getPackageManagerUsedForExistingProject() {
     }
     return DEFAULT_PACKAGE_MANAGER;
 }
-function updateDependencies(skipUpdate, dryRun, packageManager) {
+async function updateDependencies(skipUpdate, dryRun, packageManager) {
     if (skipUpdate) {
         return;
     }
@@ -82,19 +86,19 @@ function updateDependencies(skipUpdate, dryRun, packageManager) {
     if (hasNewDependencies) {
         const command = getPackageManagerInstallCommand(packageManager);
         const commandParts = command.split(" ");
-        $s `${commandParts}`;
+        await $ `${commandParts}`;
         if (!dryRun) {
-            gitCommitAllAndPush("chore: update dependencies");
+            await gitCommitAllAndPush("chore: update dependencies");
         }
     }
 }
-function gitCommitAllAndPush(message) {
-    $s `git add --all`;
-    $s `git commit --message ${message}`;
-    $s `git push`;
+async function gitCommitAllAndPush(message) {
+    await $ `git add --all`;
+    await $ `git commit --message ${message}`;
+    await $ `git push`;
     console.log(`Committed and pushed to the git repository with a message of: ${message}`);
 }
-function incrementVersion(versionBumpType) {
+async function incrementVersion(versionBumpType) {
     if (versionBumpType === "none") {
         return;
     }
@@ -111,44 +115,45 @@ function incrementVersion(versionBumpType) {
     // We always use `npm` here to avoid differences with the version command between package
     // managers. The "--no-git-tag-version" flag will prevent npm from both making a commit and adding
     // a tag.
-    $s `npm version ${versionBumpType} --no-git-tag-version`;
+    await $ `npm version ${versionBumpType} --no-git-tag-version`;
 }
-function unsetDevelopmentConstants() {
+async function unsetDevelopmentConstants() {
     const constantsTSPath = path.join(CWD, "src", "constants.ts");
-    if (!isFile(constantsTSPath)) {
+    const constantsTSExists = await isFileAsync(constantsTSPath);
+    if (!constantsTSExists) {
         return;
     }
     const constantsTS = readFile(constantsTSPath);
     const newConstantsTS = constantsTS
         .replace("const IS_DEV = true", "const IS_DEV = false")
         .replace("const DEBUG = true", "const DEBUG = false");
-    writeFile(constantsTSPath, newConstantsTS);
+    await writeFileAsync(constantsTSPath, newConstantsTS);
 }
-function tryRunNPMScript(scriptName) {
+async function tryRunNPMScript(scriptName) {
     console.log(`Running: ${scriptName}`);
     const $$ = $({
         reject: false,
     });
-    const { exitCode } = $$.sync `npm run ${scriptName}`;
+    const { exitCode } = await $$ `npm run ${scriptName}`;
     if (exitCode !== 0) {
-        $s `git reset --hard`; // Revert the version changes.
+        await $ `git reset --hard`; // Revert the version changes.
         fatalError(`Failed to run "${scriptName}".`);
     }
 }
-function publish(dryRun) {
+async function publish(dryRun) {
     const projectName = getPackageJSONField(undefined, "name");
     const version = getPackageJSONVersion(undefined);
     if (dryRun) {
-        $s `git reset --hard`; // Revert the version changes.
+        await $ `git reset --hard`; // Revert the version changes.
     }
     else {
         const releaseGitCommitMessage = getReleaseGitCommitMessage(version);
-        gitCommitAllAndPush(releaseGitCommitMessage);
+        await gitCommitAllAndPush(releaseGitCommitMessage);
         // - The "--access=public" flag is only technically needed for the first publish (unless the
         //   package is a scoped package), but it is saved here for posterity.
         // - The "--ignore-scripts" flag is needed since the "npm publish" command will run the
         //   "publish" script in the "package.json" file, causing an infinite loop.
-        $s `npm publish --access=public --ignore-scripts`;
+        await $ `npm publish --access=public --ignore-scripts`;
     }
     const dryRunSuffix = dryRun ? " (dry-run)" : "";
     console.log(`Published ${projectName} version ${version} successfully${dryRunSuffix}.`);

package/dist/commands/init/createProject.js

@@ -1,6 +1,7 @@
 import chalk from "chalk";
 import { repeat } from "complete-common";
-import { $, copyFileOrDirectory, getFileNamesInDirectory, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, isFile, makeDirectory, readFile, renameFile, updatePackageJSONDependencies, writeFile, } from "complete-node";
+import { copyFileOrDirectory, getFileNamesInDirectory, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, isFile, makeDirectory, readFile, renameFile, updatePackageJSONDependencies, writeFile, } from "complete-node";
+import { $ } from "execa";
 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";

package/dist/commands/init/vsCodeInit.js

@@ -1,4 +1,5 @@
-import { $, commandExists, getJSONC, isFile } from "complete-node";
+import { commandExists, getJSONC, isFile } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import { getInputYesNo, promptError, promptLog } from "../../prompt.js";
 const VS_CODE_COMMANDS = [

package/dist/git.js

@@ -1,5 +1,6 @@
 import chalk from "chalk";
-import { $, commandExists, isFile, readFile } from "complete-node";
+import { commandExists, isFile, readFile } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import yaml from "yaml";
 import { HOME_DIR, PROJECT_NAME, PROJECT_VERSION } from "./constants.js";

package/file-templates/dynamic/package.json

@@ -32,6 +32,7 @@
     "complete-cli": "^0.0.1",
     "complete-lint": "^0.0.1",
     "complete-node": "^0.0.1",
-    "typescript": "5.5.4"
+    "execa": "^0.0.1",
+    "typescript": "^0.0.1"
   }
 }

package/file-templates/static/scripts/build.ts

@@ -1,5 +1,6 @@
-import { $s, buildScript } from "complete-node";
+import { buildScript } from "complete-node";
+import { $ } from "execa";
 
-await buildScript(() => {
-  $s`tsc`;
+await buildScript(async () => {
+  await $`tsc`;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-cli",
-  "version": "1.0.1-dev.3",
+  "version": "1.0.1-dev.5",
   "description": "A command line tool for bootstrapping TypeScript projects.",
   "keywords": [
     "typescript"
@@ -39,6 +39,7 @@
     "clipanion": "^4.0.0-rc.4",
     "complete-common": "^1.0.1",
     "complete-node": "^1.7.4",
+    "execa": "^9.5.2",
     "klaw-sync": "^6.0.0",
     "yaml": "^2.7.0"
   },

package/src/commands/CheckCommand.ts

@@ -2,7 +2,6 @@ import chalk from "chalk";
 import { Command, Option } from "clipanion";
 import { ReadonlySet } from "complete-common";
 import {
-  $s,
   deleteFileOrDirectory,
   fatalError,
   isDirectory,
@@ -10,6 +9,7 @@ import {
   readFile,
   writeFile,
 } from "complete-node";
+import { $ } from "execa";
 import klawSync from "klaw-sync";
 import path from "node:path";
 import {
@@ -209,7 +209,7 @@ function compareTextFiles(
   writeFile(tempProjectFilePath, projectFileObject.text);
   writeFile(tempTemplateFilePath, templateFileObject.text);
 
-  $s`diff ${tempProjectFilePath} ${tempTemplateFilePath} --ignore-blank-lines`;
+  $.sync`diff ${tempProjectFilePath} ${tempTemplateFilePath} --ignore-blank-lines`;
 
   deleteFileOrDirectory(tempProjectFilePath);
   deleteFileOrDirectory(tempTemplateFilePath);

package/src/commands/PublishCommand.ts

@@ -2,22 +2,21 @@ import { Command, Option } from "clipanion";
 import { isSemanticVersion } from "complete-common";
 import type { PackageManager } from "complete-node";
 import {
-  $,
-  $s,
   fatalError,
   getPackageJSONField,
   getPackageJSONVersion,
   getPackageManagerInstallCommand,
   getPackageManagerLockFileName,
   getPackageManagersForProject,
-  isFile,
+  isFileAsync,
   isGitRepository,
   isGitRepositoryClean,
   isLoggedInToNPM,
   readFile,
   updatePackageJSONDependencies,
-  writeFile,
+  writeFileAsync,
 } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import { CWD, DEFAULT_PACKAGE_MANAGER } from "../constants.js";
 
@@ -45,39 +44,42 @@ export class PublishCommand extends Command {
     description: "Bump the version & publish a new release.",
   });
 
-  // eslint-disable-next-line @typescript-eslint/require-await
   async execute(): Promise<void> {
-    validate();
-    prePublish(
+    await validate();
+    await prePublish(
       this.versionBumpType,
       this.dryRun,
       this.skipLint,
       this.skipUpdate,
     );
-    publish(this.dryRun);
+    await publish(this.dryRun);
   }
 }
 
-function validate() {
-  if (!isGitRepository(CWD)) {
+async function validate() {
+  const isRepository = await isGitRepository(CWD);
+  if (!isRepository) {
     fatalError(
       "Failed to publish since the current working directory is not inside of a git repository.",
     );
   }
 
-  if (!isGitRepositoryClean(CWD)) {
+  const isRepositoryClean = await isGitRepositoryClean(CWD);
+  if (!isRepositoryClean) {
     fatalError(
       "Failed to publish since the Git repository was dirty. Before publishing, you must push any current changes to git. (Version commits should not contain any code changes.)",
     );
   }
 
-  if (!isFile("package.json")) {
+  const packageJSONExists = await isFileAsync("package.json");
+  if (!packageJSONExists) {
     fatalError(
       'Failed to find the "package.json" file in the current working directory.',
     );
   }
 
-  if (!isLoggedInToNPM()) {
+  const isLoggedIn = await isLoggedInToNPM();
+  if (!isLoggedIn) {
     fatalError(
       'Failed to publish since you are not logged in to npm. Try doing "npm login".',
     );
@@ -88,7 +90,7 @@ function validate() {
  * Before uploading the project, we want to update dependencies, increment the version, and perform
  * some other steps.
  */
-function prePublish(
+async function prePublish(
   versionBumpType: string,
   dryRun: boolean,
   skipLint: boolean,
@@ -96,15 +98,15 @@ function prePublish(
 ) {
   const packageManager = getPackageManagerUsedForExistingProject();
 
-  $s`git pull --rebase`;
-  $s`git push`;
-  updateDependencies(skipUpdate, dryRun, packageManager);
-  incrementVersion(versionBumpType);
-  unsetDevelopmentConstants();
+  await $`git pull --rebase`;
+  await $`git push`;
+  await updateDependencies(skipUpdate, dryRun, packageManager);
+  await incrementVersion(versionBumpType);
+  await unsetDevelopmentConstants();
 
-  tryRunNPMScript("build");
+  await tryRunNPMScript("build");
   if (!skipLint) {
-    tryRunNPMScript("lint");
+    await tryRunNPMScript("lint");
   }
 }
 
@@ -128,7 +130,7 @@ function getPackageManagerUsedForExistingProject(): PackageManager {
   return DEFAULT_PACKAGE_MANAGER;
 }
 
-function updateDependencies(
+async function updateDependencies(
   skipUpdate: boolean,
   dryRun: boolean,
   packageManager: PackageManager,
@@ -142,23 +144,23 @@ function updateDependencies(
   if (hasNewDependencies) {
     const command = getPackageManagerInstallCommand(packageManager);
     const commandParts = command.split(" ");
-    $s`${commandParts}`;
+    await $`${commandParts}`;
     if (!dryRun) {
-      gitCommitAllAndPush("chore: update dependencies");
+      await gitCommitAllAndPush("chore: update dependencies");
     }
   }
 }
 
-function gitCommitAllAndPush(message: string) {
-  $s`git add --all`;
-  $s`git commit --message ${message}`;
-  $s`git push`;
+async function gitCommitAllAndPush(message: string) {
+  await $`git add --all`;
+  await $`git commit --message ${message}`;
+  await $`git push`;
   console.log(
     `Committed and pushed to the git repository with a message of: ${message}`,
   );
 }
 
-function incrementVersion(versionBumpType: string) {
+async function incrementVersion(versionBumpType: string) {
   if (versionBumpType === "none") {
     return;
   }
@@ -184,12 +186,13 @@ function incrementVersion(versionBumpType: string) {
   // We always use `npm` here to avoid differences with the version command between package
   // managers. The "--no-git-tag-version" flag will prevent npm from both making a commit and adding
   // a tag.
-  $s`npm version ${versionBumpType} --no-git-tag-version`;
+  await $`npm version ${versionBumpType} --no-git-tag-version`;
 }
 
-function unsetDevelopmentConstants() {
+async function unsetDevelopmentConstants() {
   const constantsTSPath = path.join(CWD, "src", "constants.ts");
-  if (!isFile(constantsTSPath)) {
+  const constantsTSExists = await isFileAsync(constantsTSPath);
+  if (!constantsTSExists) {
     return;
   }
 
@@ -197,38 +200,38 @@ function unsetDevelopmentConstants() {
   const newConstantsTS = constantsTS
     .replace("const IS_DEV = true", "const IS_DEV = false")
     .replace("const DEBUG = true", "const DEBUG = false");
-  writeFile(constantsTSPath, newConstantsTS);
+  await writeFileAsync(constantsTSPath, newConstantsTS);
 }
 
-function tryRunNPMScript(scriptName: string) {
+async function tryRunNPMScript(scriptName: string) {
   console.log(`Running: ${scriptName}`);
 
   const $$ = $({
     reject: false,
   });
-  const { exitCode } = $$.sync`npm run ${scriptName}`;
+  const { exitCode } = await $$`npm run ${scriptName}`;
 
   if (exitCode !== 0) {
-    $s`git reset --hard`; // Revert the version changes.
+    await $`git reset --hard`; // Revert the version changes.
     fatalError(`Failed to run "${scriptName}".`);
   }
 }
 
-function publish(dryRun: boolean) {
+async function publish(dryRun: boolean) {
   const projectName = getPackageJSONField(undefined, "name");
   const version = getPackageJSONVersion(undefined);
 
   if (dryRun) {
-    $s`git reset --hard`; // Revert the version changes.
+    await $`git reset --hard`; // Revert the version changes.
   } else {
     const releaseGitCommitMessage = getReleaseGitCommitMessage(version);
-    gitCommitAllAndPush(releaseGitCommitMessage);
+    await gitCommitAllAndPush(releaseGitCommitMessage);
 
     // - The "--access=public" flag is only technically needed for the first publish (unless the
     //   package is a scoped package), but it is saved here for posterity.
     // - The "--ignore-scripts" flag is needed since the "npm publish" command will run the
     //   "publish" script in the "package.json" file, causing an infinite loop.
-    $s`npm publish --access=public --ignore-scripts`;
+    await $`npm publish --access=public --ignore-scripts`;
   }
 
   const dryRunSuffix = dryRun ? " (dry-run)" : "";

package/src/commands/init/createProject.ts

@@ -2,7 +2,6 @@ import chalk from "chalk";
 import { repeat } from "complete-common";
 import type { PackageManager } from "complete-node";
 import {
-  $,
   copyFileOrDirectory,
   getFileNamesInDirectory,
   getPackageManagerInstallCICommand,
@@ -14,6 +13,7 @@ import {
   updatePackageJSONDependencies,
   writeFile,
 } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import {
   ACTION_YML,

package/src/commands/init/vsCodeInit.ts

@@ -1,4 +1,5 @@
-import { $, commandExists, getJSONC, isFile } from "complete-node";
+import { commandExists, getJSONC, isFile } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import { getInputYesNo, promptError, promptLog } from "../../prompt.js";
 

package/src/git.ts

@@ -1,5 +1,6 @@
 import chalk from "chalk";
-import { $, commandExists, isFile, readFile } from "complete-node";
+import { commandExists, isFile, readFile } from "complete-node";
+import { $ } from "execa";
 import path from "node:path";
 import yaml from "yaml";
 import { HOME_DIR, PROJECT_NAME, PROJECT_VERSION } from "./constants.js";