圖片源自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.不知讀者是否已經簡單了解命令行工具的原理,歡迎留言交流。