公司级框架如何快速搭建脚手架闲暇之余看了下公司级框架的实现，瞄到一个新的字眼oclif，触碰到了知识的盲区，了解后发现是

闲暇之余看了下公司级框架的实现，瞄到一个新的字眼oclif，触碰到了知识的盲区，了解后发现是一个快速生成cli的工具，是一个可以用来快速应用和推广业务模板，推广标准的工具。

什么是 oclif？

oclif 是一个由 Salesforce 开发并开源的命令行框架，它基于 Node.js 平台，并提供了一套强大的工具和模式来构建可扩展的命令行工具。oclif 的目标是帮助开发者快速构建出优雅、易用且功能丰富的 CLI 工具，同时提供良好的可维护性和扩展性。

oclif 的特性

oclif 提供了许多强大的特性，使得开发命令行工具变得更加简单和高效。以下是一些 oclif 的主要特性：

1. 自动化的命令行解析和参数处理

oclif 提供了命令行参数解析和处理的自动化机制，使得开发者无需手动处理命令行参数的解析和验证。通过定义命令的 flags、arguments 和选项，oclif 可以自动解析和转换命令行输入，并提供友好的错误提示和帮助信息。

2. 插件系统和可扩展性

oclif 的插件系统允许开发者通过简单地添加插件来扩展和定制 CLI 工具的功能。插件可以提供额外的命令、标志、模板和其他功能，使得 CLI 工具可以根据需要进行定制和扩展。

3. 自动生成的文档和帮助信息

基于命令行的参数定义和注释，oclif 可以自动生成帮助信息和文档。这使得用户可以通过命令行工具本身或使用 --help 参数来查看命令的用法和详细说明。

4. 调试和测试支持

oclif 提供了调试和测试命令行工具的支持。开发者可以使用调试器工具来逐行调试 CLI 工具的代码，同时也可以编写单元测试和集成测试来确保工具的正确性和稳定性。

使用 oclif 创建命令行工具的示例

确保已经在本地安装了 Node.js 和 npm。
在命令行中运行以下命令，安装 oclif 的核心库 @oclif/core：
```
npm install -g @oclif/core
```
创建一个新的目录，作为你的脚手架项目的根目录。
在脚手架项目的根目录中运行以下命令，使用 oclif 创建一个新的 CLI 项目：
```
npx oclif generate <your-cli-name>
```
这将使用 oclif 自动生成一个基本的 CLI 项目结构，其中 <your-cli-name> 是你自定义的 CLI 名称。
进入新创建的 CLI 项目目录：
```
cd <your-cli-name>
```
在该目录中，可以看到一些自动生成的文件和目录，其中包括 src/commands 目录，用于存放 CLI 命令的代码。

在 src/commands 目录中创建自己的 CLI 命令文件，例如 hello.ts，并在其中编写你的命令逻辑。示例代码如下：

import {Command} from '@oclif/core';

export default class HelloCommand extends Command {
  static description = 'A simple hello command';

  async run() {
    this.log('Hello, world!');
  }
}

在 src/commands/index.ts 文件中，将你的命令导入并添加到命令列表中，示例代码如下：

import {Command} from '@oclif/core';
import HelloCommand from './hello';

const commands: typeof Command[] = [
  HelloCommand
];

export default commands;

在根目录下的 src/index.ts 文件中，将 commands 导入并注册为你的 CLI 的命令，示例代码如下：

import {Cli} from '@oclif/core';
import commands from './commands';

class MyCli extends Cli {
  static description = 'My custom CLI tool';
  static flags = {};
  static args = [];
  commands = commands;
}

MyCli.run();

在终端中运行以下命令，以构建并链接你的 CLI 项目：
```
npm link
```
这将在全局 npm 目录中创建一个链接，使你可以在任何地方使用你的 CLI。
现在，你可以在终端中使用你的 CLI 命令了。例如，运行以下命令来执行你的 hello 命令：
```
<your-cli-name> hello
```
这将输出 "Hello, world!"。

这样，你就成功使用 oclif 创建了自己的脚手架，并添加了一个简单的命令。你可以根据需要在项目中添加更多的命令，并扩展功能。保持学习，共勉~