写一个命令行工具

hello world

mkdir slb
cd slb
npm init
touch cli.js

命令行文件指定脚本使用的解析器

#!/usr/bin/env node
console.log("hello world")

package.json 中的字段 bin 表示的是一个可执行文件到指定文件源的映射。bin 的配置有两种,一种字符串配置是将命令指定为包名,
第二种是对象配置的方式可以指定命令名称并且配置多个

// 字符串配置
{
  "name": "slb"
  "bin": "cli.js"
}
// 对象配置
{
  "bin": {
    "slb1": "cli1.js"
    "slb2": "cli2.js"
  },
}

开发调试,全局安装的 cli 包,是可以全局调用 cli 命令的,比如webpack, vue-cli,我们开发环境调试可以通过在项目目录下npm link创建链接或者全局安装npm i -g .,这样我们就可以在全局下使用我们项目配置的命令了

全局安装@vue/cli 的话,@vue/cli 源文件会被安装在全局源文件安装目录(/user/local/lib/node_modules)下,而 npm 会在全局可执行 bin 文件安装目录(/usr/local/bin)下创建一个指向/usr/local/lib/node_modules/@vue/cli/bin/vue.js 文件的名为 vue 的软链接,这样就可以直接在终端输入 vue 来执行相关命令。

如果局部安装@vue/cli 的话,npm 则会在本地项目./node_modules/.bin 目录下创建一个指向./node_moudles/@vue/cli/bin/vue.js 名为 vue 的软链接,这个时候需要在终端中输入./node_modules/.bin/vue 来执行(也可以使用 npx vue 命令来执行,npx 的作用就是为了方便调用项目内部安装的模块)。

npm install 安装依赖时,会将指定脚本解析器安装在node_modules/.bin

命令行介绍

参数传递, 通过process.argv查看命令行参数

slb run dev
slb -v --version
slb test --mode=env

可以看到通过 argv 其实就是通过空格分隔了字段,自己处理参数还是有太多东西需要处理

参数处理

命令行开发工具, 开源的有比较成熟的依赖包,如yargs, meow, commander,下面介绍两种

  • yargs
var yargs = require("yargs");

console.log("hello ", yargs.argv);
  • meow
    封装简单,不支持自动生成 help 信息
    flags:
    command:
// 查看cli返回

依赖包和使用

命令行工具是通过 node 的能力,所以能做的事情非常多,下面简单的介绍下实际操作中会用到的一些依赖包和几个简单的功能(其实都是 node 的能力)

  1. chalk: 样式修改
  2. inquirer:交互输入
  3. execa:执行其他的命令
  4. 文件复制

其他

相关依赖:

  1. 输入交互: inquirer、 enquirer 、prompts
  2. 输出美化: chalk、ora、 kleur、ink、figlet
  3. 参数解析: meow, yargs, commander
  4. 命令执行: execa, shelljs

参考

  1. 手把手教你写命令行工具
  2. Build a Command Line Application with Node.js
  3. Node 命令行前端自动构建发布系统

你可能感兴趣的:(写一个命令行工具)