本文主要是介绍用Npm构建一个简单的命令行工具,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
原文章链接:请戳
Npm构建一个简单的命令行工具
在团队开发过程中,你是用什么工具去调用
private package
的呢?最常见的答案就是:使用命令行工具来使用它。我们用两部分来介绍如何制作其中一款命令行工具。
场景一:轻松部署GitHub pages
部署项目通常比较繁琐,因此我们使用自动化来完成部署任务。目前,有很多的task runners都可以为我们自动化构建任务,但是最简单的一种方式就是
npm run scripts
。
本章中,我们用构建一个GitHub page的例子来演示,当然我们也可以使用这种方式去部署其他服务,例如Heroku、AWS。或者你可以将它作为一个private package
发布,里面包含公司内部代码以及配置选项。
npm run scripts
首先,你定义一段可以被执行的字符串指令,当你调用脚本的时候,在命令行汇中执行
npm run scripts
,例如,我们为一个脚本命名为patch-release
,
#package.json
{"name": "index","version": "1.0.1","scripts": {"patch-release": "npm version patch && npm publish && git push --follow-tags"}
}
当你执行
patch-release
的时候,它会通过npm version
来修改package.json
中的version
并且提交更新,然后发布到npm,接着push到GitHub。
如果你在dependencies
、devDependencies
配置项中提前设置了modules,你就可以不用在将依赖包设置为全局,它们将是可以直接使用的。并且你也可以在scripts中使用其他的脚本npm run scripts
用脚本发布页面
受
git-it
启发,我们用脚本来部署到GitHub pages,构建步骤如下:
"scripts": {"build": "...","git-commit": "git add -A . && git commit -a -m 'gh-pages update'","git-push": "git push origin gh-pages --force && git checkout master","deploy": "npm run build && npm run git-commit && npm run git-push"},
然后,在我们想要部署的时候,运行
npm run deploy
即可。
还有更好的方式吗?
这种方式很棒。这将意味着你可以不用去记住那些冗长的字符串指令,以及他们对应的flags。然而,你想按照这种方式部署到其他项目又得大量copy&paste。这将意味着在你的项目中又得大量重复您的代码。
那么,我们怎么才能遵循”don’t repeat yourself”原则呢?我们可以尝试创建一个module,它可以将多个字符串指令合并成为一条指令。这就是说我们在不同的项目里面,可以很轻松的使用和维护这些指令还能分享给团队。
详情参见:戳这里
Step1: 创建一个基本的命令行界面
首先,我们创建一个基本的Common line interface(也称做CLI)。
创建一个package 清单
package 清单(即‘package.json’ 文件),它里面含有基本信息,例如包名称(package name),版本号(version)。
如果你想给你的package限定使用范围,供你的内部团队使用时,你可以考虑使这个包成为private package,设定的范围应该是你的用户名。$ npm init --scope=xxx
创建一个可被执行的脚本文件
因为我们想要运行命令行,但是前提是我们需要用一个解释器去启动文件(有时候我们称为shebang line)
#! ./node/env nodeconsole.log('console.log output')
现在我们运行测试一下:
node bin/commit.js
3. 告诉命令行你的命令是什么
我们想要执行一条命令,那么我们首先得告诉Node如何才能找到能被执行的文件,我们吧这条指令命名为github-pages-commit
。同时,我们在package.json文件中添加一个关键字:bin。
{"bin": {"github-pages-commit": "bin/commit.js"} }
- 确保命令可用
为了测试你的命令被拾取到,使用npm link
来执行关联操作,这将确保你的指令(github-pages-commit
)是可以被正确执行的。
step2: 执行被提交的命令
现在我们已经验证了一个能被执行的CLI,我们可以添加我们的命令了。
npm run scripts 使用很方便,因为你可以很轻松在命令行中使用指令。在可复用的模块中执行这些脚本很便捷,否则,我们的团队就不能确保那些脚本重用。
我们将使用shelljs
模块来实现,或者你也可以使用node‘s child_process,但是使用shelljs有一个好处就是,你可以在window系统中使用大量的unix指令。具体参考文档: 请戳这里。
1. 将shelljs 作为依赖$ npm install --save shelljs
将会在package.json文件中被添加为依赖(dependency)
2. 测试 shll.exec() 运行正常
为了确保我们掌握shell.exec()如何工作,我们将添加一个简单的输出声明到 bin/commit.js
#! /node/env node$ var shell = require('shelljs') shell.exec('echo shell.exec works')
- 使github-pages-commit 执行一个提交
为此,我们在命令行中简单的添加一个命令,用它来执行一次提交
#! ./node/node$ var shell = require('shelljs') shell.exec("git add -A . && git commit -a -m 'update' ")
为了测试这个,打开另一个命令行窗口并转到您使用GitHub页面的repo进行更改,然后运行github-pages-commit。在运行git log之后,您应该看到提交消息的提交gh-pages update。
step3: 添加其他两个命令
添加 bin/push/js
# /user/bin/env node$ var shell = require('shelljs') $ shell.exec('git push origin master --force')
添加 bin/deploy.js
我们通过定义过的其他指令进行合并
#! /node/env nodevar shell = require("shelljs") shell.exec("github-pages-commit && github-pages-push")
映射指令文件
{"github-pages-commit":"bin/commit.js","github-pages-push":"bin/push.js","githuv-pages-deploy":"bin/deploy.js" }
再次执行npm link
您需要npm link再次运行,以便它将创建两个新的符号链接。
现在您可以进行其他更改并运行github-pages-deploy以测试完整的任务。
step4: 发布你的package
如果你之前从未发布过软件包,请戳这里
因为这是一个有作用域的包,如果你想公开发布,必须使用access选项,了解更多请戳这里
npm publish --access=publish
最后,付费会员可以发布private package。
step5: 将你的命令添加为npm run scripts
我们可以告诉我们的团队在全局安装这个模块,然后所有的指令都将可以在命令行中运行,我们不需要用npm 运行脚本,但是全局安装有两个缺点:首先,在新同事着手一个项目的时候他得体检做一些准备工作,其次,当项目依赖更新的时候,你的团队成员必须也要更新全局模块。
相反,我们要使它的一个devDependencies在package.json为我们要部署的项目。通过这种方式,当新开发人员npm install开始运行项目时会下载它,并且每次开发人员运行时都会进行更新npm update。
$ npm install --save-dev @xxx/github-pages-deploy
现在您可以将可复用命令添加为npm运行脚本
{"scripts":{"build": "....","deploy": "github-pages-deploy"} }
TO BE CONTINUE…
这篇关于用Npm构建一个简单的命令行工具的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!