3、命令行工具

## 一、自定义   创建一个空目录，然后通过npm init命令初始化package.json文件，并按提示输入相关信息或直接回车使用默认信息，生成的内容如下所示。 ~~~ { "name": "pwct", "version": "1.0.0", "description": "命令行工具测试", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { "type": "git", "url": "git+https://github.com/pwstrick/pwct.git" }, "author": "strick", "license": "ISC", "bugs": { "url": "https://github.com/pwstrick/pwct/issues" }, "homepage": "https://github.com/pwstrick/pwct#readme" } ~~~   在模块中创建bin目录，并保存一个名为pwct.js的脚本，内容如下（只做演示，没有加逻辑）。其中#!/usr/bin/env node语句用于指定脚本的解释器。 ~~~ #!/usr/bin/env node console.log("命令行工具测试"); ~~~   更新package.json文件，新增bin字段，并添加以下配置。 ~~~ "bin": { "pwct": "./bin/pwct.js" } ~~~   如果现在在终端运行pwct命令，那么会出现下面的错误提示。 ~~~ $ pwct bash: pwct: command not found ~~~   为了能测试刚刚添加的命令，需要使用npm link命令（运行结果如下所示），它能模拟全局安装，而不用发布模块。 ~~~ C:\AppData\Roaming\npm\pwct -> C:\AppData\Roaming\npm\node_modules\pwct\bin\pwct.js C:\AppData\Roaming\npm\node_modules\pwct -> D:\node\demo ~~~   再次在终端运行pwct命令，就能打印出预期的结果，如下所示。 ~~~ $ pwct 命令行工具测试 ~~~   命令行的参数可以从process.argv数组中获得，直接修改pwct.js文件，添加一条打印process.argv的语句，如下所示。由于使用了npm link来链接模块，因此无须重新发布和安装就能直接调试。 ~~~ #!/usr/bin/env node console.log(process.argv); ~~~   在终端运行pwct -h命令，得到的数组如下所示，省略了前两个元素的绝对路径。 ~~~ $ pwct -h [ 'node.exe', 'pwct.js', '-h' ] ~~~ ## 二、包的管理 **1）发布**   当要将模块作为包发布到npm官网时，首先需要注册一个帐号，然后使用npm login命令在终端登录，再通过npm publish命令发布，发布成功后得到的结果如下。 ~~~ $ npm publish npm notice npm notice package: pwct@1.0.0 npm notice === Tarball Contents === npm notice 494B package.json npm notice 221B bin/pwct.js npm notice === Tarball Details === npm notice name: pwct npm notice version: 1.0.0 npm notice package size: 527 B npm notice unpacked size: 715 B npm notice shasum: 16cd277ffad852d2d2ac60534b557df28854f93f npm notice integrity: sha512-/j+dfkz63nZVW[...]RYnfU8DgOEcHQ== npm notice total files: 2 npm notice + pwct@1.0.0 ~~~ **2）更新**   当需要更新一个已发布的包时，可以先运行下面命令中的一个，三条命令会分别对主版本号、次版本号和补丁版本号进行加一的处理。 ~~~ npm version major npm version minor npm version patch ~~~   例如运行patch命令，结果如下所示。 ~~~ $ npm version patch v1.0.1 ~~~   然后再运行npm publish命令，进行更新处理。 **3）删除**   可以删除特定版本号的包，语法如下所示。 ~~~ npm unpublish 包名@版本号 ~~~   运行下面的命令，就能移除官网上指定版本的包。 ~~~ $ npm unpublish pwct@1.0.1 -pwct@1.0.1 ~~~   如果要删除整个包，语法如下。 ~~~ npm unpublish 包名 --force ~~~   运行下面的命令，就能将官网上的包整个移除。 ~~~ $ npm unpublish pwct --force npm WARN using --force I sure hope you know what you are doing. -pwct ~~~ **4）安装**   npm install命令除了可以跟包名之外，还能与GitHub的SSH地址组合，如下所示。 ~~~ npm install git+ssh://github.com:pwstrick/pwct.git ~~~ ## 三、Commander.js   上述所举的是一个极简命令，而一般的命令格式会包含三部分，如下所示。 ~~~ command [options] [arguments] ~~~   （1）command：命令名称，例如pwct。   （2）options：配置选项，前缀可以是单个连字符（-）或两个连字符（--），前者与参数简称组合，后者与参数全称组合，例如-h、--help。   （3）arguments：参数列表，有些选项也会带参数。   在查看命令帮助时，会出现\[\]、<>、|等符号，它们的含义如下：   （1）\[\]：可选的。   （2）<>：可变选项，一般是多选一，而且必须要选其一。   （3）x|y|z：多选一，如果加上\[\]，可不选。   （4）-abc：多选，如果加上\[\]，可不选。   接下来使用第三方的Node命令行模块：Commander.js，编写出更加专业的命令，如下所示。注意，命令名称改为pwcta。 ~~~ #!/usr/bin/env node const program = require('commander'); program .version('1.0.0', '-v, --version', '版本') .option('-d, --debug', '调试') .option('-b, --build [dir]', '构建') .parse(process.argv); if (program.debug) console.log(program.opts()); if (program.build) console.log('loading'); ~~~   version()方法可定义当前命令的版本。option()方法可定义命令的配置选项。parse()方法可让解析出的全称参数成为program的属性。   运行“pwcta -d -b ./list”命令，得到的结果如下所示，opts()方法可得到参数的键值对。 ~~~ $ pwcta -d -b ./list { version: '1.0.0', debug: true, build: './list' } loading ~~~   帮助选项（-h和--help）默认已提供，运行“pwcta -h”命令得到的结果如下。 ~~~ $ pwcta -h Usage: pwcta [options] Options: -v, --version 版本 -d, --debug 调试 -b, --build [dir] 构建 -h, --help display help for command ~~~ ***** > 原文出处： [博客园-Node.js躬行记](https://www.cnblogs.com/strick/category/1688575.html) [知乎专栏-Node.js躬行记](https://zhuanlan.zhihu.com/pwnode) 已建立一个微信前端交流群，如要进群，请先加微信号freedom20180706或扫描下面的二维码，请求中需注明“看云加群”，在通过请求后就会把你拉进来。还搜集整理了一套[面试资料](https://github.com/pwstrick/daily)，欢迎浏览。