Nodejs除了编写服务器端程序还可以编写命令行工具,如gulp.js就是Nodejs编写的。

接下来我们来实现一个添加时间戳的命令: $ timestamp action

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;

文件代码如下:

  1. #!/usr/bin/env node
  2. var progarm = require('commander');
  3. //命令版本号
  4. progarm.version('0.0.1');
  5. //help命令
  6. progarm
  7. .command('help')
  8. .description('显示使用帮助')
  9. .action(function(){
  10. progarm.outputHelp();
  11. });
  12.  
  13. progarm
  14. .command('action [dir]')
  15. .description('加时间戳')
  16. .action(require('../lib/readfile'))
  17. .action(function(dir){
  18. console.log("极客出品")
  19. });
  20.  
  21. //开始解析命令
  22. progarm.parse(process.argv)

文件的第一行:

  1. #!/usr/bin/env node :指定当前文件使用哪个解释器来执行。
  1. progarm
  2. .command('help')
  3. .description('显示使用帮助')
  4. .action(function(){
  5. progarm.outputHelp();
  6. });
  • command("help")表示当前是什么命令
  • .description('显示使用帮助') 当前的命令
  • .action(callback);解析到当前命令执行的回调函数
  • progarm.parse(process.argv)开始解析命令

4.编写readfile.js

在timestamp 目录下

$ mkdir lib

cd lib

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

  1. var fs = require('fs'); //调用fs模块
  2. module.exports = function (dir) { //传入的目录,如果没有参数,则默认为当前目录
  3. dir = dir || '.';
  4. if (dir.indexOf(".html") > 0) {
  5. addtimestimp(dir); //如果参数是.html文件
  6. } else {
  7. fs.readdir(dir, function (err, files) { //如果不是html文件则遍历文件夹下所有的.html文件
  8. if (err) {
  9. console.log(err)
  10. } else {
  11. files.forEach(function (index) {
  12. var path = dir + "/" + index;
  13. if (index.indexOf('.html') > 0) {
  14. addtimestimp(path);
  15. }
  16. })
  17. }
  18. })
  19. }
  20. };
  21.  
  22. function addtimestimp(path){
  23. fs.readFile(path, 'utf-8', function (err, data) { //读取文件内容
  24. if (err) {
  25. console.log(err)
  26. } else {
  27. var nowtime = Date();
  28. var timestamp = Date.parse(nowtime); //以当前时间创建时间戳
  29.  
  30. var newcss = ".css?t=" + timestamp;
  31. var testcss = /[.]{1}css(\?t=[0-9]{0,})?/g;
  32. var newjs = ".js?t=" + timestamp;
  33. var testjs = /[.]{1}js(\?t=[0-9]{0,})?/g;
  34.  
  35. var newpng = ".png?t=" + timestamp;
  36. var testpng = /[.]{1}png(\?t=[0-9]{0,})?/g;
  37.  
  38. var newjpg = ".jpg?t=" + timestamp;
  39. var testjpg = /[.]{1}jpg(\?t=[0-9]{0,})?/g;
  40.  
  41. var newdata = (((data.replace(testcss, newcss)).replace(testjs, newjs)).replace(testpng, newpng)).replace(testjpg, newjpg);
  42. fs.writeFile(path, newdata, function (err) { //增加时间戳后写入
  43. if (err) {
  44. console.log(err);
  45. } else {
  46. console.log(path+"加时间戳完成")
  47. }
  48. });
  49. }
  50. })
  51. }

5.编辑package.json

  1. {
  2. "name": "timestamp007",
  3. "version": "0.0.6",
  4. "description": "add a timestamp to the html files",
  5. "main": "index.js",
  6. "scripts": {
  7. "test": "echo \"Error: no test specified\" && exit 1"
  8. },
  9. "author": "river.cao",
  10. "license": "ISC",
  11. "bin": {
  12. "timestamp": "./bin/timestamp"
  13. },
  14. "repository": {
  15. "type": "git",
  16. "url": "https://github.com/caojiangtao/timestamp"
  17. },
  18. "dependencies": {
  19. "commander": "^2.9.0",
  20. "fs": "0.0.2"
  21. }
  22. }

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

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

./bin/timestamp

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

$ sudo npm link

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

接下来执行:

$ timestamp help

如果看到如下内容:

  1. Usage: timestamp [options] [command]
  2.  
  3. Commands:
  4.  
  5. help 显示使用帮助
  6. action [dir] 加时间戳
  7.  
  8. Options:
  9.  
  10. -h, --help output usage information
  11. -V, --version output the version number

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

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

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

那么怎么发布到NPM上呢?

首先你的有个NPM的账号吧

1,注册 NPM 账号

  1. $ npm adduser
  2. Username:river.cao
  3. Password:
  4. Email:river@gmail.com

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

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

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

nodejs 编写(添加时间戳)命令行工具 timestamp的更多相关文章

  1. Node.js 命令行工具的编写

    日常开发中,编写 Node.js 命令行工具来完成一些小任务是很常见的操作.其编写也不难,和日常编写 Node.js 代码并无二致. package.json 中的 bin 字段 一个 npm 模块, ...

  2. 微软开放技术发布针对 Mac 和 Linux 的更新版 Azure Node.JS SDK 和命令行工具

    发布于 2013-12-04 作者 Eduard Koller 这次为我们使用Linux 的朋友带来了更多关于部署云上虚拟机的消息.今天,微软开放技术有限公司 (MS Open Tech),想与大家分 ...

  3. Nodejs 如何制作命令行工具

    # 全局安装,安装报错是需要前面加上sudo $ sudo npm install -g xxxb # 输出帮助 $ xxxb -h Usage: xxxb 这里是我私人玩耍的命令哦![options ...

  4. 如何用Node编写命令行工具

    0. 命令行工具 当全局安装模块之后,我们可以在控制台下执行指定的命令来运行操作,如果npm一样.我把这样的模块称之为命令行工具模块(如理解有偏颇,欢迎指正) 1.用Node编写命令行工具 在Node ...

  5. 用 nodejs 写一个命令行工具 :创建 react 组件的命令行工具

    用 nodejs 写一个命令行工具 :创建 react 组件的命令行工具 前言 上周,同事抱怨说 react 怎么不能像 angular 那样,使用命令行工具来生成一个组件.对呀,平时工作时,想要创建 ...

  6. [转]轻松学习Ionic (四) 修改应用图标及添加启动画面(更新官方命令行工具自动生成)

    本文转自:http://blog.csdn.net/zapzqc/article/details/42237935 由于Ionic更新了命令行工具,以后修改应用图标和添加启动画面就简单了,最新方法见最 ...

  7. dedecms:织梦文章如何添加“自定义属性”标签(sql命令行工具)

    dede织梦如何添加“自定义属性”标签“症状” 1.进入后台——系统——SQL命令行工具——运行SQL命令行,添加arcatt表字段: insert into`dede_arcatt`(sortid, ...

  8. 轻松学习Ionic (四) 修改应用图标及添加启动画面(更新官方命令行工具自动生成)

    由于Ionic更新了命令行工具,以后修改应用图标和添加启动画面就简单了,最新方法见最下方:   应用图标:   1.在整个项目所在文件夹下创建res文件夹,里边再分别创建两个文件夹android和io ...

  9. NodeJS 安装cnpm命令行工具

    在安装之前,请确保已安装Git和NodeJS. cmd机内命令窗口,输入以下命令: git config --system http.sslcainfo /bin/curl-ca-bundle.crt ...

随机推荐

  1. JS:window.onload的使用

    1.最简单的调用方式 直接写到html的body标签里面,如: (html) (body onload="func()") (/body) (/html) 2.在JS语句调用 (s ...

  2. 【转】封装原生JS实现Ajax

    function createXHR() { if (window.XMLHttpRequest) { //IE7+.Firefox.Opera.Chrome 和Safari return new X ...

  3. wpf xaml文件编辑出现中文乱码

    突然有一天,发现在xaml文件编辑窗里打汉字出来了乱码...抓狂 结果发现是番茄助手搞得鬼.只能在编辑xaml文件是暂时关闭番茄助手 visual assist

  4. Python Pandas分组聚合

    Pycharm 鼠标移动到函数上,CTRL+Q可以快速查看文档,CTR+P可以看基本的参数. apply(),applymap()和map() apply()和applymap()是DataFrame ...

  5. spring MVC入门教程

    写一个spring mvc后台传值到前台的一个小例子. 分为以下几个步骤: 1.创建web项目. 导入项目包.具体有如下: spring-aop-4.0.4.RELEASE.jar spring-be ...

  6. html5定位getLocation()

    HTML5 Geolocation API 用于获得用户的地理位置. 如果用户不允许定位,那么用户信息是不可用的. 获取用户的位置:getCurrentPosition() 返回数据如下 返回用户当前 ...

  7. Android——WebView

    WebView用途 通过Intent调用系统浏览器: 引言: Uri uri = Uri.parse(url);//url为你要链接的地址 Intent intent = new Intent(Int ...

  8. 18. class

    Class 基本用法 class n { constructor(x,y) { this.x = x; this.y = y; console.log(x,y) } proint() { consol ...

  9. iframe用js设定自定义高度

    JS代码 function SetWinHeight(obj){ var win=obj; if (document.getElementById){ if (win && !wind ...

  10. react

    package.json ENOSPC 文件监控增加一些 echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf ...