Tanplate Docs

编辑器风格

VS Code 推荐扩展、保存时格式化、ESLint 修复和工作区体验。

仓库提交了 VS Code 工作区配置,目标是让保存动作与 CI 使用同一套 Prettier/ESLint 规则。其他编辑器可以使用,但必须保持相同的格式、换行和检查结果。

VS Code

打开仓库后安装 .vscode/extensions.json 的推荐扩展,至少包括 Prettier、ESLint、EditorConfig 和 TypeScript 相关支持。工作区已经配置:

  • editor.formatOnSave: true
  • Prettier 作为常见文本语言的默认 formatter
  • 保存时执行 source.fixAll.eslint
  • 两空格缩进、LF 和文件末尾换行
  • 文件嵌套、搜索排除和 Git 工作区体验

IDE 中部分纯样式 ESLint 诊断会静默,保存时仍会自动修复;终端 pnpm lint 保持权威。

同步共享配置

pnpm setup-arvin

该命令更新共享 ESLint、Prettier 和 VS Code settings 包,再重新生成工作区设置。执行后先检查 diff,避免覆盖项目专属的路由、文件 nesting 或语言配置。

其他编辑器

至少启用:

  1. 保存时运行仓库 Prettier。
  2. ESLint flat config 与 TypeScript language service。
  3. UTF-8、LF、两空格和 final newline。
  4. 不格式化生成的 Route Tree、.source.wrangler 和被根 ignore 声明的文件。

不要依赖编辑器显示的“无错误”作为完成条件;最终运行 代码格式 中的 workspace 或全仓命令。

On this page