埃斯林特- 插座顶端

在文件的顶层消除副作用.

快速链接数字 : 无 | 源代码 | 许可证 | 更改日志 | 警卫

安装

安装 eslint-plugin-top页:1 ESLint 语录 如果它还没有安装:

npm install @ericcornelissen/eslint-plugin-top eslint --save-dev

使用量

新建配置( 自 ESLint v9)

从 @ericcornelissen/eslint-plugin-top 并使用其中的一种 预设 配置,例如:

import top from '@ericcornelissen/eslint-plugin-top';

export default [
  top.configs.recommended,
  // or
  top.configs.strict
  // ...
];

或配置规则部分中要使用的规则, 例如 :

import top from '@ericcornelissen/eslint-plugin-top';

export default [
  {
    plugins: {top},
    rules: {
      'top/no-top-level-side-effects': 'error',
      'top/no-top-level-state': 'error',
      'top/no-top-level-variables': 'error'
    }
  }
];

注意规则前缀(top 在示例中)必须匹配密钥的名称 用于插件对象.

遗产配置( 在ESLint v9 之前)

第一,添加 @ericcornelissen/top 到您的插件区 .eslintrc 配置文件 。 你必须省略 eslint-plugin- 字符串 :

plugins:
  - '@ericcornelissen/top'

然后,配置规则部分中要使用的规则 :

rules:
  '@ericcornelissen/top/no-top-level-side-effects': error
  '@ericcornelissen/top/no-top-level-state': error
  '@ericcornelissen/top/no-top-level-variables': error

支持的规则

• no-top-level-side-effects
• no-top-level-state
• no-top-level-variables

预设配置

• recommended: 不允许顶级变量,同时允许可变值和 不允许顶级副作用, 除了创建类似的东西 Symbol编号.
• strict: 不允许所有顶级变量和副作用,但 导入其他文件 .

请 打开一个问题 如果你发现一个错误 或者如果你有建议 如何改进文件.