Nodejs构建自己的全局命令行工具

图片源自Medium.jpeg

关键字: Nodejs
本文主要介绍一下windows下如何构建一个自己的全局命令行工具,了解创建命令行工具的原理,因此代码功能可能不全,文末附代码地址,如有问题还望指正。

前奏:如果你原来使用过hexo,你一定使用过下面的的命令来构建你的blog,那么问题来了,为什么在安装hexo之后我们可以执行 hexo相关命令来搭建我们的blog呢?下面小编简单为你介绍。_

npm install -g hexo    //安装hexo全局命令行工具
hexo init blog          //初始化blog
cd blog 
hexo server          //启动服务 --> 访问 http://localhost:4000/
hexo new "HappyDay"   //新建一篇blog

读完本文后, 你将会完成如下效果的命令行工具 ana

demo.gif

正题:
1.安装NodeJS
2.命令行执行, 查看当前全局命令行工具软件所在目录

npm root -g    // --我的目录 C:\Users\GL\AppData\Roaming\npm\node_modules
root.gif

3.在C:\Users\GL\AppData\Roaming\npm目录下随便找一个后缀名是 .cmd的文件,这里小编使借用的是hexo.cmd,内容如下

@IF EXIST "%~dp0\node.exe" (
  "%~dp0\node.exe"  "%~dp0\node_modules\hexo\bin\hexo" %*
) ELSE (
  @SETLOCAL
  @SET PATHEXT=%PATHEXT:;.JS;=;%
  node  "%~dp0\node_modules\hexo\bin\hexo" %*
)

4.先照猫画虎,这段脚本什么意思我们先不用管,之后在解释。假设我们要构建一个命令行工具ana,将脚本内hexo全部替换成ana,并且新建对应的层级文件夹,如下,暂且叫做ana.cmd

@IF EXIST "%~dp0\node.exe" (
  "%~dp0\node.exe"  "%~dp0\node_modules\ana\bin\ana" %*   //自己新建对应目录下文件+文件夹
) ELSE (
  @SETLOCAL
  @SET PATHEXT=%PATHEXT:;.JS;=;%
  node  "%~dp0\node_modules\ana\bin\ana" %*   //自己新建对应目录下文件+文件夹
)

5.在node_modules\ana目录下初始化一个json文件

npm init -y
01.gif

在node_modules\ana\bin\ana的ana文件中写入引入的模块,如下:

require("../lib/bin/ana")

在node_modules\ana\lib\bin\ana.js的ana.js文件中写入要引入的模块,如下

require('../index')

6.这些准备完以后,开始写我们的主要代码。 在node_modules\ana\lib 目录下新建data.js 、index.html、 index.js这三个文件

//index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>
    <div>Hello word</div>
</body>
</html>
//data.js 配置列表,根据配置项定义来新建对应文件or文件夹

'use strict';
const fs = require('fs');
const path = require('path');
module.exports = {
    items:[
        {
            name:'css',
            type:'dir', //目录
            items:[]
        },
        {
            name:'img',
            type:'dir'  //目录
        },
        {
            name:'js',
            type:'dir'  //目录
        },
        {
            name:'index.html',
            type:'file',  //文件
            content: fs.readFileSync(path.join(__dirname,'index.html'))  //同步读取index.html文件,执行命令的时候会帮我们将此文件也创建出来
        }
    ]
};
下面是主要代码部分: index.js
'use strict'
const fs = require('fs');
const path = require('path');
const structure = require('./data').items;
// dos 窗口输入--->ana init blog ,init属于 第二个参数
let args = process.argv.slice(2);
let cmd =args[0];
switch (cmd) {
    case 'init':
        let projectName = args[1];
        var rootName = `./${projectName}`;   //首次操作,假设此文件目录不存在
        fs.mkdir(rootName,(err)=>{      //创建目录
            if(err){
                throw  err;
            }
            structure.forEach((item)=>{  //遍历创建相应类型的文件 or 目录
                let type = item.type;
                if(type === 'dir'){
                    fs.mkdir(`${rootName}/${item.name}`,(err) =>{
                        if(err){
                            throw err;
                        }
                    })
                    console.log(`${rootName}/${item.name}`);
                }else if (type === 'file') {
                    fs.writeFile(`${rootName}/${item.name}`,item.content,(err) =>{
                        if(err){
                            console.log('failed')
                            throw err;
                        }
                    })
                    console.log(`${rootName}/${item.name}`);
                }
            })
        })
        break;
    case 'help':
        // TODO 
        break;
    case '--version':
        // TODO 
        break;
    case'-v':
        // TODO 
        break;
    default:
        console.log('Wrong support')
        break;
    }

7.代码已上传,里面也加了readme.txt便于快速操作。** 戳我--->代码地址 **
8.不知读者是否已经简单了解命令行工具的原理,欢迎留言交流。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容