整顿，就从完善 eslint + prettier 配置开始
2023-11-09 20:59:26
让我们从项目规范的定义说起。项目规范，其实就是一种标准，规定了项目中的代码应该如何编写。通常，项目规范会包括代码风格、命名规范、代码结构等方面的内容。而这个标准，是所有人都需要遵守的。
项目规范的必要性
规范是多么的重要呢？让我们换一个词：“项目规范”就是说：“写代码的所有人，都必须按照这个规则来做。”
为什么呢？因为如果项目规范是不存在的，会导致很多人按照自己的习惯写代码，那么就有可能是“人人都写的很舒服，却没人能看得懂别人的代码”。
项目规范的目的，其实就是让代码的可读性和可维护性更好，好处也很简单：
- 代码更容易阅读 。当团队中的每个人都遵循相同的代码风格时，代码就更容易阅读和理解，因为大家都不需要猜测代码的含义。这使得代码维护更加容易，也更容易进行代码审查。
- 代码更容易维护 。当代码遵循统一的规范时，代码就更容易维护和扩展。当需要更改代码时，就不必花时间去猜测代码的含义或如何对其进行更改。
- 减少团队间的分歧 。当项目有统一的规范时，可以减少团队间的分歧和冲突。在很多公司，最容易让程序员吵起来的事情就是，这种代码到底应该怎样写。
- 提升项目的整体质量 。代码规范有助于提高项目的整体质量。当代码遵循统一的规范时，代码就更容易阅读、维护和扩展，从而降低了项目的维护成本和提高了项目的质量。
代码风格规范
代码规范中，最基础的就是代码风格规范了，主要包括三个内容：
- 代码格式化 。代码格式化是指如何对代码进行排版和格式化，包括缩进、换行、分号等。
- 命名规范 。命名规范是指如何为代码中的变量、函数、类等命名。
- 代码注释 。代码注释是指在代码中添加的说明性文字，帮助其他程序员理解代码的含义。
如何让项目规范变得有效？
再好的项目规范，如果没有合适的工具去检查，也只不过是一纸空文。而检查代码是否符合规范，是 eslint 这个库最大的用处。它能够根据你的需求，检查代码的代码风格、命名规范、代码注释等方面是否符合你定义的规范。
eslint 是一个 JavaScript 代码风格检查工具，它可以帮助你检查代码是否符合预定义的规则。你可以根据自己的需求定制这些规则，以确保代码符合你的项目规范。
prettier 是一个 JavaScript 代码格式化工具，它可以自动将你的代码格式化成一致的风格。这可以让你更轻松地阅读和维护代码，也可以减少代码审查的时间。
eslint 和 prettier 可以一起使用，以确保你的代码符合你的项目规范。
ESLint 和 Prettier 的配合使用
ESLint 和 Prettier 是两种不同的工具，但它们可以很好地配合使用。ESLint 可以检查你的代码是否符合你的项目规范，而 Prettier 可以自动格式化你的代码。这可以让你更轻松地编写符合项目规范的代码。
要将 ESLint 和 Prettier 配合使用，你可以使用 ESLint 的 --fix 选项。这个选项可以自动修复 ESLint 发现的代码问题。你也可以使用 Prettier 的 --write 选项。这个选项可以自动将 Prettier 格式化的代码写入文件。
总结
ESLint 和 Prettier 是两个非常有用的工具，可以帮助你编写符合项目规范的代码。通过使用这些工具，你可以提高代码的可读性、可维护性和质量。
