规范化标准

10/12/2021 前端工程化模块化开发

# 规范化介绍

规范化是我们践行前端工程化重要的一部分。

# 为什么要有规范标准

  • 软件开发需要多人协同
  • 不同开发者具有不同的编码习惯和喜好
  • 不同喜好增加项目维护成本
  • 每个项目或者团队需要明确统一的标准

# 哪里需要规范化标准

  • 代码、文档、甚至是提交日志
  • 开发过程中人为编写的成果物
  • 代码标准化规范最为重要(代码的规范很大程度上决定了项目质量,也决定了项目的可维护性)

为了便于后期维护和其他成员的阅读,一般情况我们都会对代码风格做统一要求,其中会包括:

  • 统一关键词和操作符左右的空格
  • 统一代码的缩进方式
  • 统一是否使用分号结尾
  • 统一变量或者函数的命名规范
  • ...

# 实施规范化的方法

# step1:编码前人为的标准约定,之后code Review的环节进行检查

单靠人为约定的方式会有很多问题,人为约定不可靠,而且开发者很难记住所有规则,所以需要工具进行更可靠的保障。

# step2:通过工具实现Lint

Lint —— 通过工具找到项目中不合规范地方的过程

PS:(最开始在C语言中,很多问题是不会被编译器捕获到的,所以有人就开发了一个叫Lint的工具,用于在编译之前检查代码,避免编译的时候无法通过的问题,所以后续类似这种功能的工具都被称之为Lint/Linter,例如现在前端的ES Lint,StyleLint)

相比于人为检查,工具检查更为严谨、可靠。同时还可以配合自动化工具实现自动化检查,这样更容易得到质量上的保证。

# 规范化实现内容

  • ESLint 工具使用
  • 定制 ESLint 校验规则
  • ESLint 对 TypeScript 的支持
  • ESLint 结合自动化工具或者 Webpack
  • 基于 ESLint 的衍生工具
  • Stylelint 工具的使用
  • GitHook 配合 ESLint工具在提交之前提供自动化校验

# 规范化工具

更新时间: 2021-10-11 15:57