基于node的cli工具開發(fā)使用詳解

更新時(shí)間：2023年03月31日 08:53:07 作者：小豬努力學(xué)前端

這篇文章主要為大家介紹了基于node的cli工具開發(fā)使用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

如果文章對你有幫助的話，記得一鍵三連喲。有問題和疑惑的話也可以在評論區(qū)留言。我會第一時(shí)間回復(fù)大家，如果覺得我的文章哪里有知識點(diǎn)錯(cuò)誤的話，也懇請能夠告知，把錯(cuò)的東西理解成對的，無論在什么行業(yè)，都是致命的。

背景

公司內(nèi)部有維護(hù)admin和h5兩套基礎(chǔ)模版，但是每次新項(xiàng)目需要打開gitlab找git地址 clone，稍微有點(diǎn)麻煩，所以集成一個(gè)工具，方便使用??????。

功能特性

下載公司內(nèi)部前端模版

效果預(yù)覽

地址

taosiqi/web-cli

插件開發(fā)

推薦使用nrm管理npm源

創(chuàng)建用戶

npm adduser --registry http://127.0.0.1:4873/

發(fā)布

npm publish --registry http://127.0.0.1:4873/

使用

安裝

npm install web-cli -g --registry http://127.0.0.1:4873/

使用

web-cli create

實(shí)現(xiàn)原理

使用到的工具

chalk: 修改終端顏色
commander: 添加版本命令提示
inquirer: 命令行交互
minimis: 命令行解析
ora: 終端旋轉(zhuǎn)器
shelljs: 執(zhí)行shell命令
rimraf：刪除文件夾

package.json

{
  "name": "web-cli",
  "version": "0.0.5",
  "description": "前端腳手架",
  "main": "dist/src/service.js",
  "author": {
    "name": "taosiqi",
    "email":"thinlf97@gmail.com"
  },
  "keywords": [
    "rs",
    "cli"
  ],
  "bin": {
    "web-cli": "dist/src/bin/web-cli.js" //會注冊成全局可執(zhí)行文件
  },
  "scripts": {
    "dev": "tsc -w -p .",
    "build": "rimraf dist && tsc -p .",
    "test": "echo "Error: no test specified" && exit 1",
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
  },
}

web-cli.ts

#!/usr/bin/env node
// 第一行不可少，其作用是它告訴系統(tǒng)這個(gè)腳本需要用node解釋器來執(zhí)行。
// 這個(gè)文件主要是用來處理接受參數(shù)的入口文件，
const Service = require('../service') //引入我們的入口文件
const service = new Service() //實(shí)例化Service
const rawArgv = process.argv.slice(2)
const args = require('minimist')(rawArgv) //解析命令行參數(shù)
const command = args._[0]
// 執(zhí)行初始化
service.run(command, args, rawArgv)

service.ts

import program from 'commander'
import packageInfo from '../package.json'
import { create } from "./commands/create";
module.exports = class Service {
    constructor() {
        setupDefaultCommands() //設(shè)置默認(rèn)命令
    }
    run(_id, _args = {}, rawArgv = []) {
        program.parse(rawArgv, { from: 'user' })  //執(zhí)行相應(yīng)的命令
    }
}
// 設(shè)置默認(rèn)命令
const setupDefaultCommands = () => {
    program.version(packageInfo.version, '-v, --version', '輸出當(dāng)前版本號')
    program.helpOption('-h, --help', '獲取幫助')
    program.command('create').description('新建項(xiàng)目').alias('c').action(async () => {
        await create()
    })
    program.addHelpCommand(false)
}

create.ts

import shelljs from 'shelljs'
import inquirer from 'inquirer'
import * as fs from 'fs'
import rimraf from 'rimraf'
import log from '../utils/log'
const templateType = {
    type: 'list',
    message: '請選擇模版類型',
    name: 'type',
    choices: [
        {
            name: 'h5',
            value: 'vue3-h5-starter'
        },
        {
            name: 'admin',
            value: 'vue3-admin-starter'
        }
    ]
}
const templateName = [
    {
        type: 'input',
        message: '請輸入項(xiàng)目名稱:',
        name: 'name',
        validate: (val) => {
            return val !== ''
        }
    }
]
export const create = async () => {
    // 選擇模版類型
    let { type } = await inquirer.prompt([templateType])
    // 項(xiàng)目名稱
    let { name } = await inquirer.prompt(templateName)
    // 拼接git地址,自行替換「」字段
    const url = `git clone http://gitlab-ci-token:「token」@「ip/域名」/pinxin/${type}.git --depth 1`
    // 執(zhí)行clone
    await shelljs.exec(url)
    // 重命名
    await fs.renameSync(`./${type}`, `./${name}`)
    // 刪除無關(guān)文件
    await rimraf(`./${name}/.git`)
    await rimraf(`./${name}/.idea`)
    await rimraf(`./${name}/.vscode`)
    log.succeed('創(chuàng)建成功')
    log.info(`cd ${name}`)
    log.info(`pnpm install`)
}

以上就是基于node的cli工具開發(fā)使用詳解的詳細(xì)內(nèi)容，更多關(guān)于node cli開發(fā)工具的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: