damo-vite-vue3-cli

Damo Vue3 项目模板 CLI 工具

简介

damo-vite-vue3-cli 是一个命令行工具，用于帮助你快速创建 Vue3 项目模板。它通过提供交互式的方式让你命名项目，并自动将模板文件复制到目标目录，简化了创建新 Vue3 项目的流程。

安装

在使用此工具之前，请确保你的系统已经安装了 Node.js 和 npm。你可以使用以下命令全局安装该工具：

npm install -g damo-vite-vue3-cli

使用方法

使用命令行工具

安装完成后，你可以使用 private-vue-create 命令来创建新的 Vue3 项目。

方法一：直接指定项目名称

你可以在命令行中直接指定项目名称：

private-vue-create my-new-vue-project

这将在当前工作目录下创建一个名为 my-new-vue-project 的新项目。

方法二：使用交互式模式

如果你没有在命令行中指定项目名称，工具将进入交互式模式，并提示你输入项目名称。默认的项目名称是 my-vue-app。

private-vue-create

你将看到以下提示：

Enter project name: (my-vue-app)

你可以输入你想要的项目名称，或者直接按回车键使用默认名称。

创建后的操作

项目创建完成后，工具会将 vue-project-template 目录中的模板文件复制到目标目录。同时，它会更新新项目的 package.json 文件中的 name 字段，使其与你指定的项目名称相匹配。

项目成功创建后，你将看到一条成功消息，其中包含启动项目的说明：

✅ Success! Created my-new-vue-project at /path/to/my-new-vue-project

Run:
  cd my-new-vue-project
  npm install
  npm run dev

项目结构

该工具的主要文件和目录如下：

• package.json：定义了工具的基本信息、依赖项和 CLI 的入口点。
• cli.js：CLI 的主要逻辑，包括交互式提示、复制模板文件和更新 package.json 文件。
• vue-project-template：包含 Vue3 项目的模板文件。

依赖项

该工具依赖于以下 npm 包：

• chalk：用于在控制台显示彩色消息。
• fs-extra：一个扩展了 Node.js 内置 fs 模块的模块，提供了更方便的文件系统操作，如复制目录和读写 JSON 文件。
• inquirer：用于实现交互式命令行提示。

许可证

此工具由 damo 开发。有关许可证的更多信息，请查看项目仓库中的相关文件。

问题反馈

如果你在使用过程中遇到任何问题或有改进建议，请在项目的 GitHub 仓库中提交 issue。