eslint - JavaScript和JSX检查工具

1. eslint 是如何校验代码的

参考:https://blog.csdn.net/OBKoro1/article/details/103411464
eslint 命令会调用解析器将源码转化为AST(抽象语法树): https://astexplorer.net/
选择器:https://github.com/estree/estree/blob/master/es5.md
如下代码:

setTimeout(() => {
    console.log('exec setTimeout function')
}, 1000)
image.png
原理:

原理就是依据AST解析的结果,做针对性的检测,过滤出我们要选中的代码,然后对代码的值进行逻辑判断。

image.png
例子:

lib/rules/settimeout-no-number.js:

module.exports = {
    meta: {
    type: "problem",
    docs: { description: "setTimeout 第二个参数禁止是数字" },
    fixable: null, // 修复函数 },
  },
  // rule 核心
  create: function (context) {
    console.log("22222222222");
    // 公共变量和函数应该在此定义
    return {
      // 返回事件钩子
      CallExpression: (node) => {
        console.log("1111111111111111111");
        if (node.callee.name !== "setTimeout") return; // 不是定时器即过滤
        const timeNode = node.arguments && node.arguments[1]; // 获取第二个参数
        if (!timeNode) return; // 没有第二个参数 // 检测报错第二个参数是数字 报错
        if (timeNode.type === "Literal" && typeof timeNode.value === "number") {
          context.report({ node, message: "setTimeout第二个参数禁止是数字" });
        }
      },
    };
  },
}


2. eslint-extends-xxx 与 eslint-plugins-xxx的区别:

参考:https://juejin.cn/post/6859291468138774535
eslint-extends-xxx: 里面定义了rules对象,是将规则注册进入eslint中,eslint-plugins-xxx里面定义了一系列规则,还可以定义一些extends,还可以调用指定的插件

image.png

3. eslint ,prettier, vscode 如何相关联系调用

参考:https://blog.csdn.net/Bruski/article/details/115416048

prettier 插件

插件默认使用项目的prettier包,如果找不到并且prettier.resolveGlobalModules设置为true时,扩展也可以尝试解析全局模块,如果都没有,就会使用扩展里面的prettier版本(不同版本,包含不同插件,支持不同类型文件格式化)

1:配置文件:vscode setting, .prettierrc, .editorconfig
2: 命令行运行prettier时,VS代码配置设置无效, 命令行只会根据 .prettierrc
3:检索.prettierrc,会以当前文件夹递归向上检索是否有全局的.prettierrc

通过editor.formatOnSave 触发此扩展, 然后此扩展会调用prettier, vscode 无法直接调用prettier包

// Set the default
"editor.formatOnSave": false,
// Enable per-language
"[javascript]": {
    "editor.formatOnSave": true
}

eslint 包

1:vscode 保存并不会直接触发eslint包
2:eslint检查文件,只会在命令行里面报错,不会在vscode里面报错(这是插件的功能)
3:执行 eslint --fix *.js 会自动修复文件的eslint错误(autoFix基于此)

eslint 扩展

1:该扩展会首先使用项目里面的eslint库,如果没有,则寻找全局安装版本
2:vscode 保存时 可以通知eslint扩展

"editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }

3:"eslint.enable": false, 会禁止扩展执行eslint,默认不写是true

4. eslint包与prettier包联系

eslint-plugin-prettier

eslint可以通过配置eslint-plugin-prettier ,在执行--fix的时候调用prettier格式化代码,
eslint 只执行检查时,会将prittier格式错误抛出来,而不会调用prettier格式化代码,如下:


image.png
{
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error"
  }
}

eslint-plugin-prettier插件会调用prettier对你的代码风格进行检查,其原理是先使用prettier对你的代码进行格式化,然后与格式化之前的代码进行对比,如果过出现了不一致,这个地方就会被prettier进行标记。
接下来,我们需要在rules中添加,"prettier/prettier": "error",表示被prettier标记的地方抛出错误信息。
借助ESLint的autofix功能,在保存代码的时候,自动将抛出error的地方进行fix

eslint-config-prettier

eslint-config-prettier配置,能够关闭一些不必要的或者是与prettier冲突的lint选项。这样我们就不会看到一些error同时出现两次

{
  extends: [
    'standard', //使用standard做代码规范
    "prettier",
  ],
}

同时启用插件和配置:

{
  "extends": ["plugin:prettier/recommended"]
}


5. 不使用prettier插件和eslint,vscode, 保存文件去触发prettier

npm run format

"scripts": {
  "format": "onchange 'src/**/*.js' -- prettier --write {{changed}}"
}

参考:https://zhuanlan.zhihu.com/p/38267286

6. eslint, eslint 插件,prettier,prettier 插件之间的关系

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

推荐阅读更多精彩内容