javascript

代码解读
复制代码 module.exports = {
  // 若项目中有多个子项目，且每个项目都会有.eslintrc，子项目会一直向上查找所有的.eslintrc，直到找到 root:true 的 eslintrc，再将所有的.eslintrc 合并
  root: true,
  // 对环境定义的一组全局变量的预设 详细看：https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments
  env: {
    // 浏览器全局变量
    browser: true,
    // Node.js 全局变量和作用域
    node: true,
    // CommonJS 全局变量和 CommonJS 作用域
    commonjs: true,
    // 启用除模块之外的所有 ECMAScript 6 功能
    es6: true
  },
  // 将数据提供给每一个将被执行的规则
  settings: {
    sharedData: 'Hello'
  },
  // 继承另一个配置文件的所有特性
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended'
  ],
  // 插件，向 ESLint 添加各种扩展，可以定义规则，环境或配置的第三方模块
  plugins: [
    '@typescript-eslint'
  ],
  // 全局变量
  globals: {
    // false、readable、readonly 这 3 个是等价的，表示变量只可读不可写；
    // true、writeable、writable 这 3 个是等价的，表示变量可读可写；
    $: true,
    console: false
  },
  // 解释器
  parser: '@typescript-eslint/parser',
  // 解释器的配置
  parserOptions: {
    // 代码模块类型，可选 script(默认)，module
    sourceType: 'module',
    // 指定 ECMAScript 版本，默认为 5
    ecamVersion: 6,
    // 额外的语言特性，所有选项默认都是 false
    ecmaFeatures: {
      // 是否允许 return 语句出现在 global 环境下
      globalReturn: true,
      // 是否开启全局 script 模式
      impliedStrict: true,
      // 是否启用 JSX
      jsx: true,
      // 是否启用对实验性的 objectRest/spreadProperties 的支持
      experimentalObjectRestSpread: false
    }
  },
  // 规则
  rules: {
    // 禁止使用 alert
    'no-alert': 'off',
    // 逗号前面没有空格 后面有空格
    'comma-spacing': [2, {
      before: false,
      after: true
    }],
  }
}

lua

 代码解读
复制代码 eslint [options] file.js [file.js] [dir]

Basic configuration:
  --no-eslintrc                  禁止使用配置文件.eslintrc.*
  -c, --config path::String      指定使用.eslintrc.*配置文件的路径（可以不是这个名字）
  --env [String]                 指定环境
  --ext [String]                 指定 JavaScript 文件扩展名，默认值：.js
  --global [String]              定义全局变量
  --parser String                指定解析器
  --parser-options Object        指定解析器配置
  --resolve-plugins-relative-to path::String  应该从中解析插件的文件夹，默认为 CWD

Specifying rules and plugins:
  --rulesdir [path::String]      使用其他规则的目录
  --plugin [String]              指定插件
  --rule Object                  指定规则

Fixing problems:
  --fix                          自定修复 eslint 问题
  --fix-dry-run                  自动修复问题但不保存对文件的更改
  --fix-type Array               指定要应用的修复类型（问题、建议、布局）

Ignoring files:
  --ignore-path path::String     指定忽略的路径 即指定一个文件作为.eslintignore
  --no-ignore                    禁用忽略文件和模式的使用
  --ignore-pattern [String]      要忽略的文件模式（除了.eslintignore 中的文件）

Using stdin:
  --stdin                        <STDIN>上提供的 Lint 代码 - 默认值：false
  --stdin-filename String        指定 STDIN 的文件名

Handling warnings:
  --quiet                        仅报告错误 - 默认值：false
  --max-warnings Int             触发退出代码的警告次数 - 默认值：-1

Output:
  -o, --output-file path::String  指定要将报告写入的文件
  -f, --format String            使用特定的输出格式 - 默认值：stylish
  --color, --no-color            强制启用/禁用颜色

Inline configuration comments:
  --no-inline-config             防止注释更改配置或规则
  --report-unused-disable-directives  添加错误信息给未被使用的 eslint-disable 指令

Caching:
  --cache                        仅检查已更改的文件 - 默认值：false
  --cache-file path::String      缓存文件的路径，不推荐使用：使用--cache-location - 默认值：.eslintcache
  --cache-location path::String  缓存文件或目录的路径

Miscellaneous:
  --init                         运行配置初始化向导 - 默认值：false
  --debug                        输出调试信息
  -h, --help                     显示 help 文档
  -v, --version                  输出版本号
  --print-config path::String    打印给定文件的配置

javascript

代码解读
复制代码// 这是插件的 index.js
module.exports = {
  rules: {
    'my-rule': {
      // 规则的一些数据配置
      meta: {
        // 规则的类型 "problem"、"suggestion" 或 "layout"
        type: 'suggestion',
        // 文档信息 自定义规则或插件中可省略，对 eslint 核心规则是必须的
        docs: {
          description: '规则的简短描述，在 eslint 规则首页展示',
          category: '规则在规则首页处于的分类',
          recommended: true, // "extends": "eslint:recommended"属性是否启用该规则
          url: 'https://eslint.org/docs/rules/no-extra-semi' // 访问完整文档的 url
        },
        // 打开修复功能，如果没有 fixable 属性，即使规则实现了 fix 功能，ESLint 也不会进行修复。如果规则不是可修复的，就省略 fixable 属性
        fixable: 'code',
        // 指定该规则对应的配置，用于验证配置的选项是否有效
        schema: [
          {
            enum: ['always', 'never']
          },
          {
            type: 'object',
            properties: {
              exceptRange: {
                type: 'boolean'
              }
            },
            additionalProperties: false
          }
        ]
      },
      // create 返回一个对象，对象的格式是 key 对应一个回调方法；这个对象包含了 ESLint 在遍历 JavaScript 代码的 AST 树 (ESTree 定义的 AST) 时，用来访问节点的方法。
      // context 当前执行 eslint 时的上下文对象，其中包含了各种相关数据，如 eslint 的配置信息、当前遍历节点的信息、报告问题的方法等；
      create(context) {
        return {
          // callback functions
          'ReturnStatement': function (node) {
            // at a ReturnStatement node while going down
          },
          // at a function expression node while going up:
          'FunctionExpression:exit': function checkLastSegment(node) {
            // report problem for function if last code path segment is reachable
          },
          'ArrowFunctionExpression:exit': function checkLastSegment(node) {
            // report problem for function if last code path segment is reachable
          },
          'onCodePathStart': function (codePath, node) {
            // at the start of analyzing a code path
          },
          'onCodePathEnd': function (codePath, node) {
            // at the end of analyzing a code path
          }
        }
      }
    }
  }
}

javascript

代码解读
复制代码 module.exports = function (context) {
  return {
    /**
     * 这在分析代码路径的开始时被调用，此时，代码路径对象只有初始段。
     *
     * @param {CodePath} codePath - The new code path.
     * @param {ASTNode} node - The current node.
     * @returns {void}
     */
    onCodePathStart(codePath, node) {
      // do something with codePath
    },

    /**
     * 这在分析代码路径的末尾被调用。此时，代码路径对象已经完成。
     *
     * @param {CodePath} codePath - The completed code path.
     * @param {ASTNode} node - The current node.
     * @returns {void}
     */
    onCodePathEnd(codePath, node) {
      // do something with codePath
    },

    /**
     * 这在创建代码路径段时调用。
     * 这意味着代码路径是分叉或合并的。
     * 在这段时间内，该段具有先前的段，并且已被判断为可到达或不可到达。
     *
     * @param {CodePathSegment} segment - The new code path segment.
     * @param {ASTNode} node - The current node.
     * @returns {void}
     */
    onCodePathSegmentStart(segment, node) {
      // do something with segment
    },

    /**
     * 这是在代码路径段离开时调用的。
     * 此时还没进入下个阶段。
     *
     * @param {CodePathSegment} segment - The leaved code path segment.
     * @param {ASTNode} node - The current node.
     * @returns {void}
     */
    onCodePathSegmentEnd(segment, node) {
      // do something with segment
    },

    /**
     * 在代码路径段被循环时调用的。
     * 通常每段在创建时都有以前的段，
     * Usually segments have each previous segments when created,
     * but when looped, a segment is added as a new previous segment into a
     * existing segment.
     *
     * This is called when a code path segment was looped.Usually segments have each previous segments when created,but when looped, a segment is added as a new previous segment into aexisting segment.
     *
     * 当循环代码路径段时调用此函数。通常创建段时，段具有每个先前段，但循环时，段作为新的先前段添加到现有段中。
     * @param {CodePathSegment} fromSegment - A code path segment of source.
     * @param {CodePathSegment} toSegment - A code path segment of destination.
     * @param {ASTNode} node - The current node.
     * @returns {void}
     */
    onCodePathSegmentLoop(fromSegment, toSegment, node) {
      // do something with segment
    }
  }
}

javascript

代码解读
复制代码// 这是插件的 index.js
// processor-name
module.exports = {
  processors: {

    // 不同后缀名 (.js, .jsx, .html, etc.)
    '.ext': {
      // 获取文件的文本和文件名
      preprocess(text, filename) {
        // 在这里，您可以去掉任何非 JS 内容，并将其拆分为多个字符串以进行 lint
        return [string] // return an array of strings to lint
      },

      // 获取 Message[][] 和文件名
      postprocess(messages, filename) {
        // `messages` 参数是一个包含消息对象的二维数组，其中每个数组项的第一个参数包含了 preprocess() 方法返回的文本相关的 lint 消息数组
        // postprocess 方法接受一个二维数组，包含检测消息和文件名。输入数组中的每一项都对应从 preprocess 方法返回的部分。preprocess 方法必须调整所有错误的位置，使其与原始的未处理的代码中的位置相对应，并将它们聚合成一个打平的数组并返回。
        // 返回你想保留的一维数组
        return messages[0]
      },

      supportsAutofix: true // (optional, defaults to false)
    }
  }
}