complete-cli 1.3.2 → 1.3.4

package/src/commands/init/createProject.ts

@@ -12,10 +12,9 @@ import {
   makeDirectory,
   PackageManager,
   readFile,
-  renameFile,
+  renameFileOrDirectory,
   updatePackageJSONDependencies,
   writeFile,
-  writeFileAsync,
 } from "complete-node";
 import path from "node:path";
 import {
@@ -38,12 +37,12 @@ export async function createProject(
   packageManager: PackageManager,
 ): Promise<void> {
   if (createNewDir) {
-    makeDirectory(projectPath);
+    await makeDirectory(projectPath);
   }
 
-  copyStaticFiles(projectPath);
-  copyDynamicFiles(projectName, authorName, projectPath, packageManager);
-  copyPackageManagerSpecificFiles(projectPath, packageManager);
+  await copyStaticFiles(projectPath);
+  await copyDynamicFiles(projectName, authorName, projectPath, packageManager);
+  await copyPackageManagerSpecificFiles(projectPath, packageManager);
 
   // There is no package manager lock files yet, so we have to pass "false" to this function.
   const updated = await updatePackageJSONDependencies(projectPath, false, true);
@@ -69,38 +68,44 @@ export async function createProject(
 }
 
 /** Copy static files, like "eslint.config.mjs", "tsconfig.json", etc. */
-function copyStaticFiles(projectPath: string) {
-  copyTemplateDirectoryWithoutOverwriting(TEMPLATES_STATIC_DIR, projectPath);
+async function copyStaticFiles(projectPath: string) {
+  await copyTemplateDirectoryWithoutOverwriting(
+    TEMPLATES_STATIC_DIR,
+    projectPath,
+  );
 
   // Rename "_gitattributes" to ".gitattributes". (If it is kept as ".gitattributes", then it won't
   // be committed to git.)
   const gitAttributesPath = path.join(projectPath, "_gitattributes");
   const correctGitAttributesPath = path.join(projectPath, ".gitattributes");
-  renameFile(gitAttributesPath, correctGitAttributesPath);
+  await renameFileOrDirectory(gitAttributesPath, correctGitAttributesPath);
 
   // Rename "_cspell.config.jsonc" to "cspell.config.jsonc". (If it is kept as
   // "cspell.config.jsonc", then local spell checking will fail.)
   const cSpellConfigPath = path.join(projectPath, "_cspell.config.jsonc");
   const correctCSpellConfigPath = path.join(projectPath, "cspell.config.jsonc");
-  renameFile(cSpellConfigPath, correctCSpellConfigPath);
+  await renameFileOrDirectory(cSpellConfigPath, correctCSpellConfigPath);
 }
 
-function copyTemplateDirectoryWithoutOverwriting(
+async function copyTemplateDirectoryWithoutOverwriting(
   templateDirPath: string,
   projectPath: string,
 ) {
-  const fileNames = getFileNamesInDirectory(templateDirPath);
-  for (const fileName of fileNames) {
-    const templateFilePath = path.join(templateDirPath, fileName);
-    const destinationFilePath = path.join(projectPath, fileName);
-    if (!isFile(destinationFilePath)) {
-      copyFileOrDirectory(templateFilePath, destinationFilePath);
-    }
-  }
+  const fileNames = await getFileNamesInDirectory(templateDirPath);
+  await Promise.all(
+    fileNames.map(async (fileName) => {
+      const templateFilePath = path.join(templateDirPath, fileName);
+      const destinationFilePath = path.join(projectPath, fileName);
+      const file = await isFile(destinationFilePath);
+      if (!file) {
+        await copyFileOrDirectory(templateFilePath, destinationFilePath);
+      }
+    }),
+  );
 }
 
 /** Copy files that need to have text replaced inside of them. */
-function copyDynamicFiles(
+async function copyDynamicFiles(
   projectName: string,
   authorName: string | undefined,
   projectPath: string,
@@ -110,7 +115,7 @@ function copyDynamicFiles(
   {
     const fileName = ACTION_YML;
     const templatePath = ACTION_YML_TEMPLATE_PATH;
-    const template = readFile(templatePath);
+    const template = await readFile(templatePath);
 
     const installCommand = getPackageManagerInstallCICommand(packageManager);
     const actionYML = template
@@ -118,9 +123,9 @@ function copyDynamicFiles(
       .replaceAll("PACKAGE_MANAGER_INSTALL_COMMAND", installCommand);
 
     const setupPath = path.join(projectPath, ".github", "workflows", "setup");
-    makeDirectory(setupPath);
+    await makeDirectory(setupPath);
     const destinationPath = path.join(setupPath, fileName);
-    writeFile(destinationPath, actionYML);
+    await writeFile(destinationPath, actionYML);
   }
 
   // `.gitignore`
@@ -129,7 +134,7 @@ function copyDynamicFiles(
       TEMPLATES_DYNAMIC_DIR,
       "_gitignore", // Not named ".gitignore" to prevent npm from deleting it.
     );
-    const template = readFile(templatePath);
+    const template = await readFile(templatePath);
 
     // Prepend a header with the project name.
     let separatorLine = "# ";
@@ -142,33 +147,33 @@ function copyDynamicFiles(
       TEMPLATES_DYNAMIC_DIR,
       "Node.gitignore",
     );
-    const nodeGitIgnore = readFile(nodeGitIgnorePath);
+    const nodeGitIgnore = await readFile(nodeGitIgnorePath);
 
     // eslint-disable-next-line prefer-template
     const gitignore = gitIgnoreHeader + template + "\n" + nodeGitIgnore;
 
     // We need to replace the underscore with a period.
     const destinationPath = path.join(projectPath, ".gitignore");
-    writeFile(destinationPath, gitignore);
+    await writeFile(destinationPath, gitignore);
   }
 
   // `package.json`
   {
     const templatePath = path.join(TEMPLATES_DYNAMIC_DIR, "package.json");
-    const template = readFile(templatePath);
+    const template = await readFile(templatePath);
 
     const packageJSON = template
       .replaceAll("project-name", projectName)
       .replaceAll("author-name", authorName ?? "unknown");
 
     const destinationPath = path.join(projectPath, "package.json");
-    writeFile(destinationPath, packageJSON);
+    await writeFile(destinationPath, packageJSON);
   }
 
   // `README.md`
   {
     const templatePath = path.join(TEMPLATES_DYNAMIC_DIR, "README.md");
-    const template = readFile(templatePath);
+    const template = await readFile(templatePath);
 
     // "PROJECT-NAME" must be hyphenated, as using an underscore will break Prettier for some
     // reason.
@@ -177,11 +182,11 @@ function copyDynamicFiles(
       .replaceAll("PROJECT-NAME", projectName)
       .replaceAll("PACKAGE-MANAGER-INSTALL-COMMAND", command);
     const destinationPath = path.join(projectPath, "README.md");
-    writeFile(destinationPath, readmeMD);
+    await writeFile(destinationPath, readmeMD);
   }
 }
 
-function copyPackageManagerSpecificFiles(
+async function copyPackageManagerSpecificFiles(
   projectPath: string,
   packageManager: PackageManager,
 ) {
@@ -189,7 +194,7 @@ function copyPackageManagerSpecificFiles(
     case PackageManager.npm: {
       const npmrc = "save-exact=true\n";
       const npmrcPath = path.join(projectPath, ".npmrc");
-      writeFile(npmrcPath, npmrc);
+      await writeFile(npmrcPath, npmrc);
       break;
     }
 
@@ -198,7 +203,7 @@ function copyPackageManagerSpecificFiles(
     case PackageManager.pnpm: {
       const npmrc = "save-exact=true\nshamefully-hoist=true\n";
       const npmrcPath = path.join(projectPath, ".npmrc");
-      writeFile(npmrcPath, npmrc);
+      await writeFile(npmrcPath, npmrc);
       break;
     }
 
@@ -209,7 +214,35 @@ function copyPackageManagerSpecificFiles(
     case PackageManager.bun: {
       const bunfig = "[install]\nexact = true\n";
       const bunfigPath = path.join(projectPath, "bunfig.toml");
-      writeFile(bunfigPath, bunfig);
+      await writeFile(bunfigPath, bunfig);
+
+      // Additionally, we assume that if they are using the Bun package manager, they also want to
+      // use the Bun runtime. First, replace "complete-tsconfig/tsconfig.node.json" with
+      // "complete-tsconfig/tsconfig.bun.json".
+      const tsConfigJSONPath = path.join(projectPath, "tsconfig.json");
+      const tsConfigJSONScriptsPath = path.join(
+        projectPath,
+        "scripts",
+        "tsconfig.json",
+      );
+      const filePathsToReplaceNodeWithBun = [
+        tsConfigJSONPath,
+        tsConfigJSONScriptsPath,
+      ];
+      await Promise.all(
+        filePathsToReplaceNodeWithBun.map(async (filePath) => {
+          const fileContents = await readFile(filePath);
+          const newFileContents = fileContents.replaceAll("node", "bun");
+          await writeFile(filePath, newFileContents);
+        }),
+      );
+
+      // Second, replace "tsx" with "bun run".
+      const packageJSONPath = path.join(projectPath, "package.json");
+      const fileContents = await readFile(packageJSONPath);
+      const newFileContents = fileContents.replaceAll("tsx", "bun run");
+      await writeFile(packageJSONPath, newFileContents);
+
       break;
     }
   }
@@ -228,7 +261,7 @@ async function revertVersionsInPackageJSON(projectPath: string) {
   }
   const packageJSONText = JSON.stringify(packageJSON);
   await formatWithPrettier(packageJSONText, "json", projectPath);
-  await writeFileAsync(packageJSONPath, packageJSONText);
+  await writeFile(packageJSONPath, packageJSONText);
 }
 
 async function createPackageMetadataJSON(projectPath: string) {
@@ -244,7 +277,7 @@ async function createPackageMetadataJSON(projectPath: string) {
   const packageMetadataText = JSON.stringify(packageMetadata);
   await formatWithPrettier(packageMetadataText, "json", projectPath);
   const packageMetadataPath = path.join(projectPath, "package-metadata.json");
-  await writeFileAsync(packageMetadataPath, packageMetadataText);
+  await writeFile(packageMetadataPath, packageMetadataText);
 }
 
 async function installNodeModules(

package/src/commands/init/packageManager.ts

@@ -1,7 +1,12 @@
 import chalk from "chalk";
 import type { ReadonlyRecord } from "complete-common";
-import { getEnumValues } from "complete-common";
-import { commandExists, PackageManager } from "complete-node";
+import { assertDefined, getEnumValues } from "complete-common";
+import {
+  commandExists,
+  getJavaScriptRuntime,
+  JavaScriptRuntime,
+  PackageManager,
+} from "complete-node";
 import { DEFAULT_PACKAGE_MANAGER } from "../../constants.js";
 import { promptError } from "../../prompt.js";
 
@@ -10,8 +15,21 @@ const PACKAGE_MANAGERS = getEnumValues(PackageManager);
 export async function getPackageManagerUsedForNewProject(
   options: ReadonlyRecord<PackageManager, boolean>,
 ): Promise<PackageManager> {
+  // If the package manager was explicitly specified in the options, use that.
   const packageManagerFromOptions = await getPackageManagerFromOptions(options);
-  return packageManagerFromOptions ?? DEFAULT_PACKAGE_MANAGER;
+  if (packageManagerFromOptions !== undefined) {
+    return packageManagerFromOptions;
+  }
+
+  // If `bun` or `bunx` was used to launch this program, assume that they also want to use the Bun
+  // package manager.
+  const javaScriptRuntime = getJavaScriptRuntime();
+  assertDefined(javaScriptRuntime, "Failed to get the JavaScript runtime.");
+  if (javaScriptRuntime === JavaScriptRuntime.bun) {
+    return PackageManager.bun;
+  }
+
+  return DEFAULT_PACKAGE_MANAGER;
 }
 
 async function getPackageManagerFromOptions(
@@ -19,6 +37,7 @@ async function getPackageManagerFromOptions(
 ) {
   for (const packageManager of PACKAGE_MANAGERS) {
     if (options[packageManager]) {
+      // Only one package manager flag will be specified at a time.
       // eslint-disable-next-line no-await-in-loop
       const exists = await commandExists(packageManager);
       if (!exists) {

package/src/commands/init/vsCodeInit.ts

@@ -1,3 +1,4 @@
+import { assertObject } from "complete-common";
 import { $, $q, commandExists, getJSONC, isFile } from "complete-node";
 import path from "node:path";
 import { getInputYesNo, promptError, promptLog } from "../../prompt.js";
@@ -28,6 +29,8 @@ export async function vsCodeInit(
 
 async function getVSCodeCommand(): Promise<string | undefined> {
   for (const command of VS_CODE_COMMANDS) {
+    // We want to only check for one command at a time, since it is unlikely that the special VSCode
+    // commands will exist.
     // eslint-disable-next-line no-await-in-loop
     const exists = await commandExists(command);
     if (exists) {
@@ -67,11 +70,16 @@ async function getExtensionsFromJSON(
     "extensions.json",
   );
 
-  if (!isFile(extensionsJSONPath)) {
+  const extensionsJSONExists = await isFile(extensionsJSONPath);
+  if (!extensionsJSONExists) {
     return [];
   }
 
   const extensionsJSON = await getJSONC(extensionsJSONPath);
+  assertObject(
+    extensionsJSON,
+    `The "${extensionsJSONPath}" file is not an object.`,
+  );
 
   const { recommendations } = extensionsJSON;
   if (!Array.isArray(recommendations)) {

package/src/git.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { $q, commandExists, isFileAsync, readFileAsync } from "complete-node";
+import { $q, commandExists, isFile, readFile } from "complete-node";
 import path from "node:path";
 import yaml from "yaml";
 import { HOME_DIR, PROJECT_NAME, PROJECT_VERSION } from "./constants.js";
@@ -21,12 +21,12 @@ export async function getGitHubUsername(): Promise<string | undefined> {
     return undefined;
   }
 
-  const hostsPathExists = await isFileAsync(githubCLIHostsPath);
+  const hostsPathExists = await isFile(githubCLIHostsPath);
   if (!hostsPathExists) {
     return undefined;
   }
 
-  const configYAMLRaw = await readFileAsync(githubCLIHostsPath);
+  const configYAMLRaw = await readFile(githubCLIHostsPath);
   const configYAML = yaml.parse(configYAMLRaw) as GitHubCLIHostsYAML;
 
   const githubCom = configYAML["github.com"];

package/src/prompt.ts

@@ -10,7 +10,7 @@ import {
   outro,
   spinner,
   text,
-} from "@zamiell/clack-prompts";
+} from "@clack/prompts";
 import chalk from "chalk";
 import { PROJECT_NAME } from "./constants.js";