在現(xiàn)代軟件開發(fā)中，創(chuàng)建 定制化的命令行工具(CLI) 已成為滿足公司業(yè)務(wù)需求的關(guān)鍵一環(huán)。這類工具可以輔助執(zhí)行諸如代碼檢查、項(xiàng)目初始化等任務(wù)。為了提高開發(fā)效率并簡(jiǎn)化維護(hù)過程，我們將功能模塊化，并通過多個(gè)子包來(lái)組織這些功能。本文將介紹如何使用 Lerna 來(lái)管理一個(gè)多包項(xiàng)目，并基于 Commander 實(shí)現(xiàn)一個(gè)基礎(chǔ)的 CLI 腳手架框架。

初始化：創(chuàng)建入口文件

項(xiàng)目結(jié)構(gòu)

我們以 ice-basic-cli 為例，這是一個(gè)空的 CLI 項(xiàng)目。首先，通過 lerna init 初始化 Lerna 項(xiàng)目，然后使用 lerna create cli 創(chuàng)建入口子包。這一步將在項(xiàng)目的根目錄下生成 packages/cli 文件夾，其內(nèi)部結(jié)構(gòu)如下：

ice-basic-cli/
├── .git/
├── packages/
│   └── cli/
│       ├── __tests__
│       │   └── cli.test.js
│       ├── lib/
│       │   └── index.js
│       ├── bin/
│       │   └── cli.js
│       ├── package.json
│       └── README.md
├── .gitignore
├── lerna.json
└── package.json

CLI 入口配置

cli/bin/cli.js 是 CLI 的入口文件，它負(fù)責(zé)接收命令行參數(shù)并調(diào)用相應(yīng)的邏輯處理函數(shù)。為確保腳本可執(zhí)行，我們?cè)谖募敳刻砑恿?shebang 行 (#!/usr/bin/env node)，并且導(dǎo)入了 lib/index.js 中定義的入口函數(shù)。

// bin/cli.js
#!/usr/bin/env node
import entry from "../lib/index.js";
entry(process.argv);

對(duì)于不熟悉初始化命令中的 shebang 行（#!/usr/bin/env node）或 bin 入口文件概念的朋友，建議參考 Node.js 構(gòu)建命令行工具：實(shí)現(xiàn) ls 命令的 -a 和 -l 選項(xiàng) 這篇文章，它提供了詳細(xì)的解釋和示例。

命令行接口實(shí)現(xiàn)

lib/index.js 提供了 CLI 的核心邏輯，包括對(duì) Commander 的初始化和自定義命令的注冊(cè)。這里我們定義了一個(gè)簡(jiǎn)單的 init 命令。

import { program } from 'commander';
import createCli from './createCli.js';
export default function (args) {
    const cli = createCli();
   
    // 定義命令及其行為
    cli.command('init [name]')
        .description('初始化新項(xiàng)目')
        .action((name) => {
            console.log(`>> Initializing project: ${name}`);
        });
    cli.parse(args);
}

同時(shí)，在 lib/createCli.js 中，我們封裝了 Commander 的初始化設(shè)置，使得其他部分可以復(fù)用此配置。

import { program } from "commander";
export default function createCli() {
  return program
    .name("@ice-basic-cli/cli")
    .version("0.0.1", "-v, --version", "顯示當(dāng)前版本")
    .option("-d, --debug", "開啟調(diào)試模式", false);
}

包配置與依賴安裝

為了使我們的 CLI 可以全局調(diào)用，需要正確配置 package.json 中的 bin 字段指向入口文件。此外，我們還指定了 "type": "module" 以啟用 ES Module 支持，從而保證與最新的 JavaScript 生態(tài)系統(tǒng)的兼容性。

{  
  "name": "@ice-basic-cli/cli",
  "version": "0.0.1",
  "main": "bin/cli.js",
    "bin": {
      "@ice-basic-cli/cli": "./bin/cli.js"
  },
 "type": "module",
 ...
}

接下來(lái)，通過 cnpm install commander --save --workspace=packages/cli 安裝所需的 Commander 庫(kù)，并通過 npm link --workspace=packages/cli 創(chuàng)建本地符號(hào)鏈接以便測(cè)試。

模塊化選擇：ES Modules vs CommonJS

在項(xiàng)目中，我們選擇了 ES Modules 作為默認(rèn)的模塊系統(tǒng)，而非傳統(tǒng)的 CommonJS。這是因?yàn)?ES Modules 更加現(xiàn)代化，提供了更好的互操作性和靜態(tài)分析支持。更重要的是，隨著越來(lái)越多的庫(kù)開始采用 ES Modules 格式，保持一致的模塊化標(biāo)準(zhǔn)有助于減少潛在的問題，確保項(xiàng)目的長(zhǎng)期可持續(xù)性。

完成上述配置后，在 Git Bash 中運(yùn)行命令 npx @ice-basic-cli/cli 可以看到如下結(jié)果：

1_入口文件.png

抽象 Command 類：構(gòu)建模塊化 CLI 命令

為了讓命令行工具（CLI）中的命令更加實(shí)用，并能作為獨(dú)立的子包使用，我們將命令邏輯抽象為一個(gè)通用的 Command 父類。這樣不僅提高了代碼的可維護(hù)性和復(fù)用性，也為后續(xù)擴(kuò)展奠定了基礎(chǔ)。

定義公共的 Command 父類

首先，我們使用 lerna create command 創(chuàng)建一個(gè)新的子包來(lái)存放 Command 父類。這將在項(xiàng)目的 packages/ 目錄下生成一個(gè)新的文件夾 command，其中包含所有必要的文件結(jié)構(gòu)。

在 command/lib/command.js 中定義 Command 類，該類封裝了創(chuàng)建命令的基本邏輯，同時(shí)提供鉤子函數(shù)以支持命令執(zhí)行前后的自定義行為。

class Command {
  constructor(instance) {
    if (!instance) {
      throw new Error("Command instance must not be null");
    }
    this.program = instance;
    const cmd = this.program.command(this.command);
    cmd.description(this.description);
    cmd.usage(this.usage);
    // 添加命令生命周期鉤子
    cmd.hook('preAction', () => this.preAction());
    cmd.hook('postAction', () => this.postAction());
    // 添加命令選項(xiàng)
    if (this.options?.length > 0) {
      this.options.forEach(option => cmd.option(...option));
    }
    // 設(shè)置命令的行為
    cmd.action((...params) => this.action(...params));
  }
  get command() {
    throw new Error("The 'command' getter must be implemented in a subclass.");
  }
  get description() {
    throw new Error("The 'description' getter must be implemented in a subclass.");
  }
  get options() {
    return [];
  }
  get usage() {
    return '[options]';
  }
  action(...params) {
    throw new Error("The 'action' method must be implemented in a subclass.");
  }
  preAction() {}
  postAction() {}
}
export default Command;

接著，確保 package.json 文件中正確配置了名稱和模塊類型：

{    
    "name": "@ice-basic-cli/command",
    "type": "module",
}

實(shí)現(xiàn)具體的子類命令

接下來(lái)，我們創(chuàng)建一個(gè)特定的命令子類 InitCommand 來(lái)實(shí)現(xiàn) init 功能。通過 lerna create init 創(chuàng)建新的子包，修改 package.json 中的配置：

{
    "name": "@ice-basic-cli/init",
    "type": "module",
}

并安裝 @ice-basic-cli/command 作為依賴：

npm install @ice-basic-cli/command --workspace=packages/cli

然后，在 init/lib/init.js 中實(shí)現(xiàn)繼承自 Command 的 InitCommand 類：

"use strict";
import Command from "@ice-basic-cli/command";
class InitCommand extends Command {
  get command() {
    return "init [name]";
  }
  get options() {
    return [["-f, --force", "是否強(qiáng)制更新", false]];
  }
  get description() {
    return "初始化項(xiàng)目";
  }
  action([name], { force }) {
    console.log(`Initializing project: ${name}, Force mode: ${force}`);
  }
}
function createInitCommand(instance) {
  return new InitCommand(instance);
}
export default createInitCommand;

最后一步是將新創(chuàng)建的 InitCommand 整合進(jìn)主 CLI 應(yīng)用。為此，在 cli 子包中添加 @ice-basic-cli/init 依賴：

npm install @ice-basic-cli/init --workspace=packages/cli

并修改 cli/lib/index.js 文件，使其引用并注冊(cè) InitCommand：

"use strict";
import createCli from "./createCli.js";
import createInitCommand from "@ice-basic-cli/init";
export default function (args) {
  const cli = createCli();
  createInitCommand(cli);
  cli.parse(args);
}

此時(shí)，運(yùn)行 npx @ice-basic-cli/cli 時(shí)，能夠看到與之前一致的結(jié)果，但現(xiàn)在的架構(gòu)更加模塊化，便于維護(hù)和擴(kuò)展。

工具函數(shù)的封裝與集成

在構(gòu)建復(fù)雜CLI工具時(shí)，通常會(huì)遇到一些通用的功能需求，比如路徑判斷、日志記錄等。為了提高代碼復(fù)用性和項(xiàng)目的模塊化程度，我們將這些功能封裝為獨(dú)立的子包，確保它們可以在項(xiàng)目中的任何地方使用。

創(chuàng)建 utils 子包

首先，通過 lerna create utils 命令創(chuàng)建一個(gè)新的子包來(lái)存放工具函數(shù)，并修改默認(rèn)生成的文件結(jié)構(gòu)以適應(yīng) ES Modules 標(biāo)準(zhǔn)。具體步驟如下：

重命名并配置入口文件：將 lib/util.js 重命名為 lib/index.js，并在 package.json 中指定正確的入口點(diǎn)。
```
{
    "name": "@ice-basic-cli/utils",
    "main": "lib/index.js",
    "type": "module",
}
```
實(shí)現(xiàn)調(diào)試狀態(tài)檢測(cè)：在 lib/isDebug.js 中定義一個(gè)簡(jiǎn)單的函數(shù)用于判斷是否啟用了調(diào)試模式。
```
function isDebug() {
  return process.argv.includes("--debug") || process.argv.includes("-d");
}
export default isDebug;
```

統(tǒng)一封裝日志輸出：創(chuàng)建 lib/log.js 文件，借助 npmlog 庫(kù)實(shí)現(xiàn)統(tǒng)一的日志格式。首先安裝依賴：

npm install npmlog --save --workspace=packages/utils

然后編寫代碼：

import log from 'npmlog';
import isDebug from './isDebug.js';

if (isDebug()) {
  log.level = "verbose";
} else {
  log.level = "info";
}

log.heading = "ice-basic-cli";
log.addLevel("success", 2000, { fg: "green", bold: true, bg: "red" });
export default log;

處理 ES Module 的路徑問題：由于 ES Modules 不直接支持 __filename 和 __dirname，我們創(chuàng)建 lib/getPath.js 來(lái)提供替代方案。

import { fileURLToPath } from "url";
import { dirname as pathDirname } from "path";
export function dirname(importMeta) {
  const file = filename(importMeta);
  return file !== "" ? pathDirname(file) : "";
}
export function filename(importMeta) {
  return importMeta.url ? fileURLToPath(importMeta.url) : "";
}

導(dǎo)出工具函數(shù)：最后，在 lib/index.js 中導(dǎo)出所有工具函數(shù)，以便其他模塊可以方便地引用。

"use strict";
import log from "./log.js";
import isDebug from "./isDebug.js";
import { dirname, filename } from "./getPath.js";
export { log, isDebug, dirname, filename };

集成工具函數(shù)到 CLI 子包

完成 utils 子包后，我們需要將其集成到主 CLI 應(yīng)用中。這一步驟包括安裝依賴以及增強(qiáng)命令行接口的功能。

安裝工具函數(shù)包

執(zhí)行以下命令安裝 @ice-basic-cli/utils 作為依賴：

npm install @ice-basic-cli/utils --workspace=packages/cli

增強(qiáng)命令行接口功能

接下來(lái)，我們可以進(jìn)一步完善 cli/lib/createCli.js 文件，添加自動(dòng)獲取 package.json 版本號(hào)和名稱的能力，加入 NodeJS 版本校驗(yàn)，并監(jiān)聽未知命令。此外，還需要安裝幾個(gè)輔助庫(kù)：

npm install semver chalk fs-extra --save --workspace=packages/cli

下面是更新后的 createCli.js 文件：

"use strict";
import { program } from "commander";
import semver from "semver";
import { dirname, log } from "@ice-basic-cli/utils";
import { resolve } from "path";
import fse from "fs-extra";
import chalk from "chalk";

const __dirname = dirname(import.meta);
const pkgPath = resolve(__dirname, "../package.json");
const pkg = fse.readJSONSync(pkgPath);

function preAction() {
  checkNodeVersion();
}
const LOWEST_NODE_VERSION = "18.0.0";
function checkNodeVersion() {
  if (!semver.gte(process.version, LOWEST_NODE_VERSION)) {
    const message = `ice-basic-cli 需要安裝 ${LOWEST_NODE_VERSION} 或更高版本的 Node.js`;
    throw new Error(chalk.red(message));
  }
}

export default function createCli() {
  program
    .name(Object.keys(pkg.bin)[0])
    .usage("<command> [options]")
    .version(pkg.version)
    .option("-d, --debug", "是否開啟調(diào)試模式", false)
    .hook("preAction", preAction)
    .on("option:debug", function () {
      if (program.opts().debug) {
        log.verbose("debug", "launch debug mode");
      }
    })
    .on("command:*", function (obj) {
      log.info("未知命令：" + obj[0]);
    });
  return program;
}

添加全局錯(cuò)誤處理

為了提升用戶體驗(yàn)，我們還在 cli/lib/index.js 中增加了全局錯(cuò)誤捕獲機(jī)制，確保未處理的異常和未捕獲的 Promise 拒絕不會(huì)導(dǎo)致程序崩潰。

"use strict";
import createInitCommand from "@ice-basic-cli/init";
import createCli from "./createCli.js";
import { isDebug, log } from "@ice-basic-cli/utils";

export default function (args) {
  const program = createCli();
  createInitCommand(program);
  program.parse(args);
}

process.on("uncaughtException", (e) => printErrorLog(e, "uncaughtException"));
process.on("unhandleRejection", (e) => printErrorLog(e, "unhandleRejection"));

function printErrorLog(e) {
  if (isDebug()) {
    log.info(e);
  } else {
    log.info(e.message);
  }
}

優(yōu)先使用本地依賴

最后，我們可以通過引入 import-local 來(lái)優(yōu)化 bin/cli.js 文件，使得如果本地項(xiàng)目存在同名命令行工具，則優(yōu)先使用本地版本。這樣做不僅保證了開發(fā)環(huán)境的一致性，還能加快命令執(zhí)行速度。

首先安裝依賴：

npm install import-local --save --workspace=packages/cli

然后修改 bin/cli.js 文件：

#!/usr/bin/env node
import importLocal from "import-local";
import { log, filename } from "@ice-base-cli/utils";
import entry from "../lib/index.js";
const __filename = filename(import.meta);

if (importLocal(__filename)) {
  log.info("cli", "使用本次 cli");
} else {
  log.info("遠(yuǎn)程 cli");
  entry(process.argv.slice(2));
}

以上便是整個(gè)多包框架的構(gòu)建過程。通過這種方式，我們不僅提高了CLI工具的功能性和靈活性，還增強(qiáng)了其可維護(hù)性和擴(kuò)展性。

發(fā)布 npm

以 @組織名/包名的格式發(fā)布 NPM 包，首先需要在 npmjs.com 上注冊(cè)一個(gè)組織（Organization）。

2_npm 注冊(cè).png

在發(fā)布前，建議更新每個(gè)子包的版本號(hào)。由于我們對(duì)整個(gè)項(xiàng)目進(jìn)行了修改，采用一鍵發(fā)布的方式更為方便。只需執(zhí)行以下命令即可發(fā)布所有修改過的子包：

npm publish --workspaces --access=public

該命令會(huì)遍歷所有的工作區(qū)，檢查是否有新的改動(dòng)需要發(fā)布，并將這些改動(dòng)以公共訪問權(quán)限發(fā)布到 NPM。

如果你對(duì)前端工程化有興趣，或者想了解更多相關(guān)的內(nèi)容，歡迎查看我的其他文章，這些內(nèi)容將持續(xù)更新，希望能給你帶來(lái)更多的靈感和技術(shù)分享~

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

構(gòu)建模塊化 CLI：Lerna + Commander 打造靈活的基礎(chǔ)腳手架

構(gòu)建模塊化 CLI：Lerna + Commander 打造靈活的基礎(chǔ)腳手架

初始化：創(chuàng)建入口文件

項(xiàng)目結(jié)構(gòu)

CLI 入口配置

命令行接口實(shí)現(xiàn)

包配置與依賴安裝

模塊化選擇：ES Modules vs CommonJS

抽象 Command 類：構(gòu)建模塊化 CLI 命令

定義公共的 Command 父類

實(shí)現(xiàn)具體的子類命令

工具函數(shù)的封裝與集成

創(chuàng)建 utils 子包

集成工具函數(shù)到 CLI 子包

安裝工具函數(shù)包

增強(qiáng)命令行接口功能

添加全局錯(cuò)誤處理

優(yōu)先使用本地依賴

發(fā)布 npm

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九 欧美,1769亚洲,黄色成人av

構(gòu)建模塊化 CLI：Lerna + Commander 打造靈活的基礎(chǔ)腳手架

初始化：創(chuàng)建入口文件

項(xiàng)目結(jié)構(gòu)

CLI 入口配置

命令行接口實(shí)現(xiàn)

包配置與依賴安裝

模塊化選擇：ES Modules vs CommonJS

抽象 Command 類：構(gòu)建模塊化 CLI 命令

定義公共的 Command 父類

實(shí)現(xiàn)具體的子類命令

工具函數(shù)的封裝與集成

創(chuàng)建 utils 子包

集成工具函數(shù)到 CLI 子包

安裝工具函數(shù)包

增強(qiáng)命令行接口功能

添加全局錯(cuò)誤處理

優(yōu)先使用本地依賴

發(fā)布 npm

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av