@idestin/eslint-config-basic

ESLint常用插件介绍

eslint-plugin-html插件

通过这个插件你可以让eslint去检测html文件script标签里的js代码，只需要在 plugins 中引入即可

{
  "plugins": [
    "html"
  ]
}

eslint-plugin-n

forked from eslint-plugin-node v11.1.0. as the original repository seems no longer maintained.

因为原始仓库 eslint-plugin-node 似乎不再维护，所以现在基本上都用这个了，它添加对 node 的 eslint 支持

eslint-plugin-import插件

这个插件意在提供对ES6+ import/export语法的支持，有助于防止你写错文件路径或者引用的变量名

{
  "extends": {
    'plugin:import/recommended',
  }
}

eslint-plugin-promise插件

这个插件意在通过代码风格检测让开发者养成较好地使用promise的方式（最佳实践，best practices）。比如在对promise使用了then之后会要求你加一个catch捕获下异常，当然如果你的方法是直接return返回了这个promise的话则不会要求你马上加catch（因为毕竟当然你可以稍后在其他地方拿到这个promise后再catch）

{
  "plugins": [
    "promise"
  ],
  "rules": {
    "promise/always-return": "error",
    "promise/no-return-wrap": "error",
    "promise/param-names": "error",
    "promise/catch-or-return": "error",
    "promise/no-native": "off",
    "promise/no-nesting": "warn",
    "promise/no-promise-in-callback": "warn",
    "promise/no-callback-in-promise": "warn",
    "promise/avoid-new": "warn",
    "promise/no-return-in-finally": "warn"
  }
}

or

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

eslint-plugin-yml插件

这个 ESLint 插件为 YAML 提供了 linting 规则

{
  "extends": [
    'plugin:yml/standard',
  ]
}

eslint-plugin-jsonc插件

这个 ESLint 插件为 JSON、JSONC、JSON5 提供了 linting 规则

eslint-plugin-markdown插件

这个 ESLint 插件可以在 Markdown 中为 js、ts、jsx 提供校验

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

eslint-plugin-eslint-comments插件

用于 ESLint 指令注释的附加 ESLint 规则