工程规范

作用

项目使用各种工具来规范代码风格，保证代码的一致性和可读性，项目规范的原则是严谨而不严格。

Web 项目开发的一体化工具链，格式化代码、修复错误，不止于此，就在一瞬间！

biome 是一个基于 rust 的现代化工具，主要用于格式化代码、修复错误，现阶段的功能能满足大部分的需求。

bash

pnpm run check # 检查代码和代码格式
pnpm run check:fix  # 格式化代码和修复错误

eslint 和 prettier 依然是最热门的代码检查和格式化工具，项目默认不支持，推荐一份非常优秀的 ESLint 配置。

以下是最简单的使用方式：

bash

pnpm i -D eslint @antfu/eslint-config

// eslint.config.mjs
import antfu from '@antfu/eslint-config';

export default antfu();

项目使用 husky + lint-staged，在提交代码的时候进行代码风格校验。

提交代码的时候，会检查的暂存区的文件，自动执行 pnpm check:fix，自动格式化代码和修复代码。如果存在错误，则无法提交代码。

项目默认没有使用 commitlint 工具，可根据团队需求自行添加。

一份常见的 commit 规范：