如何保证代码质量?

0 阅读2分钟

一、编码阶段:从源头控制质量

1. 统一代码规范(强制执行)

核心目标:减少风格差异,提高可读性

常见工具:

  • ESLint:代码规范校验
  • Prettier:自动格式化
  • Stylelint:样式规范

👉 实战建议:

  • ESLint + Prettier 联动(避免冲突)
  • 提交前自动校验(很关键)
lint-staged + husky

2. 类型约束(强烈建议你加强)

你已经在学 TS,这一步很关键:

  • 使用 TypeScript
  • 开启严格模式:
{
  "strict": true
}

👉 好处:

  • 提前发现 bug(编译期)
  • API、数据结构更清晰
  • 重构更安全

3. 代码设计原则(避免“烂代码”)

重点掌握几个:

  • 单一职责(函数不要又查数据又改 UI)
  • 避免超大组件(React/Vue 常见问题)
  • 抽离 hooks / composables

👉 举个前端常见反例:

// ❌ 又请求数据又渲染又处理逻辑

✅ 改进:

  • hooks:处理数据
  • component:只负责展示

二、开发流程:防止“烂代码进入仓库”

4. Git 提交规范

推荐:

  • commit message 规范(如:feat / fix / refactor)

工具:

  • commitlint

5. Code Review(核心环节)

这是最重要的一步,没有之一

Review 重点:

  • 逻辑是否清晰
  • 是否有重复代码
  • 命名是否合理
  • 是否影响性能

👉 建议你在团队推动:

  • 必须 PR 才能合并
  • 至少 1 人 Review

6. 自动化检查(CI/CD)

工具:

  • GitHub Actions
  • Jenkins

检查内容:

  • lint
  • test
  • build 是否成功

三、测试体系:保证“功能正确”

7. 单元测试(基础但重要)

工具:

  • Jest
  • Vitest

👉 测什么:

  • 工具函数
  • hooks
  • 复杂逻辑

8. 组件测试 / E2E

工具:

  • Cypress
  • Playwright

👉 场景:

  • 登录流程
  • 表单提交
  • 页面跳转

四、运行期质量(很多人忽略)

9. 监控 & 错误上报

工具:

  • Sentry

👉 作用:

  • 捕获线上 JS 报错
  • 定位问题用户、环境

10. 性能监控

关注:

  • 首屏时间
  • API 响应
  • 大表格性能(你项目里很多)

工具:

  • Lighthouse
  • Web Vitals

五、前端工程化(你这个阶段必须强化)

你现在的项目(性能平台)其实很适合做这些👇

11. 模块化 & 分层

建议结构:

/api
/hooks
/components
/pages
/utils

12. 公共能力沉淀

比如你项目中:

  • 表格(带筛选)
  • 导出 Excel / PDF
  • ECharts 封装

👉 建议:

  • 做成通用组件库(内部)

六、给你一套“最实用组合”(推荐直接用)

如果你现在要提升项目质量,可以直接这样搭:

TypeScript + ESLint + Prettier + Husky + lint-staged
+ Jest/Vitest + Playwright
+ GitHub Actions
+ Sentry

七、给你的进阶建议(结合你背景)

你现在已经不是初级了,可以重点提升:

👉 1. 从“写代码” → “设计代码”

  • 抽象能力
  • 可扩展性

👉 2. 从“个人能力” → “团队规范”

  • 推动 code review
  • 推动工程化

👉 3. 从“功能完成” → “长期维护”

  • 可读性 > 炫技
  • 稳定性优先