用nodejs开发npm命令行工具就这么简单(nodejs 命令行工具)

用nodejs开发npm命令行工具就这么简单(nodejs 命令行工具)

Node.js盛行了也有些年头儿了,相信很多前端工程师、全栈工程师也都用它编写过服务器端程序,实现过即时通讯。今天我们一起来聊聊如何用Node.js编写命令行工具,其实之前盛行的前端脚手架 glup.js就是用node.js编写的。

今天我们就用一起来编写一个添加时间戳工具,来体验一下。

先体验一下在线的成品:https://www.npmjs.com/package/timestamp007

厚积薄发,首先来我们先熟悉一下开发命令行工具需要用的模块和常见的命令格式。

1.需要用的模块:

commander 模块

  • 用途 :解析命令行参数
  • 主页: https://tj.github.io/commander.js/

fs 模块

  • 用途 :于对系统文件及目录进行读写操作

2.命令格式

编写命令行工具前,首先定义命令的使用方式:

如:

  • 项目文件目录下 $ timestamp action 表示项目下所有页面将添加时间戳
  • 给某个页面添加时间戳 $ timestamp action /project/index.html
  • 在非项目录下运行 需要制定项目目录 $ timestamp action /Users/river/web

3.常见的命令格式

command [options] [arguments]

含义如下:

  • command:命令名称,如:node,timestamp
  • options:–单词或者单字母,比如–help 或者 –h
  • arguments :参数

在查看命令帮助时会出现 [],<>,| 等符号,他们的含义分别是

  • []:可选
  • <>:表示可变选项。一般是多选一。而且是必选其中一个。
  • X|Y|Z 多选一,如果加上[],则可不选。
  • -abc:多选,如果加上[], 则可不选。

如 timestamp 命令的使用方法描述如下:

Usage: timestamp [options] [command]

接下来,我们一步步来创建我们的命令行项目:

1.首先 创建一个空的项目文件夹,然后再通过npm init 来初始化 package.json 文件夹:

$ mkdir timestamp

$ cd timestamp

$ npm init

2.初始化完毕后

安装commander模块:

$ npm install commander –save;

安装 fs模块:

$ npm install fs –save

3.安装完毕后

新建文件bin/timestamp;

文件代码如下:

#!/usr/bin/env nodevar progarm = require(\’commander\’);//命令版本号progarm.version(\’0.0.1\’);//help命令progarm .command(\’help\’) .description(\’显示使用帮助\’) .action(function(){ progarm.outputHelp(); });progarm .command(\’action [dir]\’) .description(\’加时间戳\’) .action(require(\’../lib/readfile\’)) .action(function(dir){ console.log(\”极客出品\”) }); //开始解析命令 progarm.parse(process.argv)

文件的第一行:

#!/usr/bin/env node :指定当前文件使用哪个解释器来执行。

progarm

.command(\’help\’)

.description(\’显示使用帮助\’)

.action(function(){

progarm.outputHelp();

});

  • command(\”help\”)表示当前是什么命令
  • .description(\’显示使用帮助\’) 当前的命令
  • .action(callback);解析到当前命令执行的回调函数
  • progarm.parse(process.argv)开始解析命令

4.编写readfile.js

在timestamp 目录下

$ mkdir lib

cd lib

新建 readfile.js,文件内容如下:

var fs = require(\’fs\’); //调用fs模块module.exports = function (dir) { //传入的目录,如果没有参数,则默认为当前目录 dir = dir || \’.\’; if (dir.indexOf(\”.html\”) > 0) { addtimestimp(dir); //如果参数是.html文件 } else { fs.readdir(dir, function (err, files) { //如果不是html文件则遍历文件夹下所有的.html文件 if (err) { console.log(err) } else { files.forEach(function (index) { var path = dir \”/\” index; if (index.indexOf(\’.html\’) > 0) { addtimestimp(path); } }) } }) }};function addtimestimp(path){ fs.readFile(path, \’utf-8\’, function (err, data) { //读取文件内容 if (err) { console.log(err) } else { var nowtime = Date(); var timestamp = Date.parse(nowtime); //以当前时间创建时间戳 var newcss = \”.css?t=\” timestamp; var testcss = /[.]{1}css(?t=[0-9]{0,})?/g; var newjs = \”.js?t=\” timestamp; var testjs = /[.]{1}js(?t=[0-9]{0,})?/g; var newpng = \”.png?t=\” timestamp; var testpng = /[.]{1}png(?t=[0-9]{0,})?/g; var newjpg = \”.jpg?t=\” timestamp; var testjpg = /[.]{1}jpg(?t=[0-9]{0,})?/g; var newdata = (((data.replace(testcss, newcss)).replace(testjs, newjs)).replace(testpng, newpng)).replace(testjpg, newjpg); fs.writeFile(path, newdata, function (err) { //增加时间戳后写入 if (err) { console.log(err); } else { console.log(path \”加时间戳完成\”) } }); } })}

5.编辑package.json

{ \”name\”: \”timestamp007\”, \”version\”: \”0.0.6\”, \”description\”: \”add a timestamp to the html files\”, \”main\”: \”index.js\”, \”scripts\”: { \”test\”: \”echo \”Error: no test specified\” && exit 1\” }, \”author\”: \”river.cao\”, \”license\”: \”ISC\”, \”bin\”: { \”timestamp\”: \”./bin/timestamp\” }, \”repository\”: { \”type\”: \”git\”, \”url\”: \”https://github.com/caojiangtao/timestamp\” }, \”dependencies\”: { \”commander\”: \”^2.9.0\”, \”fs\”: \”0.0.2\” }}

可以看到 package.json 增加了 bin属性,那么bin 属性的作用是什么呢?

bin 属性用来指定当前模块需要连接的命令,在这里我们指定了 timestamp 命令是执行文件 :

./bin/timestamp

重点来了为了让这个设置生效,还需要执行以下命令来进行连接

$ sudo npm link

那么执行完毕了,我就可以验证命令行是否生效了,

接下来执行:

$ timestamp help

如果看到如下内容:

Usage: timestamp [options] [command] Commands: help 显示使用帮助 action [dir] 加时间戳 Options: -h, –help output usage information -V, –version output the version number

表示我们的命令行编写成功了!

大功告成了!可以开一瓶82年的雪碧庆祝下了!!!

等等,我觉的还是要发布到npm给兄弟们共享下劳动成果的,

那么怎么发布到NPM上呢?

首先你的有个NPM的账号吧

1.注册 NPM 账号

$ npm adduser Username:river.caoPassword:Email:river@gmail.com

2.回到 timestamp 根目录 执行 npm publish ,如果没有错误提示那么就发布成果了,去 http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest Updates”一栏里了。(当然肯出会错,因为模块名称已经被占用了)

3.$ npm login //如果已经有账号。可以用login命令重新登录npm

那么 nodejs 的命令行开发已经讲完了,可以去喝雪碧了

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

(0)
上一篇 2023年5月4日 上午9:10
下一篇 2023年5月4日 上午9:20

相关推荐

  • PLM一体化IPD研发项目管理方法和工具(plm研发系统)

      集成产品开发(Integrated Product Development,简称IPD)是一套领先的、成熟的产品开发管理思想、模式和方法,是以产品运营为主线的流程管理解决方法。…

    2022年6月22日
    388
  • 指导性科技项目有什么作用

    指导性科技项目有什么作用 随着科技的快速发展,的指导性科技项目已经成为了推动科技创新的重要力量。在科技项目中,指导性科技项目的作用非常重要,具体体现在以下几个方面。 指导性科技项目…

    科研百科 2024年10月16日
    1
  • 山东省中小学教师信息技术应用能力提升工程2.0项目研修总结(山东省中小学教师信息技术能力提升工程2.0培训通知)

    我参加了山东省小学教师信息技术应用能力提升,通过这次研修,我感触很深,我深深地体会到计算机辅助教学早就走到了我们身边,随着信息技术的不断发展,多媒体教学,信息技术平台等活跃了课堂,…

    科研百科 2022年7月11日
    420
  • 低代码平台用什么框架

    低代码平台是一种可以帮助开发人员快速构建应用程序的工具。它提供了一套可视化的开发环境,使开发人员能够通过拖放组件、配置属性和逻辑来创建应用程序,而无需编写大量的代码。那么,低代码平…

    科研百科 2024年2月23日
    168
  • 公司科研项目费

    公司科研项目费: 推动科技进步的关键 随着科技的不断发展,公司科研项目费已成为推动科技进步的关键。科研项目费不仅是公司获得创新技术的手段,更是公司提升自身竞争力的关键因素。本文将探…

    科研百科 2025年1月31日
    0
  • 施工企业环保工程管理系统解决方案(环境管理系统工程)

    随着中国经济的持续快速发展,城市进程和工业化进程的不断增加,环境污染日益严重,国家对环保的重视程度也越来越高。进入21世纪,全球环保产业开始进入快速发展阶段,逐渐成为支撑产业经济效…

    2022年6月13日
    309
  • 财务制度大全工会经费管理制度

    财务制度大全工会经费管理制度 工会经费管理制度是工会组织工作的重要保障,是工会工作的基础和保障。为了规范工会经费的管理和使用,制定本制度。 一、适用范围 本制度适用于工会经费的管理…

    科研百科 2024年5月29日
    111
  • 推进科研项目监督检查

    推进科研项目监督检查 随着科技的不断发展,科研项目成为了国家经济发展的重要支撑。然而,科研项目的顺利进行离不开严格的管理和监督。因此,推进科研项目监督检查,对于确保科研项目的顺利进…

    科研百科 2025年2月27日
    1
  • 银行党建工作总结3篇(银行党建工作总结3篇范文)

    现分享3篇《银行党建工作总结》,大纲如下: 银行党建工作总结1 一、履行职务情况 思想上,积极参加政治学习,遵守行纪行规。 工作上,本人能忠于职守,严于律已,工作勤恳,严格执行相关…

    科研百科 2023年7月14日
    228
  • 南京办公楼项目管理系统

    南京办公楼项目管理系统 南京办公楼项目管理系统是一种高效的项目管理软件,能够帮助项目经理和团队更好地管理项目进度、预算和质量。南京办公楼项目管理系统采用了现代技术,包括移动应用程序…

    科研百科 2025年1月16日
    0