# 🤫 前言

本次实战的所有代码、配置已放在 Github (opens new window) 可尽情把玩。

哈喽大家好,我是海怪。

不知道大家有没有经常遇到这样一种情况:每次新建项目做代码风格的配置时总是随便找一篇文章,也不管啥意思,把 .eslintrc.js 的配置一抄,再把对应的 NPM 包装上就算完事了。

诶?不想承认?那考考你:eslint, prettier, eslint-config-prettier, eslint-plugin-prettier, prettier-eslint 这些都是个啥关系?它们的职责是什么?

再考考你:如果想用 ESLint 和 TypeScript 结合,要用到哪些包呢?@typescript-eslint/parser, @typescript-eslint/eslint-plugin, tslint-plugin-prettier, tslint-config-prettier, prettier-tslint 是不是有种“玩排列组合”的感觉?傻傻分不清?

# 目的

在没深入了解这些工具之前,我也很蒙逼。网上的资源也是东一块西一块的,要不只讲 Prettier,要不只讲 ESLint, 要不都不讲直接丢一个配置。

其实把这些工具单独拆开来看,它们都是很简单的工具。但是由于前端更新速度太快了,导致出现了很多相似的轮子,比如 tslint 和 eslint, 而且这些 Linter 一旦和 ES5, ES6 新旧语法、Babel 转译、JSX 等新特性结合,事情就不再简单了。

所以,我决定出一份收敛的教程来说清楚这些工具之间的关系,以及给出日常开发的常用配置。

你可以跟着教程自己手动配置一次,也可以只是瞧瞧看看。不管怎样,我还是希望大家不仅能知其然,也能知其所以然,不要抄个配置文件就走了。 如果你读完本教程再回头来看自己手头/公司项目的 .eslintrc.js 配置时,能够做到一点都不慌,并且心中有数,那么这个教程的目的就达到了。

# 内容

这篇文章主要分为两部分:

  • 理论篇:说清楚这些工具的历史和关系,让读者俯瞰整个工具生态
  • 实战篇:从 0 开始配置 Linter,边实战边讲解原理,覆盖范围:ESLint x TypeScript x JavaScript x Babel x JSX x Plugin x Husky x LintStaged x StyleLint

# 花絮

这篇教程 + 项目是我花了一周的时间弄出来的。

实际上我以为只出一篇文章就能讲清楚了, 后来发现前端 Linter 衍生出来的工具实在是太多了,不弄个项目出个实战教程真的无法解释某些点,然后就出了实战篇。好吧,那就出两篇文章。

可是后来随着配置的东西越来越多,踩的坑也变得越来越多,文章的字数快超过 6000 字了,对读者来说不是一个很好的阅读体验,因此拆分了章节, 最后有了这份教程。

# 参考

下面列举我写这篇教程所看的一些参考资料,如果大家有兴趣也可以 按下面给的顺序 进行阅读:

下面再列举一些我搜了很多次的问题:

# LintStaged x TypeScript

# ESLint

# 支持

原创不易,如果觉得本教程对你有帮助,希望大家多多 Star 和 Fork。 同时我也是个新人公众号号主,如果喜欢我写的内容,也欢迎关注公众号【写代码的海怪】。

公众号
Last Updated: 4/22/2022, 11:34:50 AM