菜单

Create-Vite 工具

相关源文件

本文档涵盖了 create-vite CLI 工具,该工具提供脚手架能力,用于创建新的 Vite 项目。该工具提供了一个交互式界面,用于选择框架、配置项目模板以及初始化具有预配置启动代码的新开发环境。

有关框架模板本身的信息,请参阅 框架模板。有关部署和生产的考虑事项,请参阅 部署和生产

概述

create-vite 工具是一个独立的 CLI 包,它通过提供精选的流行前端框架模板来简化项目初始化。它作为一个交互式脚手架系统运行,引导用户完成项目设置决策,并生成配置正确的入门项目。

架构

核心组件

来源: packages/create-vite/src/index.ts1-681

框架配置系统

来源: packages/create-vite/src/index.ts55-66 packages/create-vite/src/index.ts68-323

命令行界面

参数处理

该工具使用 mri 进行命令行参数解析,其接口如下:

参数别名类型描述
--template-t字符串直接指定模板名称
--help-h布尔值显示帮助信息
--overwrite布尔值覆盖现有目录

来源: packages/create-vite/src/index.ts22-30

帮助系统

帮助信息显示了可用模板及其颜色编码的框架指示符

来源: packages/create-vite/src/index.ts34-52

交互式工作流

项目初始化流程

来源: packages/create-vite/src/index.ts336-543

框架和变体选择

选择过程使用带颜色编码选项的交互式提示

来源: packages/create-vite/src/index.ts424-459 packages/create-vite/src/index.ts473-488

模板系统

模板目录结构

模板存储在遵循 template-{name} 模式的目录中

来源: packages/create-vite/src/index.ts492-496 packages/create-vite/src/index.ts330-332

文件操作

脚手架过程涉及多个文件操作

来源: packages/create-vite/src/index.ts507-510 packages/create-vite/src/index.ts498-505 packages/create-vite/src/index.ts549-556

包管理器集成

命令规范化

该工具适配不同包管理器的命令

来源: packages/create-vite/src/index.ts637-676 packages/create-vite/src/index.ts604-612

特殊处理

React SWC 变体

React 模板通过后处理支持 SWC 变体

来源: packages/create-vite/src/index.ts465-469 packages/create-vite/src/index.ts520-522 packages/create-vite/src/index.ts614-630

验证函数

输入验证确保项目完整性

来源: packages/create-vite/src/index.ts558-571 packages/create-vite/src/index.ts545-547

测试基础设施

该工具包含全面的测试覆盖率

来源: packages/create-vite/__tests__/cli.spec.ts1-155

发布集成

create-vite 工具与 Vite 的发布流程集成

来源: scripts/releaseUtils.ts53-70 scripts/release.ts13