欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  web前端

使用nodejs开发cli项目实例_node.js

程序员文章站 2022-06-06 21:47:59
...
1.分分钟使用默认选项安装完nodejs
2.分分钟使用sudo npm install -g yo安装完yeoman
3.通过sudo npm install -g generator-cli-starter安装cli开发脚手架

OK, 现在我们可以使用yo cli-starter命令开始我们cli开发之旅了

创建cli项目

复制代码 代码如下:

yo cli-starter

按照提示输入项目名称、命令名称,完成cli项目创建。后续的教程中我们将使用hi作为你的命令名称,如果你使用了其他命令名称,请注意替换

Let's try first

现在命令行中输入如下命令(如果你用的不是hi,注意替换)

复制代码 代码如下:

hi

效果如下:

使用nodejs开发cli项目实例_node.js

试个常见命令?

我们接下来就开发一个类似ls, ls -all的命令,这里面需要用到一个node模块commander,先来安装一下:

进入该项目根目录执行npm install --save commander,

然后用你喜欢的editor打开bin/hi.js,并用以下内容替换原先的代码:

复制代码 代码如下:

#!/usr/bin/env node

'use strict';

var program = require('commander');

program
.version('0.0.1');//声明hi的版本号

program
.command('list')//声明hi下有一个命令叫list
.description('list files in current working directory')//给出list这个命令的描述
.option('-a, --all', 'Whether to display hidden files')//设置list这个命令的参数
.action(function(options) {//list命令的实现体
var fs = require('fs');
//获取当前运行目录下的文件信息
fs.readdir(process.cwd(), function(err, files) {
var list = files;
if (!options.all) {//检查用户是否给了--all或者-a的参数,如果没有,则过滤掉那些以.开头的文件
list = files.filter(function(file) {
return file.indexOf('.') !== 0;
});
}
console.log(list.join(' '));//控制台将所有文件名打印出来
});
});

program.parse(process.argv);//开始解析用户输入的命令

OK,现在来试试我们刚写好的命令吧,

复制代码 代码如下:

hi -V

使用nodejs开发cli项目实例_node.js

hi list

使用nodejs开发cli项目实例_node.js

复制代码 代码如下:

hi list -a

使用nodejs开发cli项目实例_node.js

如何发布

首先需要在Github上创建一个项目,并把我们刚才写的代码同步上去。

然后通过npm publish命令将你的cli发布到npm。

然后其他用户就可以通过npm install -g [项目名称]将你的命令安装到本地使用了