@tmsfe/tmskit 0.0.6 → 0.0.7

package/src/index.js

@@ -1,62 +1,62 @@
-const chalk = require('chalk');
-const commander = require('commander');
-const { log, suggestCommands } = require('./utils/widgets');
-const { TMS_NAME } = require('./config/constant.js');
-const commands = require('./entry');
-const init = require('./init');
-
-init();
-
-const program = new commander.Command(TMS_NAME);
-
-program
-  .version(`${TMS_NAME} ${require('../package.json').version}`, '-v, -V, --version');
-
-function registerCommand(program, commands) {
-  commands.forEach((cmd) => {
-    if (cmd.type === 'child') {
-      const childProgram = new commander.Command(cmd.name);
-      cmd.usage && childProgram.usage(cmd.usage);
-      cmd.description && childProgram.description(cmd.description);
-      registerCommand(childProgram, cmd.commands);
-
-      program.addCommand(childProgram);
-    } else {
-      const command = program.command(cmd.command);
-
-      cmd.usage && command.usage(cmd.usage);
-
-      cmd.description && command.description(cmd.description);
-
-      cmd.options?.forEach(opt => command.option(...opt));
-
-      command.action(cmd.action);
-    }
-  });
-}
-
-registerCommand(program, commands);
-
-program.on('--help', () => {
-  log();
-  log(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
-  log();
-});
-
-// 捕获未注册的命令
-program
-  .arguments('<command>')
-  .action((cmd) => {
-    program.outputHelp();
-    log(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
-    log();
-    suggestCommands(cmd);
-    process.exitCode = 1;
-  });
-
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-  process.exit(-1);
-}
-
-program.parse(process.argv);
+const chalk = require('chalk');
+const commander = require('commander');
+const { log, suggestCommands } = require('./utils/widgets');
+const { TMS_NAME } = require('./config/constant.js');
+const commands = require('./entry');
+const init = require('./init');
+
+init();
+
+const program = new commander.Command(TMS_NAME);
+
+program
+  .version(`${TMS_NAME} ${require('../package.json').version}`, '-v, -V, --version');
+
+function registerCommand(program, commands) {
+  commands.forEach((cmd) => {
+    if (cmd.type === 'child') {
+      const childProgram = new commander.Command(cmd.name);
+      cmd.usage && childProgram.usage(cmd.usage);
+      cmd.description && childProgram.description(cmd.description);
+      registerCommand(childProgram, cmd.commands);
+
+      program.addCommand(childProgram);
+    } else {
+      const command = program.command(cmd.command);
+
+      cmd.usage && command.usage(cmd.usage);
+
+      cmd.description && command.description(cmd.description);
+
+      cmd.options?.forEach(opt => command.option(...opt));
+
+      command.action(cmd.action);
+    }
+  });
+}
+
+registerCommand(program, commands);
+
+program.on('--help', () => {
+  log();
+  log(`  Run ${chalk.cyan(`${TMS_NAME}  <command> --help`)} for detailed usage of given command.`);
+  log();
+});
+
+// 捕获未注册的命令
+program
+  .arguments('<command>')
+  .action((cmd) => {
+    program.outputHelp();
+    log(`  ${chalk.red(`Unknown command ${chalk.yellow(cmd)}.`)}`);
+    log();
+    suggestCommands(cmd);
+    process.exitCode = 1;
+  });
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+  process.exit(-1);
+}
+
+program.parse(process.argv);

package/src/init.js

@@ -1,33 +1,33 @@
-const semver = require('semver');
-const packageJson = require('../package.json');
-const chalk = require('chalk');
-const { log } = require('./utils/widgets');
-
-const requiredVersion = packageJson.engines.node;
-const packName = packageJson.name;
-
-/**
- * 检查node版本
- * @param {String} wanted 希望的node版本
- * @param {String} id 某node特性
- * @returns {Undefined} 无需返回值
- */
-const checkNodeVersion = (wanted, id) => {
-  if (!semver.satisfies(process.version, wanted, { includePrerelease: true })) {
-    log(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
-    } 需要的Node最小版本 ${wanted}.\n请先升级你的Node版本.`));
-    process.exit(1);
-  }
-};
-
-/**
- * 检查运行环境
- * @returns {Undefined} 无需返回值
- */
-function initCliContext() {
-  // 执行操作前检查node版本
-  // 旧版本node直接提示升级，退出脚本
-  checkNodeVersion(requiredVersion, packName);
-}
-
-module.exports = initCliContext;
+const semver = require('semver');
+const packageJson = require('../package.json');
+const chalk = require('chalk');
+const { log } = require('./utils/widgets');
+
+const requiredVersion = packageJson.engines.node;
+const packName = packageJson.name;
+
+/**
+ * 检查node版本
+ * @param {String} wanted 希望的node版本
+ * @param {String} id 某node特性
+ * @returns {Undefined} 无需返回值
+ */
+const checkNodeVersion = (wanted, id) => {
+  if (!semver.satisfies(process.version, wanted, { includePrerelease: true })) {
+    log(chalk.red(`你正在使用的Node版本： ${process.version}, 但是此版本的 ${id
+    } 需要的Node最小版本 ${wanted}.\n请先升级你的Node版本.`));
+    process.exit(1);
+  }
+};
+
+/**
+ * 检查运行环境
+ * @returns {Undefined} 无需返回值
+ */
+function initCliContext() {
+  // 执行操作前检查node版本
+  // 旧版本node直接提示升级，退出脚本
+  checkNodeVersion(requiredVersion, packName);
+}
+
+module.exports = initCliContext;

package/src/scripts/create/ask.js

@@ -1,63 +1,63 @@
-const fs = require('fs');
-const inquirer = require('inquirer');
-const { resolve } = require('../../utils/widgets');
-const { TEMPLATE_TKIT_DIR } = require('../../config/constant');
-/**
- * 获取模板内的问题
- * @param {string} dir questions.json所在的目录
- * @returns {Array} inquirer 问题数组
- */
-const parseTemplateQuestions = (dir) => {
-  let prompts = [];
-  if (!fs.existsSync(`${dir}/questions.json`)) {
-    return prompts;
-  }
-  try {
-    const json = JSON.parse(fs.readFileSync(`${dir}/questions.json`));
-    if (Array.isArray(json) && json.length > 0) {
-      json.forEach((item, index) => {
-        if (!isQuestionType(item)) {
-          throw new Error(`第 ${index} 个问题不符合"inquirer"的格式要求`);
-        }
-      });
-    } else {
-      throw new Error('问题文件只能是数组');
-    }
-    prompts = json;
-  } catch (err) {
-    throw new Error(`模板异常，${err.message}`);
-  }
-  return prompts;
-};
-const isQuestionType = (result) => {
-  if (!('message' in result)) {
-    return false;
-  }
-  if (!('name' in result)) {
-    return false;
-  }
-  return true;
-};
-
-const ask = templateDir => (files, metalsmith, next) => {
-  const prompts = parseTemplateQuestions(resolve(templateDir, TEMPLATE_TKIT_DIR));
-  const metadata = metalsmith.metadata();
-  const filteredPrompts = prompts.filter((prompt) => {
-    if (metadata[prompt.name] && `${metadata[prompt.name]}`.trim() !== '') {
-      return false;
-    }
-    return true;
-  });
-  inquirer.prompt(filteredPrompts)
-    .then((res) => {
-      for (const prompt of filteredPrompts) {
-        metadata[prompt.name] = res[prompt.name];
-      }
-      next();
-    })
-    .catch((err) => {
-      next(err);
-    });
-};
-
-module.exports = ask;
+const fs = require('fs');
+const inquirer = require('inquirer');
+const { resolve } = require('../../utils/widgets');
+const { TEMPLATE_TKIT_DIR } = require('../../config/constant');
+/**
+ * 获取模板内的问题
+ * @param {string} dir questions.json所在的目录
+ * @returns {Array} inquirer 问题数组
+ */
+const parseTemplateQuestions = (dir) => {
+  let prompts = [];
+  if (!fs.existsSync(`${dir}/questions.json`)) {
+    return prompts;
+  }
+  try {
+    const json = JSON.parse(fs.readFileSync(`${dir}/questions.json`));
+    if (Array.isArray(json) && json.length > 0) {
+      json.forEach((item, index) => {
+        if (!isQuestionType(item)) {
+          throw new Error(`第 ${index} 个问题不符合"inquirer"的格式要求`);
+        }
+      });
+    } else {
+      throw new Error('问题文件只能是数组');
+    }
+    prompts = json;
+  } catch (err) {
+    throw new Error(`模板异常，${err.message}`);
+  }
+  return prompts;
+};
+const isQuestionType = (result) => {
+  if (!('message' in result)) {
+    return false;
+  }
+  if (!('name' in result)) {
+    return false;
+  }
+  return true;
+};
+
+const ask = templateDir => (files, metalsmith, next) => {
+  const prompts = parseTemplateQuestions(resolve(templateDir, TEMPLATE_TKIT_DIR));
+  const metadata = metalsmith.metadata();
+  const filteredPrompts = prompts.filter((prompt) => {
+    if (metadata[prompt.name] && `${metadata[prompt.name]}`.trim() !== '') {
+      return false;
+    }
+    return true;
+  });
+  inquirer.prompt(filteredPrompts)
+    .then((res) => {
+      for (const prompt of filteredPrompts) {
+        metadata[prompt.name] = res[prompt.name];
+      }
+      next();
+    })
+    .catch((err) => {
+      next(err);
+    });
+};
+
+module.exports = ask;

package/src/scripts/create/generator.js

@@ -1,25 +1,25 @@
-const Metalsmith = require('metalsmith');
-const render = require('./render');
-const ask = require('./ask');
-const FILES_TO_IGNORE = require('./ignoreFiles');
-
-
-const generator = (buildDir, distDir, preMetadata) => new Promise((resolve, reject) => {
-  Metalsmith(buildDir)
-    .metadata(preMetadata)
-    .ignore(FILES_TO_IGNORE)
-    .clean(false)
-    .use(ask(buildDir))
-    .source('./')
-    .destination(distDir)
-    .use(render)
-    .build((err) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve('finish');
-      }
-    });
-});
-
-module.exports = generator;
+const Metalsmith = require('metalsmith');
+const render = require('./render');
+const ask = require('./ask');
+const FILES_TO_IGNORE = require('./ignoreFiles');
+
+
+const generator = (buildDir, distDir, preMetadata) => new Promise((resolve, reject) => {
+  Metalsmith(buildDir)
+    .metadata(preMetadata)
+    .ignore(FILES_TO_IGNORE)
+    .clean(false)
+    .use(ask(buildDir))
+    .source('./')
+    .destination(distDir)
+    .use(render)
+    .build((err) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve('finish');
+      }
+    });
+});
+
+module.exports = generator;

package/src/scripts/create/ignoreFiles.js

@@ -1,7 +1,7 @@
-
-// 在metal smith遍历时需要忽略的文件，这些文件会引起metalsmith的parse error
-const FILES_TO_IGNORE = [
-  'node_modules',
-];
-
-module.exports = FILES_TO_IGNORE;
+
+// 在metal smith遍历时需要忽略的文件，这些文件会引起metalsmith的parse error
+const FILES_TO_IGNORE = [
+  'node_modules',
+];
+
+module.exports = FILES_TO_IGNORE;

package/src/scripts/create/index.js

@@ -1,72 +1,72 @@
-const path = require('path');
-const fs = require('fs');
-const shelljs = require('shelljs');
-const { TEMPLATE_DIR, TEMPLATE_PATH, TEMPLATE_TKIT_DIR } = require('../../config/constant.js');
-const { downloadRepoForGit, createTask, resolve } = require('../../utils/widgets');
-const io = require('../../utils/io');
-const { fail, succeed } = require('../../utils/log');
-const generator = require('./generator');
-
-/**
- * 如果该目录下面存在文件，换个名字
- * @param { string } targetDir 当前文件夹
- * @returns { undefined }
- */
-async function createAppDir(targetDir) {
-  // 如果目录非空或者已经存在，提示用户，做选择
-  if (fs.existsSync(targetDir)) {
-    if (!await io.isDirEmpty(targetDir)) {
-      fail('该目录名已经存在，换个项目名字吧~');
-      process.exit(1);
-    }
-  } else {
-    shelljs.mkdir('-p', targetDir);
-  }
-}
-
-/**
- * 创建本地小程序运行环境
- * @param { string } appType 项目类型
- * @param { string } appName 项目名称
- */
-async function create(appName) {
-  const cwd = process.cwd();
-  const targetDir = path.resolve(cwd, appName);
-  const appType = 'mp';
-  await createAppDir(targetDir);
-
-  // 创建缓存目录
-  io.ensureDirExist(TEMPLATE_DIR);
-  // 拉取git模板
-  await createTask(downloadRepoForGit, '拉取模板仓库', '拉取模板仓库完成')(
-    'https://git.woa.com/tmsfe/tms-frontend.git',
-    TEMPLATE_DIR,
-    'master',
-  );
-
-  // 生成模板(1. 询问问题， 2. ejs生成模板  3.生成到目标目录)
-  generator(path.join(TEMPLATE_PATH, appType), targetDir, {
-    appName,
-    appType,
-  }).then(() => {
-    shelljs.cd(appName);
-    const hooks = require(resolve(appName, TEMPLATE_TKIT_DIR, 'hooks.js'));
-    if (hooks.afterCreate) {
-      hooks.afterCreate.forEach((item) => {
-        if (typeof item === 'function') {
-          item.call(null, shelljs, { appName });
-        } else {
-          shelljs.exec(item);
-        }
-      });
-    }
-    shelljs.rm('-rf', resolve(appName, TEMPLATE_TKIT_DIR));
-    succeed('项目创建完成.');
-  })
-    .catch((err) => {
-      fail(err.message);
-      console.log('详细的错误信息:', err);
-    });
-}
-
-module.exports = create;
+const path = require('path');
+const fs = require('fs');
+const shelljs = require('shelljs');
+const { TEMPLATE_DIR, TEMPLATE_PATH, TEMPLATE_TKIT_DIR } = require('../../config/constant.js');
+const { downloadRepoForGit, createTask, resolve } = require('../../utils/widgets');
+const io = require('../../utils/io');
+const { fail, succeed } = require('../../utils/log');
+const generator = require('./generator');
+
+/**
+ * 如果该目录下面存在文件，换个名字
+ * @param { string } targetDir 当前文件夹
+ * @returns { undefined }
+ */
+async function createAppDir(targetDir) {
+  // 如果目录非空或者已经存在，提示用户，做选择
+  if (fs.existsSync(targetDir)) {
+    if (!await io.isDirEmpty(targetDir)) {
+      fail('该目录名已经存在，换个项目名字吧~');
+      process.exit(1);
+    }
+  } else {
+    shelljs.mkdir('-p', targetDir);
+  }
+}
+
+/**
+ * 创建本地小程序运行环境
+ * @param { string } appType 项目类型
+ * @param { string } appName 项目名称
+ */
+async function create(appName) {
+  const cwd = process.cwd();
+  const targetDir = path.resolve(cwd, appName);
+  const appType = 'mp';
+  await createAppDir(targetDir);
+
+  // 创建缓存目录
+  io.ensureDirExist(TEMPLATE_DIR);
+  // 拉取git模板
+  await createTask(downloadRepoForGit, '拉取模板仓库', '拉取模板仓库完成')(
+    'https://git.woa.com/tmsfe/tms-frontend.git',
+    TEMPLATE_DIR,
+    'master',
+  );
+
+  // 生成模板(1. 询问问题， 2. ejs生成模板  3.生成到目标目录)
+  generator(path.join(TEMPLATE_PATH, appType), targetDir, {
+    appName,
+    appType,
+  }).then(() => {
+    shelljs.cd(appName);
+    const hooks = require(resolve(appName, TEMPLATE_TKIT_DIR, 'hooks.js'));
+    if (hooks.afterCreate) {
+      hooks.afterCreate.forEach((item) => {
+        if (typeof item === 'function') {
+          item.call(null, shelljs, { appName });
+        } else {
+          shelljs.exec(item);
+        }
+      });
+    }
+    shelljs.rm('-rf', resolve(appName, TEMPLATE_TKIT_DIR));
+    succeed('项目创建完成.');
+  })
+    .catch((err) => {
+      fail(err.message);
+      console.log('详细的错误信息:', err);
+    });
+}
+
+module.exports = create;

package/src/scripts/create/render.js

@@ -1,19 +1,19 @@
-
-const async = require('async');
-const ejs = require('ejs');
-
-const render = (files, metalsmith, next) => {
-  const keys = Object.keys(files);
-  const metadata = metalsmith.metadata();
-  const run = (file, next) => {
-    const str = files[file].contents.toString();
-    const newStr = ejs.render(str, metadata);
-    // eslint-disable-next-line
-    files[file].contents = Buffer.from(newStr);
-    next();
-  };
-
-  async.each(keys, run, next);
-};
-
-module.exports = render;
+
+const async = require('async');
+const ejs = require('ejs');
+
+const render = (files, metalsmith, next) => {
+  const keys = Object.keys(files);
+  const metadata = metalsmith.metadata();
+  const run = (file, next) => {
+    const str = files[file].contents.toString();
+    const newStr = ejs.render(str, metadata);
+    // eslint-disable-next-line
+    files[file].contents = Buffer.from(newStr);
+    next();
+  };
+
+  async.each(keys, run, next);
+};
+
+module.exports = render;

package/src/scripts/run/build/index.js

@@ -1,17 +1,17 @@
-const shelljs = require('shelljs');
-const { resolve } = require('../../../utils/widgets');
-const init = require('../init/index');
-const gulpBuild = require('../../../gulp/build');
-
-async function build(tmsConfig, targetModules, env) {
-  // 开始构建前，清理输出目录
-  await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
-
-  const isDev = false;
-  const { targetModules: newModules } = await init(tmsConfig, targetModules, isDev);
-
-  gulpBuild(tmsConfig, newModules, env);
-}
-
-module.exports = build;
-
+const shelljs = require('shelljs');
+const { resolve } = require('../../../utils/widgets');
+const init = require('../init/index');
+const gulpBuild = require('../../../gulp/build');
+
+async function build(tmsConfig, targetModules, env) {
+  // 开始构建前，清理输出目录
+  await shelljs.rm('-rf', resolve(tmsConfig.outputDir));
+
+  const isDev = false;
+  const { targetModules: newModules } = await init(tmsConfig, targetModules, isDev);
+
+  gulpBuild(tmsConfig, newModules, env);
+}
+
+module.exports = build;
+