@create-node-app/core 0.2.4 → 0.2.5

package/dist/index.d.ts

@@ -8,14 +8,14 @@ declare const printEnvInfo: () => Promise<never>;
 type CnaOptions = {
     projectName: string;
     info?: boolean;
-    alias?: string;
-    srcDir?: string;
     interactive?: boolean;
     verbose?: boolean;
-    useNpm?: boolean;
+    packageManager?: string;
     nodeps?: boolean;
     template?: string;
     templatesOrExtensions?: TemplateOrExtension[];
+} & {
+    [key: string]: unknown;
 };
 type CnaOptionsTransform = (options: CnaOptions) => Promise<CnaOptions>;
 /**
@@ -23,12 +23,10 @@ type CnaOptionsTransform = (options: CnaOptions) => Promise<CnaOptions>;
  * @param programName - Name of the program to bootstrap the Node application
  * @param options - CnaOptions to bootstrap the Node application
  * @param options.info - Print environment debug info
- * @param options.alias - Metadata to specify alias, usefull for backends using webpack
- * @param options.srcDir - Metadata to specify where to put the source code
  * @param options.interactive - Specify if it is needed to use interactive mode or not
  * @param options.verbose - Specify if it is needed to use verbose mode or not
  * @param options.projectName - Project's name
- * @param options.useNpm - Use npm mandatorily
+ * @param options.packageManager - Package manager to use
  * @param options.nodeps - Generate package.json file without installing dependencies
  * @param options.template - Template to bootstrap the aplication
  * @param options.extend - Extensions to apply for the boilerplate generation

package/dist/index.js

@@ -78,6 +78,20 @@ var shouldUseYarn = () => {
   }
   return true;
 };
+var shouldUsePnpm = () => {
+  const { hasMinPnpm, pnpmVersion } = checkPnpmVersion();
+  if (!hasMinPnpm) {
+    console.log(
+      import_chalk.default.yellow(
+        `You are using pnpm version ${import_chalk.default.bold(
+          pnpmVersion
+        )} which is not supported yet. To use pnpm, install v5.0.0 or higher. See https://pnpm.js.org for instructions on how to update.`
+      )
+    );
+    return false;
+  }
+  return true;
+};
 var checkThatNpmCanReadCwd = () => {
   const cwd = process.cwd();
   let childOutput = null;
@@ -130,6 +144,24 @@ This is probably caused by a misconfigured system terminal shell.`
   }
   return false;
 };
+var checkPnpmVersion = () => {
+  const minPnpm = "5.0.0";
+  let hasMinPnpm = false;
+  let pnpmVersion = null;
+  try {
+    pnpmVersion = (0, import_child_process.execSync)("pnpm --version").toString().trim();
+    if (import_semver.default.valid(pnpmVersion)) {
+      hasMinPnpm = import_semver.default.gte(pnpmVersion, minPnpm);
+    } else {
+      const trimmedPnpmVersionMatch = /^(.+?)[-+].+$/.exec(pnpmVersion);
+      if (trimmedPnpmVersionMatch) {
+        hasMinPnpm = import_semver.default.gte(trimmedPnpmVersionMatch[1], minPnpm);
+      }
+    }
+  } catch (e) {
+  }
+  return { hasMinPnpm, pnpmVersion };
+};
 var checkYarnVersion = () => {
   const minYarnPnp = "1.12.0";
   const maxYarnPnp = "2.0.0";
@@ -505,12 +537,12 @@ var templateLoader = ({
   root,
   templateDir,
   appName,
-  alias,
   verbose,
   mode = "",
   srcDir,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => async ({ path: path4 }) => {
   const flag = mode.includes("append") ? "a+" : "w";
   const file = import_fs4.default.readFileSync(`${templateDir}/${path4}`, "utf8");
@@ -519,13 +551,11 @@ var templateLoader = ({
   return writeFile(
     `${root}/${newPath}`,
     newFile({
-      project: alias,
-      projectImport: alias,
-      projectImportPath: alias === "" ? "" : `${alias}/`,
       projectName: appName,
       srcDir: srcDir || ".",
       runCommand,
-      installCommand
+      installCommand,
+      ...customOptions
     }),
     flag,
     verbose
@@ -536,11 +566,11 @@ var fileLoader = ({
   templateDir,
   appName,
   originalDirectory,
-  alias,
   verbose,
   srcDir = DEFAULT_SRC_PATH,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => ({ path: path4 }) => {
   const mode = getModeFromPath(path4);
   const loaders = {
@@ -554,12 +584,12 @@ var fileLoader = ({
     templateDir,
     appName,
     originalDirectory,
-    alias,
     verbose,
     mode,
     srcDir,
     runCommand,
-    installCommand
+    installCommand,
+    ...customOptions
   })({
     path: path4
   });
@@ -569,11 +599,11 @@ var loadFiles = async ({
   templatesOrExtensions = [],
   appName,
   originalDirectory,
-  alias,
   verbose,
   srcDir = DEFAULT_SRC_PATH,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => {
   for await (const { url: templateOrExtensionUrl } of templatesOrExtensions) {
     const templateDir = await getTemplateDirPath(templateOrExtensionUrl);
@@ -597,11 +627,11 @@ var loadFiles = async ({
           templateDir,
           appName,
           originalDirectory,
-          alias,
           verbose,
           srcDir,
           runCommand,
-          installCommand
+          installCommand,
+          ...customOptions
         })(entry);
       } catch (err) {
         if (verbose) {
@@ -614,7 +644,7 @@ var loadFiles = async ({
 };
 
 // installer.ts
-var install = (root, useYarn = false, dependencies = [], verbose = false, isOnline = true, isDevDependencies = false) => {
+var install = (root, useYarn = false, usePnpm = false, dependencies = [], verbose = false, isOnline = true, isDevDependencies = false) => {
   return new Promise((resolve, reject) => {
     let command;
     let args;
@@ -635,6 +665,15 @@ var install = (root, useYarn = false, dependencies = [], verbose = false, isOnli
         console.log(import_chalk3.default.yellow("Falling back to the local Yarn cache."));
         console.log();
       }
+    } else if (usePnpm) {
+      command = "pnpm";
+      args = ["add", "--save"];
+      if (isDevDependencies) {
+        args.push("--save-dev");
+      }
+      args.push(...dependencies);
+      args.push("--cwd");
+      args.push(root);
     } else {
       command = "npm";
       args = ["install", "--loglevel", "error"];
@@ -664,7 +703,6 @@ var runCommandInProjectDir = (root, command, args = [], successMessage = "Operat
     child.on("close", (code) => {
       if (code !== 0) {
         console.log(import_chalk3.default.red(errorMessage));
-        reject(new Error(`${command} ${args.join(" ")}`));
         return;
       }
       console.log(import_chalk3.default.green(successMessage));
@@ -678,14 +716,14 @@ var run = async ({
   originalDirectory,
   verbose = false,
   useYarn = false,
+  usePnpm = false,
   templatesOrExtensions = [],
   dependencies = [],
   devDependencies = [],
-  alias = "",
   installDependencies = true,
-  srcDir = "",
   runCommand = "",
-  installCommand = ""
+  installCommand = "",
+  ...customOptions
 }) => {
   let isOnline = true;
   if (useYarn) {
@@ -701,33 +739,52 @@ var run = async ({
     console.log();
     process.exit(0);
   }
+  console.log();
+  console.log("Scaffolding project in " + root + "...");
   await loadFiles({
     root,
     templatesOrExtensions,
     appName,
     originalDirectory,
-    alias,
     verbose,
-    srcDir,
     runCommand,
-    installCommand
+    installCommand,
+    ...customOptions
   });
+  console.log();
+  console.log(import_chalk3.default.green("Successfully scaffolded project."));
+  console.log();
   if (installDependencies) {
     console.log(
       import_chalk3.default.green("Installing packages. This might take a couple of minutes.")
     );
     console.log(import_chalk3.default.green("Installing dependencies..."));
     console.log();
-    await install(root, useYarn, dependencies, verbose, isOnline, false);
+    await install(
+      root,
+      useYarn,
+      usePnpm,
+      dependencies,
+      verbose,
+      isOnline,
+      false
+    );
     if (devDependencies.length > 0) {
       console.log();
       console.log(import_chalk3.default.green("Installing devDependencies..."));
       console.log();
-      await install(root, useYarn, devDependencies, verbose, isOnline, true);
+      await install(
+        root,
+        useYarn,
+        usePnpm,
+        devDependencies,
+        verbose,
+        isOnline,
+        true
+      );
     }
   } else {
     console.log(import_chalk3.default.yellow("Skip package installation."));
-    console.log(import_chalk3.default.yellow("Run npm install/yarn in your project."));
     const packageJson = JSON.parse(
       import_fs5.default.readFileSync(`${root}/package.json`, "utf8")
     );
@@ -755,17 +812,19 @@ var run = async ({
       import_path4.default.join(root, "package.json"),
       JSON.stringify(packageJson, null, 2) + import_os3.default.EOL
     );
+    console.log();
+    console.log(import_chalk3.default.green("Successfully updated package.json."));
+    console.log(import_chalk3.default.yellow(`Run ${import_chalk3.default.cyan(installCommand)} to install.`));
   }
-  const gitInitProcess = (0, import_cross_spawn2.default)("git", ["init"], {
-    cwd: root
-  });
-  gitInitProcess.on("close", (code) => {
-    if (code !== 0) {
-      console.log(import_chalk3.default.red("Failed to initialize git repository."));
-      return;
-    }
-    console.log(import_chalk3.default.green("Initialized git repository."));
-  });
+  console.log();
+  console.log("Initializing git repository...");
+  await runCommandInProjectDir(
+    root,
+    "git",
+    ["init"],
+    "Successfully initialized git repository.",
+    "Failed to initialize git repository."
+  );
   if (installDependencies && isOnline) {
     const packageJson = JSON.parse(
       import_fs5.default.readFileSync(`${root}/package.json`, "utf8")
@@ -792,12 +851,10 @@ var run = async ({
 var createApp = async ({
   name,
   verbose = false,
-  useNpm = false,
   templatesOrExtensions = [],
-  alias = "",
   installDependencies = true,
   ignorePackage = false,
-  srcDir = ""
+  ...customOptions
 }) => {
   const root = import_path4.default.resolve(name);
   const appName = import_path4.default.basename(root);
@@ -806,14 +863,15 @@ var createApp = async ({
   });
   console.log(`Creating a new Node app in ${import_chalk3.default.green(root)}.`);
   console.log();
-  const useYarn = useNpm ? false : shouldUseYarn();
-  const command = useYarn ? "yarn" : "npm run";
+  const useYarn = customOptions.packageManager === "yarn" && shouldUseYarn();
+  const usePnpm = customOptions.packageManager === "pnpm" && shouldUsePnpm();
+  const runCommand = useYarn ? "yarn" : "npm run";
+  const installCommand = useYarn ? "yarn" : usePnpm ? "pnpm install" : "npm install";
   const { packageJson, dependencies, devDependencies } = await loadPackages({
     templatesOrExtensions,
     appName,
-    command,
-    ignorePackage,
-    srcDir
+    runCommand,
+    ignorePackage
   });
   import_fs5.default.writeFileSync(
     import_path4.default.join(root, "package.json"),
@@ -869,14 +927,14 @@ Please update to npm 3 or higher for a better, fully supported experience.
     originalDirectory,
     verbose,
     useYarn,
+    usePnpm,
     templatesOrExtensions,
     dependencies,
     devDependencies,
-    alias,
     installDependencies,
-    srcDir,
-    runCommand: command,
-    installCommand: useYarn ? "yarn" : "npm install"
+    runCommand,
+    installCommand,
+    ...customOptions
   });
 };
 

package/dist/index.mjs

@@ -50,6 +50,20 @@ var shouldUseYarn = () => {
   }
   return true;
 };
+var shouldUsePnpm = () => {
+  const { hasMinPnpm, pnpmVersion } = checkPnpmVersion();
+  if (!hasMinPnpm) {
+    console.log(
+      chalk.yellow(
+        `You are using pnpm version ${chalk.bold(
+          pnpmVersion
+        )} which is not supported yet. To use pnpm, install v5.0.0 or higher. See https://pnpm.js.org for instructions on how to update.`
+      )
+    );
+    return false;
+  }
+  return true;
+};
 var checkThatNpmCanReadCwd = () => {
   const cwd = process.cwd();
   let childOutput = null;
@@ -102,6 +116,24 @@ This is probably caused by a misconfigured system terminal shell.`
   }
   return false;
 };
+var checkPnpmVersion = () => {
+  const minPnpm = "5.0.0";
+  let hasMinPnpm = false;
+  let pnpmVersion = null;
+  try {
+    pnpmVersion = execSync("pnpm --version").toString().trim();
+    if (semver.valid(pnpmVersion)) {
+      hasMinPnpm = semver.gte(pnpmVersion, minPnpm);
+    } else {
+      const trimmedPnpmVersionMatch = /^(.+?)[-+].+$/.exec(pnpmVersion);
+      if (trimmedPnpmVersionMatch) {
+        hasMinPnpm = semver.gte(trimmedPnpmVersionMatch[1], minPnpm);
+      }
+    }
+  } catch (e) {
+  }
+  return { hasMinPnpm, pnpmVersion };
+};
 var checkYarnVersion = () => {
   const minYarnPnp = "1.12.0";
   const maxYarnPnp = "2.0.0";
@@ -477,12 +509,12 @@ var templateLoader = ({
   root,
   templateDir,
   appName,
-  alias,
   verbose,
   mode = "",
   srcDir,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => async ({ path: path4 }) => {
   const flag = mode.includes("append") ? "a+" : "w";
   const file = fs3.readFileSync(`${templateDir}/${path4}`, "utf8");
@@ -491,13 +523,11 @@ var templateLoader = ({
   return writeFile(
     `${root}/${newPath}`,
     newFile({
-      project: alias,
-      projectImport: alias,
-      projectImportPath: alias === "" ? "" : `${alias}/`,
       projectName: appName,
       srcDir: srcDir || ".",
       runCommand,
-      installCommand
+      installCommand,
+      ...customOptions
     }),
     flag,
     verbose
@@ -508,11 +538,11 @@ var fileLoader = ({
   templateDir,
   appName,
   originalDirectory,
-  alias,
   verbose,
   srcDir = DEFAULT_SRC_PATH,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => ({ path: path4 }) => {
   const mode = getModeFromPath(path4);
   const loaders = {
@@ -526,12 +556,12 @@ var fileLoader = ({
     templateDir,
     appName,
     originalDirectory,
-    alias,
     verbose,
     mode,
     srcDir,
     runCommand,
-    installCommand
+    installCommand,
+    ...customOptions
   })({
     path: path4
   });
@@ -541,11 +571,11 @@ var loadFiles = async ({
   templatesOrExtensions = [],
   appName,
   originalDirectory,
-  alias,
   verbose,
   srcDir = DEFAULT_SRC_PATH,
   runCommand,
-  installCommand
+  installCommand,
+  ...customOptions
 }) => {
   for await (const { url: templateOrExtensionUrl } of templatesOrExtensions) {
     const templateDir = await getTemplateDirPath(templateOrExtensionUrl);
@@ -569,11 +599,11 @@ var loadFiles = async ({
           templateDir,
           appName,
           originalDirectory,
-          alias,
           verbose,
           srcDir,
           runCommand,
-          installCommand
+          installCommand,
+          ...customOptions
         })(entry);
       } catch (err) {
         if (verbose) {
@@ -586,7 +616,7 @@ var loadFiles = async ({
 };
 
 // installer.ts
-var install = (root, useYarn = false, dependencies = [], verbose = false, isOnline = true, isDevDependencies = false) => {
+var install = (root, useYarn = false, usePnpm = false, dependencies = [], verbose = false, isOnline = true, isDevDependencies = false) => {
   return new Promise((resolve, reject) => {
     let command;
     let args;
@@ -607,6 +637,15 @@ var install = (root, useYarn = false, dependencies = [], verbose = false, isOnli
         console.log(chalk3.yellow("Falling back to the local Yarn cache."));
         console.log();
       }
+    } else if (usePnpm) {
+      command = "pnpm";
+      args = ["add", "--save"];
+      if (isDevDependencies) {
+        args.push("--save-dev");
+      }
+      args.push(...dependencies);
+      args.push("--cwd");
+      args.push(root);
     } else {
       command = "npm";
       args = ["install", "--loglevel", "error"];
@@ -636,7 +675,6 @@ var runCommandInProjectDir = (root, command, args = [], successMessage = "Operat
     child.on("close", (code) => {
       if (code !== 0) {
         console.log(chalk3.red(errorMessage));
-        reject(new Error(`${command} ${args.join(" ")}`));
         return;
       }
       console.log(chalk3.green(successMessage));
@@ -650,14 +688,14 @@ var run = async ({
   originalDirectory,
   verbose = false,
   useYarn = false,
+  usePnpm = false,
   templatesOrExtensions = [],
   dependencies = [],
   devDependencies = [],
-  alias = "",
   installDependencies = true,
-  srcDir = "",
   runCommand = "",
-  installCommand = ""
+  installCommand = "",
+  ...customOptions
 }) => {
   let isOnline = true;
   if (useYarn) {
@@ -673,33 +711,52 @@ var run = async ({
     console.log();
     process.exit(0);
   }
+  console.log();
+  console.log("Scaffolding project in " + root + "...");
   await loadFiles({
     root,
     templatesOrExtensions,
     appName,
     originalDirectory,
-    alias,
     verbose,
-    srcDir,
     runCommand,
-    installCommand
+    installCommand,
+    ...customOptions
   });
+  console.log();
+  console.log(chalk3.green("Successfully scaffolded project."));
+  console.log();
   if (installDependencies) {
     console.log(
       chalk3.green("Installing packages. This might take a couple of minutes.")
     );
     console.log(chalk3.green("Installing dependencies..."));
     console.log();
-    await install(root, useYarn, dependencies, verbose, isOnline, false);
+    await install(
+      root,
+      useYarn,
+      usePnpm,
+      dependencies,
+      verbose,
+      isOnline,
+      false
+    );
     if (devDependencies.length > 0) {
       console.log();
       console.log(chalk3.green("Installing devDependencies..."));
       console.log();
-      await install(root, useYarn, devDependencies, verbose, isOnline, true);
+      await install(
+        root,
+        useYarn,
+        usePnpm,
+        devDependencies,
+        verbose,
+        isOnline,
+        true
+      );
     }
   } else {
     console.log(chalk3.yellow("Skip package installation."));
-    console.log(chalk3.yellow("Run npm install/yarn in your project."));
     const packageJson = JSON.parse(
       fs4.readFileSync(`${root}/package.json`, "utf8")
     );
@@ -727,17 +784,19 @@ var run = async ({
       path3.join(root, "package.json"),
       JSON.stringify(packageJson, null, 2) + os3.EOL
     );
+    console.log();
+    console.log(chalk3.green("Successfully updated package.json."));
+    console.log(chalk3.yellow(`Run ${chalk3.cyan(installCommand)} to install.`));
   }
-  const gitInitProcess = spawn2("git", ["init"], {
-    cwd: root
-  });
-  gitInitProcess.on("close", (code) => {
-    if (code !== 0) {
-      console.log(chalk3.red("Failed to initialize git repository."));
-      return;
-    }
-    console.log(chalk3.green("Initialized git repository."));
-  });
+  console.log();
+  console.log("Initializing git repository...");
+  await runCommandInProjectDir(
+    root,
+    "git",
+    ["init"],
+    "Successfully initialized git repository.",
+    "Failed to initialize git repository."
+  );
   if (installDependencies && isOnline) {
     const packageJson = JSON.parse(
       fs4.readFileSync(`${root}/package.json`, "utf8")
@@ -764,12 +823,10 @@ var run = async ({
 var createApp = async ({
   name,
   verbose = false,
-  useNpm = false,
   templatesOrExtensions = [],
-  alias = "",
   installDependencies = true,
   ignorePackage = false,
-  srcDir = ""
+  ...customOptions
 }) => {
   const root = path3.resolve(name);
   const appName = path3.basename(root);
@@ -778,14 +835,15 @@ var createApp = async ({
   });
   console.log(`Creating a new Node app in ${chalk3.green(root)}.`);
   console.log();
-  const useYarn = useNpm ? false : shouldUseYarn();
-  const command = useYarn ? "yarn" : "npm run";
+  const useYarn = customOptions.packageManager === "yarn" && shouldUseYarn();
+  const usePnpm = customOptions.packageManager === "pnpm" && shouldUsePnpm();
+  const runCommand = useYarn ? "yarn" : "npm run";
+  const installCommand = useYarn ? "yarn" : usePnpm ? "pnpm install" : "npm install";
   const { packageJson, dependencies, devDependencies } = await loadPackages({
     templatesOrExtensions,
     appName,
-    command,
-    ignorePackage,
-    srcDir
+    runCommand,
+    ignorePackage
   });
   fs4.writeFileSync(
     path3.join(root, "package.json"),
@@ -841,14 +899,14 @@ Please update to npm 3 or higher for a better, fully supported experience.
     originalDirectory,
     verbose,
     useYarn,
+    usePnpm,
     templatesOrExtensions,
     dependencies,
     devDependencies,
-    alias,
     installDependencies,
-    srcDir,
-    runCommand: command,
-    installCommand: useYarn ? "yarn" : "npm install"
+    runCommand,
+    installCommand,
+    ...customOptions
   });
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@create-node-app/core",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",