@component-hook/create-app 0.2.4-alpha.1 → 0.2.4-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/index.js

@@ -0,0 +1,234 @@
+// src/index.ts
+import path2 from "node:path";
+import { fileURLToPath } from "node:url";
+import { readdir, readFile, writeFile } from "node:fs/promises";
+import minimist from "minimist";
+import colors2 from "picocolors";
+import { copy, ensureDirSync } from "fs-extra/esm";
+import artTemplate from "art-template";
+import ora from "ora";
+
+// src/prompts.ts
+import { existsSync as existsSync2 } from "node:fs";
+import prompts from "prompts";
+import colors from "picocolors";
+
+// src/utils.ts
+import path from "node:path";
+import { existsSync, readdirSync } from "node:fs";
+import { remove } from "fs-extra/esm";
+
+// src/config.ts
+var DEFAULT_PROJECT_NAME = "basic-project";
+var TEMPLATES = ["vue"];
+
+// src/utils.ts
+function formatTargetDir(targetDir) {
+  if (!targetDir) return targetDir;
+  targetDir = targetDir.trim();
+  if (targetDir[0] === "/") {
+    targetDir = targetDir.slice(1);
+  }
+  if (targetDir.at(-1) === "/") {
+    targetDir = targetDir.slice(0, -1);
+  }
+  return targetDir;
+}
+function getProjectName(targetDir) {
+  if (!targetDir) {
+    return DEFAULT_PROJECT_NAME;
+  }
+  return path.basename(path.resolve(targetDir));
+}
+function isValidPackageName(projectName) {
+  return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(projectName);
+}
+function toValidPackageName(projectName) {
+  return projectName.trim().toLowerCase().replaceAll(/\s+/g, "-").replace(/^[._]/, "").replaceAll(/[^a-z\d\-~]+/g, "-");
+}
+function getPkgManagerInfo() {
+  const userAgent = process.env.npm_config_user_agent;
+  if (!userAgent) return;
+  const [pkgManager] = userAgent.split(" ");
+  const [name, version] = pkgManager.split("/");
+  return { name, version };
+}
+function isEmptyFolder(dir) {
+  const files = readdirSync(dir);
+  return files.length === 0 || files.length === 1 && files[0] === ".git";
+}
+function clearFolder(dir) {
+  if (!existsSync(dir)) return;
+  const files = readdirSync(dir).filter((file) => file !== ".git");
+  return Promise.all(files.map((file) => remove(path.resolve(dir, file))));
+}
+
+// src/prompts.ts
+function builtinTemplate(template) {
+  return template && TEMPLATES.includes(template);
+}
+function onCancel() {
+  throw new Error(`${colors.red("\u2716")} Operation cancelled`);
+}
+function styleTitle(title) {
+  return colors.bold(colors.magenta(title));
+}
+function operationPrompts({ targetDir, template }) {
+  const projectName = {
+    type: targetDir ? null : "text",
+    name: "projectName",
+    message: styleTitle("Project name:"),
+    initial: DEFAULT_PROJECT_NAME
+  };
+  const overwrite = {
+    type: (nameAnswer) => {
+      return existsSync2(nameAnswer) && !isEmptyFolder(nameAnswer) ? "select" : null;
+    },
+    name: "overwrite",
+    message: (nameAnswer) => {
+      const isCurrentDir = nameAnswer === ".";
+      const dir = isCurrentDir ? "current directory" : `Target directory "${targetDir}"`;
+      return styleTitle(`${dir} is not empty. Please choose how to proceed:`);
+    },
+    initial: 0,
+    choices: [
+      { title: "Cancel operation", value: "cancel" },
+      { title: "Remove existing files and continue", value: "overwrite" },
+      { title: "Ignore files and continue", value: "ignore" }
+    ]
+  };
+  const overwriteChecker = {
+    type: (overwriteAnswer) => {
+      if (overwriteAnswer === "cancel") onCancel();
+      return null;
+    },
+    name: "overwriteChecker"
+  };
+  const packageName = {
+    type: (_, { projectName: nameAnswer }) => {
+      return isValidPackageName(getProjectName(nameAnswer)) ? null : "text";
+    },
+    name: "projectName",
+    message: styleTitle("Package name:"),
+    initial: (_, { projectName: nameAnswer }) => toValidPackageName(getProjectName(nameAnswer)),
+    validate: (name) => {
+      return isValidPackageName(name) || "Invalid package.json name";
+    }
+  };
+  const framework = {
+    type: builtinTemplate(template) ? null : "select",
+    name: "framework",
+    message: template ? styleTitle(`${colors.red(template)} isn't a valid template. Please choose from below:`) : styleTitle("Select a framework:"),
+    initial: 0,
+    choices: [
+      { title: colors.green("Vue"), value: "vue" }
+      // { title: 'colors.blue('React'), value: 'react' },
+    ]
+  };
+  return prompts([projectName, overwrite, overwriteChecker, packageName, framework], { onCancel });
+}
+
+// src/index.ts
+var cwd = process.cwd();
+var argv = minimist(process.argv.slice(2), {
+  default: { gitlab: false, help: false },
+  alias: { t: "template", l: "gitlab", h: "help" },
+  string: ["_"]
+});
+var renameFiles = {
+  _gitignore: ".gitignore",
+  "_gitlab-ci.yml": ".gitlab-ci.yml"
+};
+var helpMessage = `
+Usage: create-component-hook [project name] [options]
+
+Create a new project in TypeScript.
+With no arguments, start the CLI in interactive mode.
+
+Options:
+  -t, --template [name]  Choose a framework template
+  -l, --gitlab  Use Gitlab CI/CD, default is Github CI/CD
+  -h, --help  Display this help message
+
+Available templates:
+  ${colors2.green("vue")}
+`;
+async function copyTemplateFolder(root, templateDir, packageName) {
+  const isGitlab = argv.lab || argv.gitlab;
+  const [files, pkgJson] = await Promise.all([
+    readdir(templateDir),
+    readFile(path2.join(templateDir, "package.json"), "utf-8")
+  ]);
+  const filterFiles = files.filter((file) => {
+    const filterCi = isGitlab ? ".github" : ".gitlab";
+    const filterCiYml = isGitlab ? "" : "_gitlab-ci.yml";
+    return file !== "package.json" && file !== filterCi && file !== filterCiYml;
+  });
+  const pkg = JSON.parse(pkgJson);
+  const rewriteOrCopyFile = (file, content) => {
+    const targetPath = path2.join(root, renameFiles?.[file] ?? file);
+    if (content) {
+      return writeFile(targetPath, content);
+    }
+    const templatePath = path2.join(templateDir, file);
+    if (file.endsWith(".art")) {
+      const name = packageName.split("-").map((str) => `${str[0].toUpperCase()}${str.slice(1)}`).join(" ");
+      const renderedResult = artTemplate(templatePath, { projectName: name });
+      return writeFile(targetPath.replace(".art", ""), renderedResult);
+    }
+    return copy(templatePath, targetPath);
+  };
+  pkg.name = packageName;
+  return Promise.all([
+    ...filterFiles.map((file) => rewriteOrCopyFile(file)),
+    rewriteOrCopyFile("package.json", `${JSON.stringify(pkg, null, 2)}
+`),
+    new Promise((resolve) => setTimeout(resolve, 300))
+  ]);
+}
+async function createApp() {
+  const help = argv.h || argv.help;
+  if (help) {
+    console.log(helpMessage);
+    return;
+  }
+  const targetDir = formatTargetDir(argv._[0]);
+  const template = argv.t || argv.template;
+  const result = await operationPrompts({ targetDir, template });
+  const packageName = result.packageName || getProjectName(result.projectName);
+  const framework = result.framework || template;
+  const root = path2.join(cwd, result.projectName);
+  const pkgManagerInfo = getPkgManagerInfo();
+  const pkgManager = pkgManagerInfo?.name ?? "npm";
+  const spinner = ora();
+  console.log();
+  spinner.start(colors2.yellow(`Scaffolding project...`));
+  if (result.overwrite === "overwrite") {
+    await clearFolder(root);
+  } else {
+    ensureDirSync(root);
+  }
+  const templateDir = path2.resolve(fileURLToPath(import.meta.url), "../..", `template-${framework}`);
+  copyTemplateFolder(root, templateDir, packageName).then(() => {
+    const cdProjectName = path2.relative(cwd, root);
+    const formattedCdProjectName = cdProjectName.includes(" ") ? `"${cdProjectName}"` : cdProjectName;
+    spinner.succeed(`${colors2.green("Scaffolded project in")} ${root}`);
+    console.log(`
+${colors2.green("Done. Now run:")}
+`);
+    console.log(colors2.cyan(`  cd ${formattedCdProjectName}`));
+    if (pkgManager === "yarn") {
+      console.log(colors2.cyan(`  yarn`));
+      console.log(colors2.cyan(`  yarn dev`));
+    } else {
+      console.log(colors2.cyan(`  ${pkgManager} install`));
+      console.log(colors2.cyan(`  ${pkgManager} run dev`));
+    }
+    console.log();
+  }).catch(() => {
+    spinner.fail(colors2.red("Failed to scaffold project"));
+  });
+}
+createApp().catch((error) => {
+  console.error(colors2.red(error.message));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@component-hook/create-app",
-  "version": "0.2.4-alpha.1",
+  "version": "0.2.4-alpha.2",
   "description": "Scaffolding a basic typescript project",
   "type": "module",
   "license": "MIT",
@@ -36,12 +36,11 @@
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
     "@types/minimist": "^1.2.5",
-    "@types/prompts": "^2.4.9",
-    "unbuild": "^3.2.0"
+    "@types/prompts": "^2.4.9"
   },
   "scripts": {
-    "dev": "unbuild --stub",
-    "build": "unbuild",
+    "dev": "tsup --watch",
+    "build": "tsup",
     "typecheck": "tsc --noEmit"
   }
 }

package/dist/index.mjs

@@ -1,17 +0,0 @@
-import c from"node:path";import{fileURLToPath as S}from"node:url";import D from"minimist";import a from"picocolors";import{existsSync as j,readdirSync as w,remove as T,ensureDirSync as A,readdir as E,readFile as F,writeFile as b,copy as I}from"fs-extra";import O from"art-template";import U from"ora";import z from"prompts";const $="basic-project",L=["vue"];function x(e){return e&&(e=e.trim(),e[0]==="/"&&(e=e.slice(1)),e.at(-1)==="/"&&(e=e.slice(0,-1)),e)}function y(e){return e?c.basename(c.resolve(e)):$}function P(e){return/^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(e)}function M(e){return e.trim().toLowerCase().replaceAll(/\s+/g,"-").replace(/^[._]/,"").replaceAll(/[^a-z\d\-~]+/g,"-")}function G(){const e=process.env.npm_config_user_agent;if(!e)return;const[t]=e.split(" "),[n,s]=t.split("/");return{name:n,version:s}}function J(e){const t=w(e);return t.length===0||t.length===1&&t[0]===".git"}function R(e){if(!j(e))return;const t=w(e).filter(n=>n!==".git");return Promise.all(t.map(n=>T(c.resolve(e,n))))}function V(e){return e&&L.includes(e)}function k(){throw new Error(`${a.red("\u2716")} Operation cancelled`)}function f(e){return a.bold(a.magenta(e))}function W({targetDir:e,template:t}){const n={type:e?null:"text",name:"projectName",message:f("Project name:"),initial:$},s={type:o=>j(o)&&!J(o)?"select":null,name:"overwrite",message:o=>{const i=o==="."?"current directory":`Target directory "${e}"`;return f(`${i} is not empty. Please choose how to proceed:`)},initial:0,choices:[{title:"Cancel operation",value:"cancel"},{title:"Remove existing files and continue",value:"overwrite"},{title:"Ignore files and continue",value:"ignore"}]},g={type:o=>(o==="cancel"&&k(),null),name:"overwriteChecker"},l={type:(o,{projectName:i})=>P(y(i))?null:"text",name:"projectName",message:f("Package name:"),initial:(o,{projectName:i})=>M(y(i)),validate:o=>P(o)||"Invalid package.json name"},m={type:V(t)?null:"select",name:"framework",message:f(t?`${a.red(t)} isn't a valid template. Please choose from below:`:"Select a framework:"),initial:0,choices:[{title:a.green("Vue"),value:"vue"}]};return z([n,s,g,l,m],{onCancel:k})}const N=process.cwd(),p=D(process.argv.slice(2),{default:{gitlab:!1,help:!1},alias:{t:"template",l:"gitlab",h:"help"},string:["_"]}),q={_gitignore:".gitignore","_gitlab-ci.yml":".gitlab-ci.yml"},B=`
-Usage: create-component-hook [project name] [options]
-
-Create a new project in TypeScript.
-With no arguments, start the CLI in interactive mode.
-
-Options:
-  -t, --template [name]  Choose a framework template
-  -l, --gitlab  Use Gitlab CI/CD, default is Github CI/CD
-  -h, --help  Display this help message
-
-Available templates:
-  ${a.green("vue")}
-`;async function H(e,t,n){const s=p.lab||p.gitlab,[g,l]=await Promise.all([E(t),F(c.join(t,"package.json"),"utf-8")]),m=g.filter(r=>r!=="package.json"&&r!==(s?".github":".gitlab")&&r!==(s?"":"_gitlab-ci.yml")),o=JSON.parse(l),i=(r,u)=>{const d=c.join(e,q?.[r]??r);if(u)return b(d,u);const h=c.join(t,r);if(r.endsWith(".art")){const C=n.split("-").map(v=>`${v[0].toUpperCase()}${v.slice(1)}`).join(" "),_=O(h,{projectName:C});return b(d.replace(".art",""),_)}return I(h,d)};return o.name=n,Promise.all([...m.map(r=>i(r)),i("package.json",`${JSON.stringify(o,null,2)}
-`),new Promise(r=>setTimeout(r,300))])}async function K(){if(p.h||p.help){console.log(B);return}const e=x(p._[0]),t=p.t||p.template,n=await W({targetDir:e,template:t}),s=n.packageName||y(n.projectName),g=n.framework||t,l=c.join(N,n.projectName),m=G()?.name??"npm",o=U();console.log(),o.start(a.yellow("Scaffolding project...")),n.overwrite==="overwrite"?await R(l):A(l);const i=c.resolve(S(import.meta.url),"../..",`template-${g}`);H(l,i,s).then(()=>{const r=c.relative(N,l),u=r.includes(" ")?`"${r}"`:r;o.succeed(`${a.green("Scaffolded project in")} ${l}`),console.log(`
-${a.green("Done. Now run:")}
-`),console.log(a.cyan(`  cd ${u}`)),m==="yarn"?(console.log(a.cyan("  yarn")),console.log(a.cyan("  yarn dev"))):(console.log(a.cyan(`  ${m} install`)),console.log(a.cyan(`  ${m} run dev`))),console.log()}).catch(()=>{o.fail(a.red("Failed to scaffold project"))})}K().catch(e=>{console.error(a.red(e.message))});