如何打造乙個屬於自己的命令列工具

平常經常使用一些npm cli工具，你是否好奇這些工具又是怎麼開發出來的呢？接下來這篇文章，就會介紹如何利用node.js開發乙個屬於你自己的命令列工具。

首先，我們需要先建立乙個基本的專案結構：

mkdir git-repo-cli cd git-repo-cli npm init #初始化專案

接著我們建立所需的檔案：

接著我們先來寫乙個簡單的入口程式，在index.js檔案中**如下：

const chalk = require('chalk');
const clear = require('clear');
const figlet = require('figlet');
const commander = require('commander');
commander
.command('init')
.description('hello world')
.action(() => )));
});commander.parse(process.ar**);
if (!commander.args.length)

上面的**中引用了chalk,clear,figlet和commander這幾個npm庫,，其中chalk負責命令列不同顏色文字的顯示，便於使用者使用。clear庫負責清空命令列介面，figlet可以在命令列中以ascii art形式顯示文字。最後commander庫就是用來實現命令列介面最主要的庫。

寫完**後，我們可以在命令列中輸入如下**啟動：

node index.js init

接著我們就可以看到這樣的結果：

把基本的架子搭起來後，我們就可以開始寫功能模組的**了。

在lib/files.js檔案中，主要要實現以下兩個功能：:

const fs = require('fs');
const path = require('path');
module.exports =  catch (err) 
},isgitrepository: () => }};

在使用者在執行命令列工具的時候，需要收集一些變數資訊，因此，可以我們需要利用inquirer這個npm庫來實現「詢問模組」。

const inquirer = require('inquirer');
module.exports =  else }},
else }}
];return inquirer.prompt(questions);}}

為了實現和github的介面通訊，需要獲得token認證資訊。因此，在lib/github_credentials.js檔案中，我們獲得token,並借助configstore庫寫入package.json檔案中。

const configstore = require('configstore');
const pkg = require('../package.json')
const octokit = require('@octokit/rest')();
const _ = require('lodash');
const inquirer = require("./inquirer");
const conf = new configstore(pkg.name);
module.exports = ,
githubauth: (token) => );
},getstoredgithubtoken: () => ,
setgithubcrendeitals: async () => , credentials))},
registernewtoken: async () => );
const token = response.data.token;
if (token)  else 
} catch(error) }}

其中@octokit/rest是node端與github通訊主要的庫。

接下來就可以寫我們的介面了：

// index.js
const github = require('./lib/gitub_credentials');
commander.
command('check-token')
.description('check user github credentials')
.action(async () => 
console.log(token);
});

最後，在命令列中輸入如下命令：

node index.js check-token

它會先會在configstore的預設資料夾下~/.config尋找token, 如果沒有發現的話，就會提示使用者輸入使用者名稱和密碼後新建一場新的token。

有了token後，就可以執行github的很多的操作，我們以新建倉庫為例：

askrepositorydetails: () =>  else }},
,];return inquirer.prompt(questions);
},askignorefiles: (filelist) => ];
return inquirer.prompt(questions);
}

接著，實現對應的新建倉庫、新建.gitignore檔案等操作：

// create_a_repo.js
const _ = require('lodash');
const fs = require('fs');
const git = require('******-git')();
const inquirer = require('./inquirer');
const gh = require('./github_credentials');
module.exports = ;
try  catch (error) 
},creategitignore: async () =>  else 
} else 
},setuprepo: async (url) =>  catch (err) }}

最後，在index.js檔案中新建乙個create-repo的命令，執行整個流程。

// index.js
commander
.command('create-repo')
.description('create a new repo')
.action(async () => 
} catch (error) }}
})

寫完**後，在命令列中執行如下命令即可：

node index.js create-repo

如何打造乙個屬於自己的命令列工具

如何了解乙個命令列man

打造乙個全命令列的 Android 構建系統

如何建立屬於自己的乙個論壇

如何打造乙個屬於自己的命令列工具

如何了解乙個命令列man

打造乙個全命令列的 Android 構建系統

如何建立屬於自己的乙個論壇

相關推薦