构建 CLI（脚手架）与发布 npm 包

2023-11-07 08:22:40

简介

命令行界面（CLI）是一种计算机用户界面，使用户可以通过命令行输入指令与计算机交互。在前端开发中，CLI 工具十分常见，例如 create-react-app（用于创建新的 React 项目）、vue-cli（用于创建新的 Vue 项目）等。

npm 包是 Node.js 的软件包管理系统，用于发布、安装、共享和更新 Node.js 模块。通过 npm，您可以轻松地将您的项目代码分享给其他开发人员，并使用其他开发人员发布的代码。

构建自定义 CLI (脚手架)

要构建自定义 CLI，您需要遵循以下步骤：

安装必要的工具

您需要安装 Node.js 和 npm。
创建一个新的 Node.js 项目

使用以下命令创建一个新的 Node.js 项目：
```
mkdir my-cli
cd my-cli
npm init -y
```
安装 Commander 库

Commander 是一个用于构建命令行界面的库。使用以下命令安装它：
```
npm install commander
```

创建 CLI 脚手架

创建一个名为 index.js 的文件，并添加以下代码：

const program = require('commander');

program
  .command('create <project-name>')
  .description('Create a new project')
  .action((projectName) => {
    console.log('Creating project:', projectName);
  });

program.parse(process.argv);

这个脚本定义了一个名为 create 的命令，用于创建一个新项目。

测试 CLI 脚手架

使用以下命令测试 CLI 脚手架：
```
node index.js create my-project
```
您应该看到以下输出：
```
Creating project: my-project
```

发布 npm 包

要发布 npm 包，您需要遵循以下步骤：

创建一个 package.json 文件

创建一个名为 package.json 的文件，并添加以下代码：

{
  "name": "my-cli",
  "version": "1.0.0",
  "description": "My CLI tool",
  "main": "index.js",
  "scripts": {
    "test": "node index.js"
  },
  "keywords": ["cli", "脚手架", "nodejs", "npm"]
}

添加 README.md 文件

创建一个名为 README.md 的文件，并添加以下代码：

# My CLI

This is a CLI tool that I created.

## Installation

To install this CLI tool, run the following command:

npm install -g my-cli


## Usage

To use this CLI tool, run the following command:

my-cli create


This will create a new project called `project-name`.

## Contributing

Contributions are welcome! Please read the [contributing guidelines](https://github.com/username/my-cli/blob/master/CONTRIBUTING.md) before submitting a pull request.