开发自己的nodejs命令行工具

开发自己的nodejs命令行工具

BUG集散地

2018-09-12 10:10 阅读 42 喜欢 0 命令行工具 nodejs cli

需求来源于生活。

在日常开发中,经常会频繁的做一些重复性的操作,作为一名程序员,解放双手的时刻到了。

比如说:批量修改某些文件的后缀,我对于一些shell或者win下的命令不是很熟悉,稍微了解的就是自己的开发语言,所以用熟悉的工具做事还是可以带来一些成就感的。

下面我准备针对这个小小的需求开发一个自己的命令行,当然如果能帮助到其他人,那就更加的满足了。闲话不多说,下面直接开始。

需求整理
  1. 可以对某个文件夹下的所有文件进行后缀的修改
  2. 可以限定某类后缀修改为指定的后缀
  3. 可以指定目标文件夹
  4. 同时可以随机重命名
准备

nodejs的环境 编辑工具sublime npm 的帐号 github的帐号

大体流程
  1. 在github上创建自己想要的仓库changeext(命名)
  2. 将仓库clone到本地进行开发、测试
  3. 发布到github
  4. 发布到npm
  5. 安装到本地进行使用大功告成
步骤分解

一些帐号注册、仓库创建就不在说了,主要说下开发的具体流程 先来一段伪代码:

1.确定目标文件夹、一些相关的参数(是否重命名、源后缀、目标后缀)
2.获得目标文件夹下的所有文件(符合源后缀)
3.对符合条件的文件进行重命名(修改后缀)
4.结束,对,流程很简单,实现起来也不麻烦,但是起码这是自己的小工具啊,哪怕网上再多也是别人的

开发中使用的module: minimist(命令行参数处理) fs(操作文件) path(处理文件路径) colors(让打印信息更加好看)

代码如下:

#!/usr/bin/env node
//作为命令行工具,第一行就是上面的这货,千万别少了

var fs = require('fs');

var path = require('path');

var colors = require('colors');
//指定一些颜色信息
colors.setTheme({
  error : 'red',
  success : 'green',
  info : 'yellow'
});
//获得命令行的参数
var argv = require("minimist")(process.argv.slice(2), {
  alias: {
    'input': 'i',
    'target': 't',
    'directory': 'd',
    'loop' : 'l',
    'random' : 'r'
  },
  string: ['input', 'target','directory'],
  boolean : ['loop','random'],
  'default': {
    'directory': process.cwd()
  }
});
//打印帮助信息
if (argv.help) {
  console.log("Usage:".info);
  console.log("  changeext --help     // print help information".success);
  console.log("  changeext txt js     // change 'txt' to 'js' ".success);
  console.log("  changeext -i txt     // input file extensions".success);
  console.log("  changeext -t js      // target file extensions".success);
  console.log("  changeext -d /home/  // target directory for change".success);
  console.log("  changeext -l         // loop file directory for change file extensions".success);
  console.log("  changeext txt js -r  // get some random name");
  process.exit(0);
}
//随机获得一个随机字符串
function getRandom(){
  var counter = 0;
  return (function() {
      var guid = (+new Date()).toString( 32 ),i = 0;
      for ( ; i < 5; i++ ) {
          guid += Math.floor( Math.random() * 65535 ).toString( 32 );
      }
      return  guid + (counter++).toString( 32 );
  })();
}
//重命名
function rename (folderPath,input,target,loop){
  fs.stat(folderPath,function(err,stats){
    if(err){
      console.log(err);
    }else{
      if(stats.isDirectory()){

        if(loop === true && argv.loop === false){
          return false;
        }

        if(loop === false && argv.loop === false){//不需要循环,但是目标路径为文件夹
          loop = true;
        }

        fs.readdir(folderPath,function(err2,files){
          if(err2){
            console.log(err2);
          }else{
            if(files && files.length > 0){
              files.forEach(function(filename,index){

                rename(path.join(folderPath,filename),input,target,loop);

              });
            }
          }
        });
      }else{

        var extname = path.extname(folderPath);

        input = input.startsWith('.') || input == '' ? input : '.'+input;

        target = target.startsWith('.') || target == '' ? target : '.'+target;

        extname = extname.toLowerCase();

        input = input.toLowerCase();

        target = target.toLowerCase();

        if(extname === input){
          var newPath = "";
          if(argv.random){
            var randomName = getRandom() + target;
            newPath = path.join(path.dirname(folderPath),randomName);
          }else{
            newPath = folderPath.substring(0,folderPath.length - extname.length) + target;  
          }
          fs.rename(folderPath,newPath,function(err){
            if(err){
              console.log(err);
            }else{
              console.log('Rename file : '+folderPath.info +' => '+newPath.info+' success.'.success);  
            }
          });
        }
      }
    }

  });
}
//校验
if(argv.directory && fs.existsSync(argv.directory)){

  if( (argv.input && argv.target) || (argv.input === '' && argv.target) || (argv.input && argv.target === '') ){

    rename(argv.directory,argv.input,argv.target,argv.loop);

  }else{
    if(argv._[0] && argv._[1]){

      rename(argv.directory,argv._[0],argv._[1]);

    }else{

      console.log('input file extensions and target file extensions must be not empty.'.error);  
      process.exit(0);

    }
  }
}else{

  console.log('directory is not exists.'.error);
  process.exit(0);

}

然后我们就针对代码进行本地测试 image.png

OK,测试成功,然后把代码发布到github(此处流程可以google),然后将自己的代码发布到npm官网(此处可以查看:https://www.jianshu.com/p/e388af61f5dd

然后,我们就可以开心的下载自己的工具来666了。

转载请注明出处: https://chrunlee.cn/article/cli-nodejs-tool.html


如果对你有用的话,请赏给作者一个馒头吧 ...或帮点下页面底部的广告,感谢!!

赞赏支持
提交评论
评论信息(请文明评论)
暂无评论,快来快来写想法...
推荐
最近有接触到针对二维码进行识别的功能,然后对图片进行位置纠正、二维码扫描,并将数据进行整理。以下是通过nodejs做的,相对简单一些,没有太过严格,识别率也不是很高大约80%左右
也不知道咋回事 ... 哈哈,忽然想研究下磁力网站,其实并不是很想懂里面的原理,只是搞不明白他们的资源是从哪里来的..很是纳闷?
通过node-xlsx模块读取excel和写入
从上面那篇文章过来的,这里分享下nodejs对文件夹以及子文件进行批量删除的实现。
发布自己的nodejs应用后,需要进行管理,目前一般都pm2来进行管理,这里记录下常用的命令。
目前了解的有两个模块可以实现二维码的模块,一个是node-qrcode ,这个算是比较大众的,不过环境比较复杂,所以...连看都没看;还有一个是小众的 qr-image ,这个比较简单,没有其他环境依赖,安装即可用,因为要实现一个简单的在线二维码生成,就先用这个试试水了
使用nodejs连接ftp,进行ftp的操作,包括列表、上传、下载以及速率等。
记录下在linux环境下安装phantomjs 的步骤,防止遗忘...