eslint解读,如何根据自定义开发插件

文档简介

eslist作为开发过程中必不可少的工具,如何更好的利用它为开发做好辅助工作,结合自身项目的不同特点,如何定制属于自己的eslit规范

目标

  • 利用自定义开发eslint规则,规范代码的开发规范

设计思路简介

首先聊聊eslint的使用场景

eslint_1.png

自己的项目目前使用的eslint的方式

ESLint支持使用第三方AST解析器,刚好Babel也支持ESLint,于是我们就可以用@babel/eslint-parser来替换espree. 装好插件之后,修改.eslintrc.js即可

eslint_2.png

由于前期开发人员没有深入的研究每一个eslint插件的具体规则

都是在百度认为能解决项目中的某一项检测功能,而进行的依赖包添加, .eslintrc.js中也没有使用,以下以我自己的项目为例,由于项目存在周期已经三年以上,故而存在多个依赖包是此情况,现在分析几个eslint的插件包

当前系统中引入未使用的eslint第三方插件

"eslint-plugin-import": "~2.28.1",

提供对ES6+ import/export语法的支持,点击跳转

"eslint-plugin-node": "~11.1.0",

针对node使用相关规范,点击跳转

"eslint-plugin-promise": "~4.3.1",

promise使用的相关规范,点击跳转

"eslint-plugin-standard": "~4.1.0",

Standard Linter的补充插件

eslint_3.png

"eslint-plugin-vue": "~7.20.0",

vue官网提供的检测插件:点击跳转

文件进行eslint的方式及对应步骤

第一步:针对提交commit动作的拦截触发

插件@commitlint/cli,属性pre-commit提交前触发的方法,可自定义相关检测条件范围,比如文件类型等

第二步:内部调用eslint的检测规则,rules中对应的一系列规则,也可以手动执行。命令如下

npx eslint src/ 文件路径

第三步:执行内部规则,初步解释为 节点转换为ast树结构后,进行对应节点状态等情况处理

先参考一下ast结构的示例:在线查看

eslint 自定义的规则开发示例

背景基于当前小组内部制定的代码review规范,进行规则拆解,并纳入规则的实现。

当前根据规则开发的验证规则插件为:eslint-plugin-dir-structure

在线相关文档如下:点击查看

eslint自定义规则的参考文档地址如下:点击查看

规则开发指导文档:点击查看

检测规则分解过程与实现

目标:检测当前router文件夹下的js文件中的path路径与views中模块是否一一对应,router默认导出的变量名称是否为驼峰形式,是否包含了整个文件路径(方便根据变量名直接知道其用途)

详细讲解看具体代码 npm 官网查看 eslint-plugin-dir-structure

  • 第一步检测文件夹目录与文件path是否一致

  • 第二步检测 vue文件的name 命名。 ---- vue/multi-word-component-names。 vuename命名规范

检测当前 service下的变量的定义

检测export default 返回值的命名是否与路径一致

  • 第三步检测系统是否存在使用非驼峰形式的命名,主要针对文件夹命名,文件命名

变量命名要求必须使用 驼峰的形式命名. camelcase

下一步待研究stylelint得相关规则并实现匹配自己项目规范的场景

比如当前项目中大量使用了scss 的相关方法如:@include @if @function等,scss的基础知识文档点击在线查看

比如当前要实现检测代码中是否存在 color值,主要针对vue文件、scss文件,template部分,style部分 ----后续调研如何利用Stylelint实现检测

eslint_4.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,186评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,858评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,620评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,888评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,009评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,149评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,204评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,956评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,385评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,698评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,863评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,544评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,185评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,899评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,141评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,684评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,750评论 2 351

推荐阅读更多精彩内容