@ctzy-web-client/create-web-client 1.0.6 → 1.0.8

package/bin/create-web-client.js

@@ -1,169 +1,225 @@
-'use strict';
-
-var fs = require('fs');
-var path = require('path');
-var minimist = require('minimist');
-var prompts = require('prompts');
-var kolorist = require('kolorist');
-var index = require('./utils/index.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
-var minimist__default = /*#__PURE__*/_interopDefaultLegacy(minimist);
-var prompts__default = /*#__PURE__*/_interopDefaultLegacy(prompts);
-
-const argv = minimist__default["default"](process.argv.slice(2), { string: ["_"] });
-const cwd = process.cwd();
-const templates = [
-  {
-    name: "web-base-client-vue",
-    display: "\u5355\u4F53web\u5BA2\u6237\u7AEF\u5E94\u7528(web-client-app)",
-    color: kolorist.yellow
-  },
-  {
-    name: "qiankun-subapp-vue",
-    display: "VUE\u7248\u672C\u5FAE\u524D\u7AEF\u5B50\u9879\u76EE",
-    color: kolorist.blue
-  },
-  {
-    name: "qiankun-vue",
-    display: "\u4E7E\u5764+VUE\u57FA\u5EA7\u9879\u76EE",
-    color: kolorist.green
-  }
-];
-const templateNames = templates.map((f) => f.variants && f.variants.map((v) => v.name) || [f.name]).reduce((a, b) => a.concat(b), []);
-const defaultTargetDir = "web-client-app";
-const renameFiles = {
-  _gitignore: ".gitignore"
-};
-async function init() {
-  const argTargetDir = index.formatTargetDir(argv._[0]);
-  const argTemplate = argv.template || argv.t;
-  let targetDir = argTargetDir || defaultTargetDir;
-  const getProjectName = () => targetDir === "." ? path__default["default"].basename(path__default["default"].resolve()) : targetDir;
-  let result;
-  try {
-    result = await prompts__default["default"](
-      [
-        {
-          type: argTargetDir ? null : "text",
-          name: "projectName",
-          message: kolorist.reset("Project name:"),
-          initial: defaultTargetDir,
-          onState: (state) => {
-            targetDir = index.formatTargetDir(state.value) || defaultTargetDir;
-          }
-        },
-        {
-          type: () => !fs__default["default"].existsSync(targetDir) || index.isEmpty(targetDir) ? null : "confirm",
-          name: "overwrite",
-          message: () => (targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`) + ` is not empty. Remove existing files and continue?`
-        },
-        {
-          type: (_, { overwrite: overwrite2 }) => {
-            if (overwrite2 === false) {
-              throw new Error(kolorist.red("\u2716") + " Operation cancelled");
-            }
-            return null;
-          },
-          name: "overwriteChecker"
-        },
-        {
-          type: () => index.isValidPackageName(getProjectName()) ? null : "text",
-          name: "packageName",
-          message: kolorist.reset("Package name:"),
-          initial: () => index.toValidPackageName(getProjectName()),
-          validate: (dir) => index.isValidPackageName(dir) || "Invalid package.json name"
-        },
-        {
-          type: argTemplate && templateNames.includes(argTemplate) ? null : "select",
-          name: "template",
-          message: typeof argTemplate === "string" && !templateNames.includes(argTemplate) ? kolorist.reset(
-            `"${argTemplate}" isn't a valid template. Please choose from below: `
-          ) : kolorist.reset("Select a template:"),
-          initial: 0,
-          choices: templates.map((template2) => {
-            const color = template2.color;
-            return {
-              title: color(template2.display || template2.name),
-              value: template2
-            };
-          })
-        },
-        {
-          type: (template2) => template2 && template2.variants ? "select" : null,
-          name: "variant",
-          message: kolorist.reset("Select a variant:"),
-          choices: (template2) => template2.variants.map((variant2) => {
-            const variantColor = variant2.color;
-            return {
-              title: variantColor(variant2.display || variant2.name),
-              value: variant2.name
-            };
-          })
-        }
-      ],
-      {
-        onCancel: () => {
-          throw new Error(kolorist.red("\u2716") + " Operation cancelled");
-        }
-      }
-    );
-  } catch (cancelled) {
-    console.log(cancelled.message);
-    return;
-  }
-  const { template, overwrite, packageName, variant } = result;
-  const root = path__default["default"].join(cwd, targetDir);
-  if (overwrite) {
-    index.emptyDir(root);
-  } else if (!fs__default["default"].existsSync(root)) {
-    fs__default["default"].mkdirSync(root, { recursive: true });
-  }
-  const installTemplate = variant || template && template.name || argTemplate;
-  const pkgInfo = index.pkgFromUserAgent(process.env.npm_config_user_agent);
-  const pkgManager = pkgInfo ? pkgInfo.name : "npm";
-  const templateDir = path__default["default"].resolve(
-    __dirname,
-    "../templates",
-    `${installTemplate}-template`
-  );
-  const write = (file, content) => {
-    var _a;
-    const targetPath = path__default["default"].join(root, (_a = renameFiles[file]) != null ? _a : file);
-    if (content) {
-      fs__default["default"].writeFileSync(targetPath, content);
-    } else {
-      index.copy(path__default["default"].join(templateDir, file), targetPath);
-    }
-  };
-  const files = fs__default["default"].readdirSync(templateDir);
-  for (const file of files.filter((f) => f !== "package.json")) {
-    write(file);
-  }
-  const pkg = JSON.parse(
-    fs__default["default"].readFileSync(path__default["default"].join(templateDir, `package.json`), "utf-8")
-  );
-  pkg.name = packageName || getProjectName();
-  write("package.json", JSON.stringify(pkg, null, 2));
-  console.log(`
-Done. Now run:
-`);
-  if (root !== cwd) {
-    console.log(`  cd ${path__default["default"].relative(cwd, root)}`);
-  }
-  switch (pkgManager) {
-    case "yarn":
-      console.log("  yarn");
-      console.log("  yarn dev");
-      break;
-    default:
-      console.log(`  ${pkgManager} install`);
-      console.log(`  ${pkgManager} run dev`);
-      break;
-  }
-  console.log();
-}
-init().catch((e) => console.error(e));
+import fs from 'fs';
+import path from 'path';
+// import { fileURLToPath } from 'url';
+import minimist from 'minimist';
+import prompts from 'prompts';
+import { blue, green, red, reset, yellow } from 'kolorist';
+import {
+  formatTargetDir,
+  copy,
+  isValidPackageName,
+  toValidPackageName,
+  isEmpty,
+  emptyDir,
+  pkgFromUserAgent,
+} from './utils/index.js';
+
+//参数列表
+const argv = minimist(process.argv.slice(2), { string: ['_'] });
+
+//命令行
+const cwd = process.cwd();
+
+//模板列表
+const templates = [
+  {
+    name: 'web-base-client-vue',
+    display: '单体web客户端应用(web-client-app)',
+    color: yellow,
+    //   variants: [
+    //     {
+    //       name: 'vue-app',
+    //       display: 'JavaScript',
+    //       color: yellow
+    //     }
+    //   ]
+  },
+  {
+    name: 'qiankun-subapp-vue',
+    display: 'VUE版本微前端子项目',
+    color: blue,
+  },
+  {
+    name: 'qiankun-vue',
+    display: '乾坤+VUE基座项目',
+    color: green,
+  },
+];
+//模板名称
+const templateNames = templates
+  .map((f) => (f.variants && f.variants.map((v) => v.name)) || [f.name])
+  .reduce((a, b) => a.concat(b), []);
+//默认项目名称
+const defaultTargetDir = 'web-client-app';
+//renameFiles
+const renameFiles = {
+  _gitignore: '.gitignore',
+};
+//初始化
+async function init() {
+  const argTargetDir = formatTargetDir(argv._[0]);
+
+  const argTemplate = argv.template || argv.t;
+
+  let targetDir = argTargetDir || defaultTargetDir;
+
+  //获取项目名称
+  const getProjectName = () =>
+    targetDir === '.' ? path.basename(path.resolve()) : targetDir;
+
+  let result;
+
+  try {
+    result = await prompts(
+      [
+        {
+          type: argTargetDir ? null : 'text',
+          name: 'projectName',
+          message: reset('Project name:'),
+          initial: defaultTargetDir,
+          onState: (state) => {
+            targetDir = formatTargetDir(state.value) || defaultTargetDir;
+          },
+        },
+        {
+          type: () =>
+            !fs.existsSync(targetDir) || isEmpty(targetDir) ? null : 'confirm',
+          name: 'overwrite',
+          message: () =>
+            (targetDir === '.'
+              ? 'Current directory'
+              : `Target directory "${targetDir}"`) +
+            ` is not empty. Remove existing files and continue?`,
+        },
+        {
+          type: (_, { overwrite }) => {
+            if (overwrite === false) {
+              throw new Error(red('✖') + ' Operation cancelled');
+            }
+            return null;
+          },
+          name: 'overwriteChecker',
+        },
+        {
+          type: () => (isValidPackageName(getProjectName()) ? null : 'text'),
+          name: 'packageName',
+          message: reset('Package name:'),
+          initial: () => toValidPackageName(getProjectName()),
+          validate: (dir) =>
+            isValidPackageName(dir) || 'Invalid package.json name',
+        },
+        {
+          type:
+            argTemplate && templateNames.includes(argTemplate)
+              ? null
+              : 'select',
+          name: 'template',
+          message:
+            typeof argTemplate === 'string' &&
+            !templateNames.includes(argTemplate)
+              ? reset(
+                  `"${argTemplate}" isn't a valid template. Please choose from below: `
+                )
+              : reset('Select a template:'),
+          initial: 0,
+          choices: templates.map((template) => {
+            const color = template.color;
+            return {
+              title: color(template.display || template.name),
+              value: template,
+            };
+          }),
+        },
+        {
+          type: (template) => (template && template.variants ? 'select' : null),
+          name: 'variant',
+          message: reset('Select a variant:'),
+          choices: (template) =>
+            template.variants.map((variant) => {
+              const variantColor = variant.color;
+              return {
+                title: variantColor(variant.display || variant.name),
+                value: variant.name,
+              };
+            }),
+        },
+      ],
+      {
+        onCancel: () => {
+          throw new Error(red('✖') + ' Operation cancelled');
+        },
+      }
+    );
+  } catch (cancelled) {
+    console.log(cancelled.message);
+    return;
+  }
+
+  // user choice associated with prompts
+  const { template, overwrite, packageName, variant } = result;
+
+  const root = path.join(cwd, targetDir);
+
+  if (overwrite) {
+    emptyDir(root);
+  } else if (!fs.existsSync(root)) {
+    fs.mkdirSync(root, { recursive: true });
+  }
+
+  // determine template
+  const installTemplate = variant || (template && template.name) || argTemplate;
+
+  const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
+  const pkgManager = pkgInfo ? pkgInfo.name : 'npm';
+
+  // 该提示不输出
+  // console.log(`\nScaffolding project in ${root}...`)
+
+  const templateDir = path.resolve(
+    // fileURLToPath(__dirname),
+    __dirname,
+    '../templates',
+    `${installTemplate}-template`
+  );
+
+  const write = (file, content) => {
+    const targetPath = path.join(root, renameFiles[file] ?? file);
+    if (content) {
+      fs.writeFileSync(targetPath, content);
+    } else {
+      copy(path.join(templateDir, file), targetPath);
+    }
+  };
+
+  const files = fs.readdirSync(templateDir);
+  for (const file of files.filter((f) => f !== 'package.json')) {
+    write(file);
+  }
+
+  const pkg = JSON.parse(
+    fs.readFileSync(path.join(templateDir, `package.json`), 'utf-8')
+  );
+
+  pkg.name = packageName || getProjectName();
+
+  write('package.json', JSON.stringify(pkg, null, 2));
+
+  console.log(`\nDone. Now run:\n`);
+  if (root !== cwd) {
+    console.log(`  cd ${path.relative(cwd, root)}`);
+  }
+  switch (pkgManager) {
+    case 'yarn':
+      console.log('  yarn');
+      console.log('  yarn dev');
+      break;
+    default:
+      console.log(`  ${pkgManager} install`);
+      console.log(`  ${pkgManager} run dev`);
+      break;
+  }
+  console.log();
+}
+
+//初始化
+init().catch((e) => console.error(e));

package/bin/utils/index.js

@@ -1,73 +1,105 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fs = require('fs');
-var path = require('path');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
-
-const formatTargetDir = function formatTargetDir2(targetDir) {
-  return targetDir == null ? void 0 : targetDir.trim().replace(/\/+$/g, "");
-};
-const copy = function copy2(src, dest) {
-  const stat = fs__default["default"].statSync(src);
-  if (stat.isDirectory()) {
-    copyDir(src, dest);
-  } else {
-    fs__default["default"].copyFileSync(src, dest);
-  }
-};
-const isValidPackageName = function isValidPackageName2(projectName) {
-  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
-    projectName
-  );
-};
-const toValidPackageName = function toValidPackageName2(projectName) {
-  return projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z0-9-~]+/g, "-");
-};
-const copyDir = function copyDir2(srcDir, destDir) {
-  fs__default["default"].mkdirSync(destDir, { recursive: true });
-  for (const file of fs__default["default"].readdirSync(srcDir)) {
-    const srcFile = path__default["default"].resolve(srcDir, file);
-    const destFile = path__default["default"].resolve(destDir, file);
-    copy(srcFile, destFile);
-  }
-};
-const isEmpty = function isEmpty2(path2) {
-  const files = fs__default["default"].readdirSync(path2);
-  return files.length === 0 || files.length === 1 && files[0] === ".git";
-};
-const emptyDir = function emptyDir2(dir) {
-  if (!fs__default["default"].existsSync(dir)) {
-    return;
-  }
-  for (const file of fs__default["default"].readdirSync(dir)) {
-    if (file === ".git") {
-      continue;
-    }
-    fs__default["default"].rmSync(path__default["default"].resolve(dir, file), { recursive: true, force: true });
-  }
-};
-const pkgFromUserAgent = function pkgFromUserAgent2(userAgent) {
-  if (!userAgent)
-    return void 0;
-  const pkgSpec = userAgent.split(" ")[0];
-  const pkgSpecArr = pkgSpec.split("/");
-  return {
-    name: pkgSpecArr[0],
-    version: pkgSpecArr[1]
-  };
-};
-
-exports.copy = copy;
-exports.copyDir = copyDir;
-exports.emptyDir = emptyDir;
-exports.formatTargetDir = formatTargetDir;
-exports.isEmpty = isEmpty;
-exports.isValidPackageName = isValidPackageName;
-exports.pkgFromUserAgent = pkgFromUserAgent;
-exports.toValidPackageName = toValidPackageName;
+import fs from 'fs';
+import path from 'path';
+/**
+ * 格式化目标目录
+ * @param {*} targetDir
+ * @returns
+ */
+export const formatTargetDir = function formatTargetDir(targetDir) {
+  return targetDir?.trim().replace(/\/+$/g, '');
+};
+
+/**
+ * 拷贝
+ * @param {*} src
+ * @param {*} dest
+ */
+export const copy = function copy(src, dest) {
+  const stat = fs.statSync(src);
+  if (stat.isDirectory()) {
+    copyDir(src, dest);
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+};
+
+/**
+ * 检测项目名称是否有效
+ * @param {*} projectName
+ * @returns
+ */
+export const isValidPackageName = function isValidPackageName(projectName) {
+  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
+    projectName
+  );
+};
+
+/**
+ * 将项目名称处理成有效的名称
+ * @param {*} projectName
+ * @returns
+ */
+export const toValidPackageName = function toValidPackageName(projectName) {
+  return projectName
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/^[._]/, '')
+    .replace(/[^a-z0-9-~]+/g, '-');
+};
+
+/**
+ * 拷贝目录
+ * @param {*} srcDir
+ * @param {*} destDir
+ */
+export const copyDir = function copyDir(srcDir, destDir) {
+  fs.mkdirSync(destDir, { recursive: true });
+  for (const file of fs.readdirSync(srcDir)) {
+    const srcFile = path.resolve(srcDir, file);
+    const destFile = path.resolve(destDir, file);
+    copy(srcFile, destFile);
+  }
+};
+
+/**
+ * 是否是空目录
+ * @param {*} path
+ * @returns
+ */
+export const isEmpty = function isEmpty(path) {
+  const files = fs.readdirSync(path);
+  return files.length === 0 || (files.length === 1 && files[0] === '.git');
+};
+
+/**
+ * 是否是空目录
+ * @param {*} dir
+ * @returns
+ */
+export const emptyDir = function emptyDir(dir) {
+  if (!fs.existsSync(dir)) {
+    return;
+  }
+  for (const file of fs.readdirSync(dir)) {
+    if (file === '.git') {
+      continue;
+    }
+    fs.rmSync(path.resolve(dir, file), { recursive: true, force: true });
+  }
+};
+
+/**
+ * 更新packagejson
+ * @param {*} userAgent
+ * @returns
+ */
+export const pkgFromUserAgent = function pkgFromUserAgent(userAgent) {
+  if (!userAgent) return undefined;
+  const pkgSpec = userAgent.split(' ')[0];
+  const pkgSpecArr = pkgSpec.split('/');
+  return {
+    name: pkgSpecArr[0],
+    version: pkgSpecArr[1],
+  };
+};