Appearance
脚手架核心预装一览
本文介绍 ArenaPro CLI 脚手架在新项目中默认预装的一些依赖,它们主要用于开发体验、代码质量和构建流程。
这些依赖都已经在脚手架里帮你配好了,一般情况下可以直接用,无需自己一项项从零搭。
1. 开发与构建相关
vite- 作为项目的前端构建工具,负责
npm run dev/npm run build。 - 提供快速热更新(HMR)和生产构建能力,是整个脚手架的“发动机”。
- 作为项目的前端构建工具,负责
vite-tsconfig-paths- 一个让 Vite 识别
tsconfig.json中paths路径别名的插件。 - 你可以在脚本里使用类似
@/src/...这类别名导入,而不用再在vite.config.ts里手动重复配置一长串相对路径。
- 一个让 Vite 识别
vite-plugin-arenapro-script- 专门为 ArenaPro 集成的 Vite 插件。
- 负责在构建时实现脚本自动上传至神岛地图中。
vite-plugin-checker- 一个在 Vite 中跑类型检查 / Lint 的插件。
- 开启后可以构建前看到 TypeScript 错误或 ESLint 报错。
typescript- TypeScript 编译器本体。
- 脚手架默认使用 TS 开发脚本,所以会预装一个版本并在 tsconfig 中做好基础配置。
npm-run-all- 一个帮助你串行 / 并行运行多个 npm scripts 的小工具。
- 在脚手架的
package.json里常用于:- 一条命令同时启动多个任务。
- 让复杂一点的脚本编排更可读,而不是堆很多
&&。
cross-env- 用于跨平台设置环境变量的工具。
- 解决 Windows / macOS / Linux 在
NODE_ENV=xxx这类写法上的差异问题。
2. 代码质量与规范相关
eslint- 用于代码风格和潜在问题检查。
- 脚手架会提供基础的 ESLint 配置,帮助你在开发阶段就发现一些常见错误(未使用变量、意外的 any、危险写法等)。
typescript-eslint- 让 ESLint 能理解 TypeScript 语法和类型信息的一套工具链。
- 搭配
eslint一起使用,可以在 TS 项目中获得更准确的静态检查。
prettier- 代码格式化工具,用于统一团队代码风格。
- 脚手架会预置基础配置,让你可以通过编辑器快速统一格式,避免「谁格式化了整个文件」这种 diff 污染。
husky- Git hooks 管理工具。
- 常用于在
git commit/git push前自动执行检查(如 lint、typecheck),避免明显错误进入仓库。 - 脚手架会预留好接入点,你可以按团队需要决定是否开启、具体要在钩子里跑哪些命令。
3. 业务辅助相关
i18next- 一个常用的国际化(i18n)库。
- 预装它是为了方便你在脚本中管理多语言文本(界面文案、提示信息等)。
- 如果你的地图暂时不需要做多语言,可以先不使用;将来要做国际化时,直接在项目里引入即可。