npm 命令行工具开发指南

我们在前端开发中会经常用到命令行工具，比如@babel/cli、vue-cli、create-react-app 等等。那么如何创建一个npm 命令行工具呢？其实很简单的，仅需要几步即可。

创建

1 初始化npm项目

npm init
package name: (cli) gogocode-cli
version: (1.0.0) 
description: my-first-cli
entry point: (index.js) 
keywords: npm cli
author: super man

2 配置bin字段

npm init 后会生成一个package.json文件，在该文件中添加一个bin字段，bin字段的key就是你的命令（gogocode），value指向相对于package.json的路径（index.js），不同的key对应不同的命令。关于 bin 字段更多信息请参考文档。

{
  "name": "gogocode-cli",
  "version": "1.0.0",
  "description": "my-first-cli",
  "bin": {
    "gogocode": "index.js"
  }
}

3 创建index.js文件

在项目根目录创建index.js文件。下面是index.js文件内容：使用console.log() 函数来输出命令行返回信息。

 #!/usr/bin/env node
 console.log(\'Hello, world!\');

注意：第一行一定要添加脚本来指定运行环境（#!/usr/bin/env node）

4 打包发布

4.1 发布

• 在项目根目录执行npm pulish 命令。按照系统提示操作，即可将你的命令行工具发布到 npmjs 平台。期间需要注册npm账号，可自行百度。

npm publish

• 打包完成之后，就能在npmjs官网看到你发布的npm包了。

4.2 验证

1. 全局安装 npm 包

npm install gogocode-cli -g

2. 执行命令

gogocode

3. 正确输出 “Hello，World！”