Logo文档

格式化和代码检查

在 NEXTDEVKIT 中使用 Biome 进行代码质量和一致性管理

🌟 为什么选择 Biome?

功能好处性能
🚀 快速性能用 Rust 编写,速度最快比替代品快 10 倍
🎯 一体化结合代码检查、格式化等功能单一工具,复杂性更低
🔧 零配置开箱即用无需配置
🛡️ 类型安全深度 TypeScript 集成更好的错误检测
🎨 一致的风格强制执行一致的代码风格减少代码审查时间
📦 小体积包最少依赖更快的 CI/CD 构建

📋 可用脚本

NEXTDEVKIT 提供了几个用于代码质量管理的 npm 脚本:

脚本命令用途
lintpnpm run lint检查代码质量而不更改
lint:fixpnpm run lint:fix自动修复代码检查问题
formatpnpm run format根据样式规则格式化代码

🔍 运行代码检查和格式化

检查代码质量

要检查您的代码而不进行更改:

# 使用 pnpm
pnpm run lint

此命令将:

  • 🔍 报告代码检查错误和警告
  • 📊 显示代码风格违规
  • ⚠️ 显示潜在的错误和问题
  • 📈 提供性能建议

修复代码问题

要自动修复代码检查问题:

# 使用 pnpm
pnpm run lint:fix

此命令将:

  • 🔧 修复可自动修复的问题
  • 📁 组织导入
  • 🎨 应用一致的格式化
  • 🔄 移除未使用的变量

格式化代码

要根据项目风格格式化您的代码:

# 使用 pnpm
pnpm run format

此命令将:

  • 🎨 应用一致的格式化
  • 📏 强制执行行长度限制
  • 🔤 标准化引号样式
  • 📐 修正缩进

⚙️ Biome 配置

项目的 Biome 配置在项目根目录的 biome.json 中定义:

biome.json
// biome.json