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

作者: RookieDay | 来源:发表于2016-12-15 18:13 被阅读550次
    图片源自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.不知读者是否已经简单了解命令行工具的原理,欢迎留言交流。

    相关文章

      网友评论

      本文标题:Nodejs构建自己的全局命令行工具

      本文链接:https://www.haomeiwen.com/subject/clfjmttx.html