几年前,当时我还是一名 CSS 开发人员,在
网站建设过程我从未考虑过 linter 可能对我有用。我知道我的程序员同事使用 linter,但它似乎与 HTML 和 CSS 无关。让我大开眼界的是在 CSS-Tricks 上阅读Lint your CSS with Stylelint。它向我介绍了让计算机完成执行标准和避免语法问题的无聊工作的概念。
类似于 Kleenex 成为面巾纸的通用术语和 Xerox 成为影印的通用术语,Lint 是一个从特定纸巾开始的通用术语。最初的Lint是一个用于检查 C 代码问题的 Unix 实用程序。今天,我们使用术语“linters”来表示一类检查代码是否存在常见错误和风格错误的工具。大多数 linter 是高度可配置的,因此它们可以强制执行组织的标准。
使用 linter 有两个主要原因:通过避免常见问题来避免麻烦,并在整个团队中强制执行通用代码风格。每个人在编码时都会犯错误。使用错误类型的括号、忘记分号或拼错某些内容很容易。检查您的代码是否存在这些类型的错误是计算机擅长的事情。您可以告诉计算机要查找哪些类型的错误,而不是逐行检查代码中的常见语法错误。
linter 的另一个重要用途是帮助团队中的每个成员以相同的风格编写代码。当一个团队成员用制表符缩进而另一个用空格缩进时,或者当一个人按类型对 CSS 规则进行排序而另一个人按字母顺序排序时,所导致的不一致可能会非常令人沮丧。试试这个:当你遇到这样的情况时,与你的团队讨论,选择一个标准,然后让 linter 执行它。您不再需要留下代码审查反馈来提醒团队成员遵守标准,或者与重新格式化您的代码的人打交道。让计算机成为执行者!
在 Cloud Four,我们将 linter 用于 JavaScript 和 CSS。linter 被配置为强制执行我们团队同意遵循的最佳实践和编码约定。例如,在 CSS 中,linter 使我们的规则按字母顺序排序并强制执行我们的类命名约定。在 JavaScript 中,linter 应用最大行长度并鼓励使用 JSDoc 注释标准。
有多种选择,具体取决于您对开发环境和构建工具的控制程度。在最基本的层面上,你可以在你的编辑器中安装一个 linter。大多数 linter 都有VS Code 和其他编辑器的插件。通过安装插件,您的编辑器将知道读取您的配置文件,并将直接在您的编辑器中突出显示 lint 错误。如果您将 lint 配置文件添加到您的项目,那么任何在其编辑器中安装了 linter 的人都将受益于共享规则集。
如果您使用的是 Node,那么在您的项目中安装了 linter 之后,您可以在您的package.json文件中添加一个脚本,该脚本将允许使用该项目的任何人运行该 linter。例如,我们lint为所有项目添加了一个脚本,因此任何贡献者都可以通过npm run lint从命令行运行来检查他们的代码。它会让您知道您的代码是否符合 lint 规则,修复它知道如何修复的问题,并为无法修复的问题显示错误。