写点什么

CLI 新功能之多项目启动器

作者:小鑫同学
  • 2022-10-12
    北京
  • 本文字数:1205 字

    阅读完需:约 4 分钟

CLI新功能之多项目启动器

大家好,我是小鑫同学。一位从事过 Android 开发混合开发,现在长期从事前端开发的编程爱好者,我觉得在编程之路上最重要的是知识的分享,所谓三人行必有我师。所以我开始在社区持续输出我所了解到、学习到、工作中遇到的各种编程知识,欢迎有想法、有同感的伙伴加我fe-xiaoxin微信交流~

统一约束:

  1. 项目启动配置文件路径与待启动项目同级;

  2. 多个待启动项目路径同级存放;

  3. 待启动项目的执行脚本命名均使用“start”;

数据转换流程:

引用类库:

通用脚本编写:

读取主项目和各从项目的 package.json 文件得到启动项目的脚本,并将它们存放在统一的 startScript 数组;


const startScript = [];const mainPackage = require(`./${pConfig.progects.main}/package.json`);
if (mainPackage.scripts.start) { startScript.push({ name: pConfig.progects.main, runScript: mainPackage.scripts.start, isMain: true, }); pConfig.progects.slave.forEach((slave) => { const slavePackage = require(`./${slave}/package.json`); if (slavePackage.scripts.start) { startScript.push({ name: slave, runScript: slavePackage.scripts.start, isMain: false, }); } });}
复制代码


使用 inquirer 来收集实际需要启动项目的选项,这里使用 checkbox 来组织问题,将 startScript 转化成 inquirer 需要的格式:



const choices = startScript.map((script) => {    return {        name: script.name,        value: script,        checked: script.isMain,    };});
复制代码




inquirer 配置,name 在读取 answers 对象时使用:


inquirer.prompt([  {     type: 'checkbox',     name: 'startProjects',     message: '需要启动的项目',     choices   }]).then((answers) => {   // TODO 拿到选中的选项后异步执行启动各项目的脚本 });
复制代码


启动项目脚本的执行可以使用 shelljs 来方便的完成,在循环 answers 中的项目启动脚本的时候,我们根据不同的项目名称执行 shell.cd()进入到不同的项目内,在通过异步调用 shell.exec(runScript, { async: true });来真实的执行项目启动脚本。


需要在执行 shell.exec()后通过返回的 ChildProcess 对象来设置各项监听器:


const child = shell.exec(runScript, { async: true, silent: true, fatal: true });child.stdout.on('data', (data) => {  console.log(chalk.white.bgYellow.bold(` ${name} OUTPUT:\n`), data);});child.stderr.on('data', (data) => {  console.log(chalk.white.bgYellow.bgRed(` ${name} ERROR:\n`), data);});
复制代码

结语:

当你手头存在一些关联项目需要全部启动后协同工作的时候,如多个前端项目间有嵌套需求、前后(NodeJs)端项目等,就可以使用这么一个启动器来简化多个项目启动带来的重复工作。

发布于: 刚刚阅读数: 3
用户头像

小鑫同学

关注

⚡InfoQ签约作者 2018-12-10 加入

还未添加个人简介

评论

发布
暂无评论
CLI新功能之多项目启动器_前端_小鑫同学_InfoQ写作社区