@create-node-app/core 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-type Addon = {
+type TemplateOrExtension = {
     url: string;
     ignorePackage?: boolean;
 };
@@ -15,7 +15,7 @@ type CnaOptions = {
     useNpm?: boolean;
     nodeps?: boolean;
     template?: string;
-    addons?: Addon[];
+    templatesOrExtensions?: TemplateOrExtension[];
 };
 type CnaOptionsTransform = (options: CnaOptions) => Promise<CnaOptions>;
 /**
@@ -32,7 +32,7 @@ type CnaOptionsTransform = (options: CnaOptions) => Promise<CnaOptions>;
  * @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
- * @param options.addons - Official extensions to apply
+ * @param options.templatesOrExtensions - Official extensions to apply
  * @param transformOptions - Function to transform the options
  */
 declare const createNodeApp: (programName: string, options: CnaOptions, transformOptions: CnaOptionsTransform) => Promise<void>;

package/dist/index.js

@@ -216,7 +216,6 @@ var import_child_process2 = __toESM(require("child_process"));
 var import_path = __toESM(require("path"));
 var import_util = require("util");
 var import_fs = __toESM(require("fs"));
-var import_download = __toESM(require("download"));
 var import_debug = __toESM(require("debug"));
 var log = (0, import_debug.default)("cna:git");
 var exec = (0, import_util.promisify)(import_child_process2.default.exec);
@@ -232,75 +231,45 @@ var pull = async (cwd) => {
   await exec("git pull", { cwd });
 };
 var downloadRepository = async ({
-  git = "",
-  zip,
+  url = "",
   offline = false,
   target = "./",
   branch = "main",
-  way = "git",
   targetId,
   cacheDir: optsCacheDir
 }) => {
   const absoluteTarget = import_path.default.isAbsolute(target) ? target : import_path.default.resolve(target);
-  const isGithub = /^[^/]+\/[^/]+$/.test(git);
-  const gitUrl = isGithub ? `https://github.com/${git}` : git;
-  const zipUrl = isGithub ? `https://github.com/${git}/archive/${branch}.zip` : zip;
-  const id = targetId || Buffer.from(`${git}@${branch}`).toString("base64");
+  const isGithub = /^[^/]+\/[^/]+$/.test(url);
+  const gitUrl = isGithub ? `https://github.com/${url}` : url;
+  const id = targetId || Buffer.from(`${gitUrl}@${branch}`).toString("base64");
   let cacheDir = optsCacheDir || import_path.default.join(import_os.default.homedir(), ".cache", "cna", id);
   cacheDir = import_path.default.isAbsolute(cacheDir) ? cacheDir : import_path.default.resolve(cacheDir);
   log("cache folder: %s", cacheDir);
-  log("git url: %s", gitUrl);
-  log("zip url: %s", zipUrl);
   const cached = import_fs.default.existsSync(cacheDir);
-  const createByGit = async () => {
-    log("git mode");
-    if (!cached) {
-      if (!gitUrl) {
-        throw new Error(
-          `Expect parameter opts.git when opts.way is 'git', but got ${gitUrl}`
-        );
-      }
-      await clone(gitUrl, cacheDir, branch);
-    }
-    if (offline) {
-      import_fs.default.cpSync(cacheDir, absoluteTarget, {
-        force: true,
-        filter: filterGit,
-        recursive: true
-      });
-      return;
-    }
-    await pull(cacheDir);
-    setTimeout(() => {
-      import_fs.default.cpSync(cacheDir, absoluteTarget, {
-        force: true,
-        filter: filterGit,
-        recursive: true
-      });
-    }, 400);
-  };
-  const createByZip = async () => {
-    log("zip mode");
-    if (!zipUrl) {
-      throw new Error(
-        `Expect parameter opts.zip when opts.way is 'zip', but got ${zipUrl}`
-      );
-    }
-    await (0, import_download.default)(zipUrl, target, { extract: true });
-  };
-  switch (way) {
-    case "git":
-      return createByGit();
-    case "zip":
-      return createByZip();
-    default:
-      throw new Error(`Expect parameter opts.way is 'git' or 'zip'`);
-  }
+  if (!cached) {
+    await clone(gitUrl, cacheDir, branch);
+  }
+  if (offline) {
+    import_fs.default.cpSync(cacheDir, absoluteTarget, {
+      force: true,
+      filter: filterGit,
+      recursive: true
+    });
+    return;
+  }
+  await pull(cacheDir);
+  setTimeout(() => {
+    import_fs.default.cpSync(cacheDir, absoluteTarget, {
+      force: true,
+      filter: filterGit,
+      recursive: true
+    });
+  }, 400);
 };
 
 // paths.ts
-var solveValuesFromAddonUrl = (addon) => {
-  const url = new URL(addon);
+var solveValuesFromTemplateOrExtensionUrl = (templateOrExtension) => {
+  const url = new URL(templateOrExtension);
   const origin = `${url.protocol}//${url.host}`;
   const [org, repo, , branch = "", ...subdir] = url.pathname.slice(1).split("/");
   const ignorePackage = url.searchParams.get("ignorePackage") === "true";
@@ -323,7 +292,7 @@ var solveRepositoryPath = async ({
   const target = import_path2.default.join(import_os2.default.homedir(), ".cna", targetId);
   try {
     await downloadRepository({
-      git: url,
+      url,
       branch,
       target,
       targetId
@@ -332,9 +301,9 @@ var solveRepositoryPath = async ({
   }
   return { dir: target, subdir };
 };
-var solveAddonPath = async (addon) => {
+var solveTemplateOrExtensionPath = async (templateOrExtension) => {
   try {
-    const { url, branch, subdir, protocol, host, pathname, ignorePackage } = solveValuesFromAddonUrl(addon);
+    const { url, branch, subdir, protocol, host, pathname, ignorePackage } = solveValuesFromTemplateOrExtensionUrl(templateOrExtension);
     if (protocol === "file:") {
       return {
         dir: import_path2.default.resolve(host, pathname),
@@ -349,27 +318,36 @@ var solveAddonPath = async (addon) => {
     return { ...gitData, ignorePackage };
   } catch {
     return {
-      dir: import_path2.default.resolve(__dirname, "..", "addons", addon),
+      dir: import_path2.default.resolve(
+        __dirname,
+        "..",
+        "templatesOrExtensions",
+        templateOrExtension
+      ),
       ignorePackage: void 0
     };
   }
 };
-var getAddonPackagePath = async (addon, name = "package", ignorePackage = false) => {
+var getPackagePath = async (templateOrExtension, name = "package", ignorePackage = false) => {
   const {
     dir,
     subdir,
-    ignorePackage: addonIgnorePackage
-  } = await solveAddonPath(addon);
-  if (name === "package.json" && (ignorePackage || addonIgnorePackage)) {
-    throw new Error("package.json should be ignored for file addon");
+    ignorePackage: templateOrExtensionIgnorePackage
+  } = await solveTemplateOrExtensionPath(templateOrExtension);
+  if (name === "package.json" && (ignorePackage || templateOrExtensionIgnorePackage)) {
+    throw new Error(
+      "package.json should be ignored for file templateOrExtension"
+    );
   }
   if (subdir) {
     return import_path2.default.resolve(dir, subdir, name);
   }
   return import_path2.default.resolve(dir, name);
 };
-var getAddonTemplateDirPath = async (addonUrl) => {
-  const { dir, subdir = "" } = await solveAddonPath(addonUrl);
+var getTemplateDirPath = async (templateOrExtensionUrl) => {
+  const { dir, subdir = "" } = await solveTemplateOrExtensionPath(
+    templateOrExtensionUrl
+  );
   let templateDirPath = import_path2.default.resolve(dir, subdir);
   const templateDirPathWithTemplate = import_path2.default.resolve(templateDirPath, "template");
   return new Promise((resolve, reject) => {
@@ -404,37 +382,37 @@ var requireIfExists = (path4) => {
   }
   throw new Error(`file ${path4} not exists`);
 };
-var loadAddonsPackages = async ({
-  addons = [],
+var loadPackages = async ({
+  templatesOrExtensions = [],
   ignorePackage: globalIgnorePackage = false,
   ...config
 }) => {
-  const setup = await addons.reduce(
-    async (setupPromise, { url: addon, ignorePackage }) => {
+  const setup = await templatesOrExtensions.reduce(
+    async (setupPromise, { url: templateOrExtension, ignorePackage }) => {
       let packageJson = await setupPromise;
       try {
         const template = requireIfExists(
-          await getAddonPackagePath(addon, "template.json")
+          await getPackagePath(templateOrExtension, "template.json")
         );
         packageJson = (0, import_lodash.default)(packageJson, template.package || {});
       } catch {
       }
       try {
-        const addonPackageJson = requireIfExists(
-          await getAddonPackagePath(
-            addon,
+        const templateOrExtensionPackageJson = requireIfExists(
+          await getPackagePath(
+            templateOrExtension,
             "package.json",
             globalIgnorePackage || ignorePackage
           )
         );
-        return (0, import_lodash.default)(packageJson, addonPackageJson);
+        return (0, import_lodash.default)(packageJson, templateOrExtensionPackageJson);
       } catch {
       }
       try {
-        const resolveAddonPackage = requireIfExists(
-          await getAddonPackagePath(addon)
+        const resolveTemplateOrExtensionPackage = requireIfExists(
+          await getPackagePath(templateOrExtension)
         );
-        packageJson = resolveAddonPackage(packageJson, config);
+        packageJson = resolveTemplateOrExtensionPackage(packageJson, config);
       } catch {
       }
       return packageJson;
@@ -587,7 +565,7 @@ var fileLoader = ({
 };
 var loadFiles = async ({
   root,
-  addons = [],
+  templatesOrExtensions = [],
   appName,
   originalDirectory,
   alias,
@@ -596,8 +574,8 @@ var loadFiles = async ({
   runCommand,
   installCommand
 }) => {
-  for await (const { url: addonUrl } of addons) {
-    const templateDir = await getAddonTemplateDirPath(addonUrl);
+  for await (const { url: templateOrExtensionUrl } of templatesOrExtensions) {
+    const templateDir = await getTemplateDirPath(templateOrExtensionUrl);
     if (!import_fs4.default.statSync(templateDir).isDirectory()) {
       continue;
     }
@@ -699,7 +677,7 @@ var run = async ({
   originalDirectory,
   verbose = false,
   useYarn = false,
-  addons = [],
+  templatesOrExtensions = [],
   dependencies = [],
   devDependencies = [],
   alias = "",
@@ -712,15 +690,19 @@ var run = async ({
   if (useYarn) {
     isOnline = await checkIfOnline(useYarn);
   }
-  if (import_underscore2.default.isEmpty(addons)) {
+  if (import_underscore2.default.isEmpty(templatesOrExtensions)) {
     console.log();
-    console.log(import_chalk3.default.yellow("No addons specified to bootstrap application."));
+    console.log(
+      import_chalk3.default.yellow(
+        "No templatesOrExtensions specified to bootstrap application."
+      )
+    );
     console.log();
     process.exit(0);
   }
   await loadFiles({
     root,
-    addons,
+    templatesOrExtensions,
     appName,
     originalDirectory,
     alias,
@@ -810,7 +792,7 @@ var createApp = async ({
   name,
   verbose = false,
   useNpm = false,
-  addons = [],
+  templatesOrExtensions = [],
   alias = "",
   installDependencies = true,
   ignorePackage = false,
@@ -825,8 +807,8 @@ var createApp = async ({
   console.log();
   const useYarn = useNpm ? false : shouldUseYarn();
   const command = useYarn ? "yarn" : "npm run";
-  const { packageJson, dependencies, devDependencies } = await loadAddonsPackages({
-    addons,
+  const { packageJson, dependencies, devDependencies } = await loadPackages({
+    templatesOrExtensions,
     appName,
     command,
     ignorePackage,
@@ -886,7 +868,7 @@ Please update to npm 3 or higher for a better, fully supported experience.
     originalDirectory,
     verbose,
     useYarn,
-    addons,
+    templatesOrExtensions,
     dependencies,
     devDependencies,
     alias,

package/dist/index.mjs

@@ -188,7 +188,6 @@ import childProcess from "child_process";
 import path from "path";
 import { promisify } from "util";
 import fs from "fs";
-import download from "download";
 import debug from "debug";
 var log = debug("cna:git");
 var exec = promisify(childProcess.exec);
@@ -204,75 +203,45 @@ var pull = async (cwd) => {
   await exec("git pull", { cwd });
 };
 var downloadRepository = async ({
-  git = "",
-  zip,
+  url = "",
   offline = false,
   target = "./",
   branch = "main",
-  way = "git",
   targetId,
   cacheDir: optsCacheDir
 }) => {
   const absoluteTarget = path.isAbsolute(target) ? target : path.resolve(target);
-  const isGithub = /^[^/]+\/[^/]+$/.test(git);
-  const gitUrl = isGithub ? `https://github.com/${git}` : git;
-  const zipUrl = isGithub ? `https://github.com/${git}/archive/${branch}.zip` : zip;
-  const id = targetId || Buffer.from(`${git}@${branch}`).toString("base64");
+  const isGithub = /^[^/]+\/[^/]+$/.test(url);
+  const gitUrl = isGithub ? `https://github.com/${url}` : url;
+  const id = targetId || Buffer.from(`${gitUrl}@${branch}`).toString("base64");
   let cacheDir = optsCacheDir || path.join(os.homedir(), ".cache", "cna", id);
   cacheDir = path.isAbsolute(cacheDir) ? cacheDir : path.resolve(cacheDir);
   log("cache folder: %s", cacheDir);
-  log("git url: %s", gitUrl);
-  log("zip url: %s", zipUrl);
   const cached = fs.existsSync(cacheDir);
-  const createByGit = async () => {
-    log("git mode");
-    if (!cached) {
-      if (!gitUrl) {
-        throw new Error(
-          `Expect parameter opts.git when opts.way is 'git', but got ${gitUrl}`
-        );
-      }
-      await clone(gitUrl, cacheDir, branch);
-    }
-    if (offline) {
-      fs.cpSync(cacheDir, absoluteTarget, {
-        force: true,
-        filter: filterGit,
-        recursive: true
-      });
-      return;
-    }
-    await pull(cacheDir);
-    setTimeout(() => {
-      fs.cpSync(cacheDir, absoluteTarget, {
-        force: true,
-        filter: filterGit,
-        recursive: true
-      });
-    }, 400);
-  };
-  const createByZip = async () => {
-    log("zip mode");
-    if (!zipUrl) {
-      throw new Error(
-        `Expect parameter opts.zip when opts.way is 'zip', but got ${zipUrl}`
-      );
-    }
-    await download(zipUrl, target, { extract: true });
-  };
-  switch (way) {
-    case "git":
-      return createByGit();
-    case "zip":
-      return createByZip();
-    default:
-      throw new Error(`Expect parameter opts.way is 'git' or 'zip'`);
-  }
+  if (!cached) {
+    await clone(gitUrl, cacheDir, branch);
+  }
+  if (offline) {
+    fs.cpSync(cacheDir, absoluteTarget, {
+      force: true,
+      filter: filterGit,
+      recursive: true
+    });
+    return;
+  }
+  await pull(cacheDir);
+  setTimeout(() => {
+    fs.cpSync(cacheDir, absoluteTarget, {
+      force: true,
+      filter: filterGit,
+      recursive: true
+    });
+  }, 400);
 };
 
 // paths.ts
-var solveValuesFromAddonUrl = (addon) => {
-  const url = new URL(addon);
+var solveValuesFromTemplateOrExtensionUrl = (templateOrExtension) => {
+  const url = new URL(templateOrExtension);
   const origin = `${url.protocol}//${url.host}`;
   const [org, repo, , branch = "", ...subdir] = url.pathname.slice(1).split("/");
   const ignorePackage = url.searchParams.get("ignorePackage") === "true";
@@ -295,7 +264,7 @@ var solveRepositoryPath = async ({
   const target = path2.join(os2.homedir(), ".cna", targetId);
   try {
     await downloadRepository({
-      git: url,
+      url,
       branch,
       target,
       targetId
@@ -304,9 +273,9 @@ var solveRepositoryPath = async ({
   }
   return { dir: target, subdir };
 };
-var solveAddonPath = async (addon) => {
+var solveTemplateOrExtensionPath = async (templateOrExtension) => {
   try {
-    const { url, branch, subdir, protocol, host, pathname, ignorePackage } = solveValuesFromAddonUrl(addon);
+    const { url, branch, subdir, protocol, host, pathname, ignorePackage } = solveValuesFromTemplateOrExtensionUrl(templateOrExtension);
     if (protocol === "file:") {
       return {
         dir: path2.resolve(host, pathname),
@@ -321,27 +290,36 @@ var solveAddonPath = async (addon) => {
     return { ...gitData, ignorePackage };
   } catch {
     return {
-      dir: path2.resolve(__dirname, "..", "addons", addon),
+      dir: path2.resolve(
+        __dirname,
+        "..",
+        "templatesOrExtensions",
+        templateOrExtension
+      ),
       ignorePackage: void 0
     };
   }
 };
-var getAddonPackagePath = async (addon, name = "package", ignorePackage = false) => {
+var getPackagePath = async (templateOrExtension, name = "package", ignorePackage = false) => {
   const {
     dir,
     subdir,
-    ignorePackage: addonIgnorePackage
-  } = await solveAddonPath(addon);
-  if (name === "package.json" && (ignorePackage || addonIgnorePackage)) {
-    throw new Error("package.json should be ignored for file addon");
+    ignorePackage: templateOrExtensionIgnorePackage
+  } = await solveTemplateOrExtensionPath(templateOrExtension);
+  if (name === "package.json" && (ignorePackage || templateOrExtensionIgnorePackage)) {
+    throw new Error(
+      "package.json should be ignored for file templateOrExtension"
+    );
   }
   if (subdir) {
     return path2.resolve(dir, subdir, name);
   }
   return path2.resolve(dir, name);
 };
-var getAddonTemplateDirPath = async (addonUrl) => {
-  const { dir, subdir = "" } = await solveAddonPath(addonUrl);
+var getTemplateDirPath = async (templateOrExtensionUrl) => {
+  const { dir, subdir = "" } = await solveTemplateOrExtensionPath(
+    templateOrExtensionUrl
+  );
   let templateDirPath = path2.resolve(dir, subdir);
   const templateDirPathWithTemplate = path2.resolve(templateDirPath, "template");
   return new Promise((resolve, reject) => {
@@ -376,37 +354,37 @@ var requireIfExists = (path4) => {
   }
   throw new Error(`file ${path4} not exists`);
 };
-var loadAddonsPackages = async ({
-  addons = [],
+var loadPackages = async ({
+  templatesOrExtensions = [],
   ignorePackage: globalIgnorePackage = false,
   ...config
 }) => {
-  const setup = await addons.reduce(
-    async (setupPromise, { url: addon, ignorePackage }) => {
+  const setup = await templatesOrExtensions.reduce(
+    async (setupPromise, { url: templateOrExtension, ignorePackage }) => {
       let packageJson = await setupPromise;
       try {
         const template = requireIfExists(
-          await getAddonPackagePath(addon, "template.json")
+          await getPackagePath(templateOrExtension, "template.json")
         );
         packageJson = merge(packageJson, template.package || {});
       } catch {
       }
       try {
-        const addonPackageJson = requireIfExists(
-          await getAddonPackagePath(
-            addon,
+        const templateOrExtensionPackageJson = requireIfExists(
+          await getPackagePath(
+            templateOrExtension,
             "package.json",
             globalIgnorePackage || ignorePackage
           )
         );
-        return merge(packageJson, addonPackageJson);
+        return merge(packageJson, templateOrExtensionPackageJson);
       } catch {
       }
       try {
-        const resolveAddonPackage = requireIfExists(
-          await getAddonPackagePath(addon)
+        const resolveTemplateOrExtensionPackage = requireIfExists(
+          await getPackagePath(templateOrExtension)
         );
-        packageJson = resolveAddonPackage(packageJson, config);
+        packageJson = resolveTemplateOrExtensionPackage(packageJson, config);
       } catch {
       }
       return packageJson;
@@ -559,7 +537,7 @@ var fileLoader = ({
 };
 var loadFiles = async ({
   root,
-  addons = [],
+  templatesOrExtensions = [],
   appName,
   originalDirectory,
   alias,
@@ -568,8 +546,8 @@ var loadFiles = async ({
   runCommand,
   installCommand
 }) => {
-  for await (const { url: addonUrl } of addons) {
-    const templateDir = await getAddonTemplateDirPath(addonUrl);
+  for await (const { url: templateOrExtensionUrl } of templatesOrExtensions) {
+    const templateDir = await getTemplateDirPath(templateOrExtensionUrl);
     if (!fs3.statSync(templateDir).isDirectory()) {
       continue;
     }
@@ -671,7 +649,7 @@ var run = async ({
   originalDirectory,
   verbose = false,
   useYarn = false,
-  addons = [],
+  templatesOrExtensions = [],
   dependencies = [],
   devDependencies = [],
   alias = "",
@@ -684,15 +662,19 @@ var run = async ({
   if (useYarn) {
     isOnline = await checkIfOnline(useYarn);
   }
-  if (_2.isEmpty(addons)) {
+  if (_2.isEmpty(templatesOrExtensions)) {
     console.log();
-    console.log(chalk3.yellow("No addons specified to bootstrap application."));
+    console.log(
+      chalk3.yellow(
+        "No templatesOrExtensions specified to bootstrap application."
+      )
+    );
     console.log();
     process.exit(0);
   }
   await loadFiles({
     root,
-    addons,
+    templatesOrExtensions,
     appName,
     originalDirectory,
     alias,
@@ -782,7 +764,7 @@ var createApp = async ({
   name,
   verbose = false,
   useNpm = false,
-  addons = [],
+  templatesOrExtensions = [],
   alias = "",
   installDependencies = true,
   ignorePackage = false,
@@ -797,8 +779,8 @@ var createApp = async ({
   console.log();
   const useYarn = useNpm ? false : shouldUseYarn();
   const command = useYarn ? "yarn" : "npm run";
-  const { packageJson, dependencies, devDependencies } = await loadAddonsPackages({
-    addons,
+  const { packageJson, dependencies, devDependencies } = await loadPackages({
+    templatesOrExtensions,
     appName,
     command,
     ignorePackage,
@@ -858,7 +840,7 @@ Please update to npm 3 or higher for a better, fully supported experience.
     originalDirectory,
     verbose,
     useYarn,
-    addons,
+    templatesOrExtensions,
     dependencies,
     devDependencies,
     alias,

package/package.json

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