格式化和代码检查
在 MkSaaS 中使用 Biome 进行代码质量管理的文档
MkSaaS 使用 Biome 进行代码格式化和代码检查,以确保项目保持一致的代码质量。
Biome 在项目根目录中通过 biome.json 进行配置,此配置强制执行一致的代码风格并捕获常见错误。
运行代码检查和格式化
检查代码质量
要检查您的代码而不进行更改:
pnpm lint:check此命令报告格式和代码检查问题,不修改文件。需要自动修复时运行 pnpm lint。pnpm check 依次执行只读代码检查、TypeScript 检查、单元测试和生产构建。浏览器与支付沙箱测试见自动化测试。
格式化代码
要自动格式化您的代码:
pnpm run format这将根据项目的样式规则格式化所有支持的文件。
自定义规则
项目的 Biome 配置在 biome.json 中定义。以下是我们配置的简化视图:
{
"$schema": "https://biomejs.dev/schemas/2.5.5/schema.json",
"formatter": {
"enabled": true,
"indentStyle": "space",
"indentWidth": 2,
"lineWidth": 80
},
"assist": {
"actions": {
"source": {
"organizeImports": "off"
}
}
},
"linter": {
"enabled": true,
"rules": {
"recommended": true,
// 各种规则自定义...
}
},
"javascript": {
"formatter": {
"quoteStyle": "single",
"trailingCommas": "es5",
"semicolons": "always"
}
}
}MkSaaS 已自定义某些规则以更好地适应我们的开发工作流程,完整配置见项目根目录的 biome.json 文件。
有关如何自定义规则配置的更多信息,请参考 Biome 代码检查文档。
编辑器集成
Biome 与您的编辑器集成时效果最佳:
MkSaaS 为 Biome 提供了预配置的 VSCode/Cursor 设置:
{
"editor.defaultFormatter": "biomejs.biome",
"[javascript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescriptreact]": {
"editor.defaultFormatter": "biomejs.biome"
},
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"quickfix.biome": "explicit",
"source.organizeImports.biome": "explicit"
}
}这些设置确保:
- Biome 用作 JavaScript 和 TypeScript 文件的默认格式化器
- 保存时自动格式化文件
- 导入整理遵循项目配置,默认关闭
下一步
现在您了解了如何在 MkSaaS 中维护代码质量,探索这些相关主题:
MkSaaS文档