如何搭建一個自己cli

為什么要搭建cli

在前端開發中，在搭建好一套自己滿意的代碼架子后，希望以后可以在別的開發中也一直沿用。之前或許把這份代碼的結構再手動碼一份，但這樣的重復勞動其實搭建好自己的cli后，就可以通過幾個命令來完成了

搭建cli准備

首先新建自己cli項目完成初始化配置之后。然后完成以下步驟

npm init 

• 在package.json中新建bin對象，如下圖

  
  
   

  

  image.png
  
  

  這個對象中存放着之后需要執行的命令。

• 新建bin目錄，添加執行的js文件，注意這里的js文件需要以#!/usr/bin/env node這個開頭，表明用node執行
• 安裝搭建cli的包

  "dependencies": {
   "inquirer": "^4.0.0",
   "ora": "^1.3.0",
   "rimraf": "^2.6.2",
   "chalk": "^2.3.0",
   "commander": "^2.11.0",
   "download-git-repo": "^1.0.1"
  }
  

簡單介紹下面幾個包的作用
commander：設置一些node命令，如包的help、usage、version、parse輸入的參數，
download-git-repo：下載git上的模板，並存到本地,
chalk:可以修改輸出console顏色,
inquirer:用戶判斷，是否執行
ora：下載包時，產生loading的圖標
rimraf：刪除文件

編寫cli代碼

• 創建目錄文件chrys.js

  
  
   

  

  image.png
  
  

  定義版本號，及子命令和一些說明簡介

• 創建子命令文件 chrys-init.js
  

   

  1 .
   

  

  image.png
  
  定義用法，及轉化參數。
  

  2 .

  
  
   

  

  image.png
  描述幫助。
  3 .
  
   

  

  image.png
  
  獲取參數及存放位置。
  4 .
   

  

  image.png
  
  

  下載模板到對應文件夾

到此一個簡單的cli就搭建完成，那么我們如何使用它呢

使用

1 .本地調試或使用

node bin/chrys.js template-name project-name 

，或者

 npm install -g chrys init template-name project-name 

2 .發布到npm
首先需要注冊npm賬號，然后執行如下命令

npm login 
npm publish

每次發布版本號要更新，其次就是包的名字要唯一，假如被人使用只能換個名字了。
github地址：https://github.com/Chryseis/chryseis-cli

作者：ChrysAwesome
鏈接：https://www.jianshu.com/p/9d7efa19ffe9
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。