【值得收藏】分享一个前端Linter上手教程

简介: 哈喽大家好,我是海怪。 不知道大家有没有经常遇到这样一种情况:每次新建项目项目做代码风格的配置时总是随便找一篇文章,也不管啥意思,把 .eslintrc.js 的配置一抄,再把对应的 NPM 包装上就算完事了。 诶?不想承认?那考考你:eslint, prettier, eslint-config-prettier, eslint-plugin-prettier, prettier-eslint 这些都是个啥关系?它们的职责是什么? 再考考你:如果想用 ESLint 和 TypeScript 结合,要用到哪些包呢?

image.png本次实战的所有代码、配置已放在 Github 可尽情把玩。


哈喽大家好,我是海怪。


不知道大家有没有经常遇到这样一种情况:每次新建项目项目做代码风格的配置时总是随便找一篇文章,也不管啥意思,把 .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 是不是有种“玩排列组合”的感觉?傻傻分不清?


image.png



地址



地址:github.yanhaixiang.com/linter-guid…


image.png


目的




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


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


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


你可以跟着教程自己手动配置一次,也可以只是瞧瞧看看。不管怎样,我还是希望大家不仅能知其然,也能知其所然,不要抄个配置文件就走了。


如果你读完本教程再回头来看自己手头/公司项目的 .eslintrc.js 配置时,能够做到一点都不慌,并且心中有数,那么这个教程的目的就达到了。


内容




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


  • 理论篇: 说清楚这些工具的历史和关系,让读者俯瞰整个工具生态


image.png



  • 实战篇:从 0 开始配置 Linter,边实战边讲解原理,覆盖范围:ESLint x TypeScript x JavaScript x Babel x JSX x Plugin x Husky x LintStaged x StyleLint

image.png



花絮




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


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


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


参考



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


  • Prettier看这一篇就行了 陈龙大佬的 Prettier 文章,写的非常清楚
  • Prettier 文档 接下来再看 Prettier 文档,结合陈龙大佬的文章会有更高纬度的视角
  • ESLint 文档 ESLint 文档非常简陋,像说明书一样,很无聊,但是也要懂一点要怎么配置
  • TypeScript ESLint 文档 这个文档远比 ESLint 文档要好,里面还说了一些实践思路,教会你 Config 和 Plugin 都是做啥用的
  • StyleLint 文档 经过上面文档的洗礼再看 StyleLint 会觉得很简单
  • Husky Github 知道 Husky 是怎么在 Git Hooks 执行 Bash 的
  • lint-staged Github 知道 Husky x lint-staged 用法
相关文章
|
6月前
|
JSON 前端开发 JavaScript
前端使用lottie-web,使用AE导出的JSON动画贴心教程
前端使用lottie-web,使用AE导出的JSON动画贴心教程
589 2
|
25天前
|
前端开发 JavaScript
轻松上手:基于single-spa构建qiankun微前端项目完整教程
轻松上手:基于single-spa构建qiankun微前端项目完整教程
34 0
|
3月前
|
前端开发 Java Maven
【前端学java】全网最详细的maven安装与IDEA集成教程!
【8月更文挑战第12天】全网最详细的maven安装与IDEA集成教程!
88 2
【前端学java】全网最详细的maven安装与IDEA集成教程!
|
6月前
|
资源调度 前端开发 JavaScript
第十章(应用场景篇) Single-SPA微前端架构深度解析与实践教程
第十章(应用场景篇) Single-SPA微前端架构深度解析与实践教程
218 0
|
3月前
|
iOS开发 Android开发 MacOS
从零到全能开发者:解锁Uno Platform,一键跨越多平台应用开发的神奇之旅,让你的代码飞遍Windows、iOS、Android、macOS及Web,技术小白也能秒变跨平台大神!
【8月更文挑战第31天】从零开始,踏上使用Uno Platform开发跨平台应用的旅程。只需编写一次代码,即可轻松部署到Windows、iOS、macOS、Android及Web(通过WASM)等多个平台。Uno Platform为.NET生态带来前所未有的灵活性和效率,简化跨平台开发。首先确保安装了Visual Studio或VS Code及.NET SDK,然后选择合适的项目模板创建新项目。项目结构类似传统.NET MAUI或WPF项目,包含核心NuGet包。通过简单的按钮示例,你可以快速上手并构建应用。Uno Platform让你的技术探索之旅充满无限可能。
62 0
|
4月前
|
移动开发 前端开发 定位技术
零基础学前端系列教程 | 和前端谈恋爱的第002天——约会邀请
零基础学前端系列教程 | 和前端谈恋爱的第002天——约会邀请
34 2
|
4月前
|
移动开发 前端开发 HTML5
零基础学前端系列教程 | 和前端谈恋爱的第005天——约会账单
零基础学前端系列教程 | 和前端谈恋爱的第005天——约会账单
30 1
|
4月前
|
前端开发 JavaScript
前端模拟接口工具推荐——Apifox(mock数据)【图解教程】
前端模拟接口工具推荐——Apifox(mock数据)【图解教程】
1611 1
|
5月前
|
前端开发 JavaScript 开发工具
Web网页前端教程免费:引领您踏入编程的奇幻世界
Web网页前端教程免费:引领您踏入编程的奇幻世界
52 3
|
4月前
|
前端开发 JavaScript
webpack 和 babel 实用教程【前端必备】
webpack 和 babel 实用教程【前端必备】
42 0