@huangjunsen/eslint-config 1.0.0 → 1.0.2

package/rules/base/variables.js

@@ -1,48 +1,48 @@
-module.exports = {
-  // 预设的环境，使用这些环境中的全局变量不会被 no-undef 报错
-  // @link https://eslint.org/docs/user-guide/configuring#specifying-environments
-  env: {
-    browser: true,
-    es6: true,
-    jasmine: true,
-    jest: true,
-    jquery: true,
-    mocha: true,
-    node: true,
-  },
-  rules: {
-    // 强制或禁止在变量声明时进行赋值
-    'init-declarations': 'off',
-
-    // 禁止 delete 变量
-    'no-delete-var': 'error',
-
-    // 禁止标签与变量同名
-    'no-label-var': 'error',
-
-    // 禁用使用特定的全局变量
-    'no-restricted-globals': 'off',
-
-    // 禁止变量与外层作用域已存在的变量同名
-    // @unessential
-    'no-shadow': 'error',
-
-    // 禁止使用保留字命名变量
-    'no-shadow-restricted-names': 'error',
-
-    // 禁止使用未声明的变量
-    'no-undef': 'error',
-
-    // 不要将变量初始化成 undefined
-    'no-undef-init': 'error',
-
-    // 禁止使用 undefined
-    'no-undefined': 'off',
-
-    // 声明的变量必须被使用
-    'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
-
-    // 不要在声明前就使用变量
-    'no-use-before-define': ['error', { functions: false, classes: false, variables: false }],
-  },
-};
+module.exports = {
+  // 预设的环境，使用这些环境中的全局变量不会被 no-undef 报错
+  // @link https://eslint.org/docs/user-guide/configuring#specifying-environments
+  env: {
+    browser: true,
+    es6: true,
+    jasmine: true,
+    jest: true,
+    jquery: true,
+    mocha: true,
+    node: true,
+  },
+  rules: {
+    // 强制或禁止在变量声明时进行赋值
+    'init-declarations': 'off',
+
+    // 禁止 delete 变量
+    'no-delete-var': 'error',
+
+    // 禁止标签与变量同名
+    'no-label-var': 'error',
+
+    // 禁用使用特定的全局变量
+    'no-restricted-globals': 'off',
+
+    // 禁止变量与外层作用域已存在的变量同名
+    // @unessential
+    'no-shadow': 'error',
+
+    // 禁止使用保留字命名变量
+    'no-shadow-restricted-names': 'error',
+
+    // 禁止使用未声明的变量
+    'no-undef': 'error',
+
+    // 不要将变量初始化成 undefined
+    'no-undef-init': 'error',
+
+    // 禁止使用 undefined
+    'no-undefined': 'off',
+
+    // 声明的变量必须被使用
+    'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+
+    // 不要在声明前就使用变量
+    'no-use-before-define': ['error', { functions: false, classes: false, variables: false }],
+  },
+};

package/rules/es5.js

@@ -1,11 +1,11 @@
-/**
- * 本文件用于覆盖掉个别 ES5 与 ES6 不同的规则
- */
-
-module.exports = {
-  rules: {
-    // 逗号风格 - ES5 中不加最后一个逗号
-    // @unessential
-    'comma-dangle': ['error', 'never'],
-  },
-};
+/**
+ * 本文件用于覆盖掉个别 ES5 与 ES6 不同的规则
+ */
+
+module.exports = {
+  rules: {
+    // 逗号风格 - ES5 中不加最后一个逗号
+    // @unessential
+    'comma-dangle': ['error', 'never'],
+  },
+};

package/rules/imports.js

@@ -1,167 +1,167 @@
-/**
- * 本文件的规则由 eslint-plugin-import 提供
- * 与 eslint-plugin-import 推荐配置对齐
- * @see https://github.com/import-js/eslint-plugin-import
- * @see https://github.com/import-js/eslint-plugin-import/blob/main/config/recommended.js
- */
-
-module.exports = {
-  plugins: [
-    'import',
-  ],
-  settings: {
-    'import/ignore': [
-      'node_modules',
-      '\\.(coffee|scss|css|less|hbs|svg|json)$',
-    ],
-  },
-  rules: {
-    /**
-     * Static analysis
-     */
-
-    // ensure imports point to files/modules that can be resolved
-    'import/no-unresolved': 'error',
-
-    // ensure named imports coupled with named exports
-    'import/named': 'error',
-
-    // ensure default import coupled with default export
-    'import/default': 'error',
-
-    // ensure imported namespaces contain dereferenced properties as they are dereferenced
-    'import/namespace': 'error',
-
-    /**
-     * Helpful warnings
-     */
-
-    // disallow invalid exports, e.g. multiple defaults
-    'import/export': 'error',
-
-    // import 一个文件时，禁止 default import 的名字跟文件内的命名 export 相同
-    'import/no-named-as-default': 'error',
-
-    // 访问 default export 的属性时，如果该文件有与属性同名的命名 export，则给出警告
-    'import/no-named-as-default-member': 'warn',
-
-    // disallow use of jsdoc-marked-deprecated imports
-    'import/no-deprecated': 'off',
-
-    // Forbid the use of extraneous packages
-    'import/no-extraneous-dependencies': 'off',
-
-    // Forbid mutable exports
-    'import/no-mutable-exports': 'off',
-
-    /**
-     * Module systems
-     */
-
-    // Report potentially ambiguous parse goal (script vs. module)
-    'import/unambiguous': 'off',
-
-    // disallow require()
-    'import/no-commonjs': 'off',
-
-    // disallow AMD require/define
-    'import/no-amd': 'warn',
-
-    // No Node.js builtin modules
-    'import/no-nodejs-modules': 'off',
-
-    /**
-     * Style guide
-     */
-
-    // import 语句需要放到模块的最上方
-    // @unessential
-    'import/first': 'error',
-
-    // 不要用多个 import 引入同一模块
-    'import/no-duplicates': 'error',
-
-    // disallow namespace imports
-    'import/no-namespace': 'off',
-
-    // Ensure consistent use of file extension within the import path
-    'import/extensions': 'off',
-
-    // import 语句的排序
-    'import/order': ['off', {
-      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-      'newlines-between': 'never',
-    }],
-
-    // 在最后一个 import / require 语句后保留一个空行
-    'import/newline-after-import': 'warn',
-
-    // 当模块内只有一个 export 时，使用 default export
-    'import/prefer-default-export': 'off',
-
-    // Restrict which files can be imported in a given folder
-    'import/no-restricted-paths': 'off',
-
-    // Forbid modules to have too many dependencies
-    'import/max-dependencies': ['off', { max: 10 }],
-
-    // Forbid import of modules using absolute paths
-    'import/no-absolute-path': 'off',
-
-    // Forbid require() calls with expressions
-    'import/no-dynamic-require': 'off',
-
-    // prevent importing the submodules of other modules
-    'import/no-internal-modules': ['off', {
-      allow: [],
-    }],
-
-    // Forbid Webpack loader syntax in imports
-    'import/no-webpack-loader-syntax': 'off',
-
-    // Prevent unassigned imports
-    // importing for side effects is perfectly acceptable, if you need side effects.
-    'import/no-unassigned-import': 'off',
-
-    // 禁止 import { default as foo } from './foo.js'
-    // 应写成 import foo from './foo.js'
-    'import/no-named-default': 'off',
-
-    // Reports if a module's default export is unnamed
-    'import/no-anonymous-default-export': ['off', {
-      allowArray: false,
-      allowArrowFunction: false,
-      allowAnonymousClass: false,
-      allowAnonymousFunction: false,
-      allowLiteral: false,
-      allowObject: false,
-    }],
-
-    // This rule enforces that all exports are declared at the bottom of the file.
-    'import/exports-last': 'off',
-
-    // Prefer named exports to be grouped together in a single export declaration
-    'import/group-exports': 'off',
-
-    // forbid default exports. this is a terrible rule, do not use it.
-    'import/no-default-export': 'off',
-
-    // 不要产生自引用
-    'import/no-self-import': 'error',
-
-    // 不要产生循环引用
-    'import/no-cycle': ['error', { maxDepth: Infinity }],
-
-    // Ensures that there are no useless path segments
-    'import/no-useless-path-segments': 'off',
-
-    // dynamic imports require a leading comment with a webpackChunkName
-    'import/dynamic-import-chunkname': ['off', {
-      importFunctions: [],
-      webpackChunknameFormat: '[0-9a-zA-Z-_/.]+',
-    }],
-
-    // Use this rule to prevent imports to folders in relative parent paths.
-    'import/no-relative-parent-imports': 'off',
-  },
-};
+/**
+ * 本文件的规则由 eslint-plugin-import 提供
+ * 与 eslint-plugin-import 推荐配置对齐
+ * @see https://github.com/import-js/eslint-plugin-import
+ * @see https://github.com/import-js/eslint-plugin-import/blob/main/config/recommended.js
+ */
+
+module.exports = {
+  plugins: [
+    'import',
+  ],
+  settings: {
+    'import/ignore': [
+      'node_modules',
+      '\\.(coffee|scss|css|less|hbs|svg|json)$',
+    ],
+  },
+  rules: {
+    /**
+     * Static analysis
+     */
+
+    // ensure imports point to files/modules that can be resolved
+    'import/no-unresolved': 'error',
+
+    // ensure named imports coupled with named exports
+    'import/named': 'error',
+
+    // ensure default import coupled with default export
+    'import/default': 'error',
+
+    // ensure imported namespaces contain dereferenced properties as they are dereferenced
+    'import/namespace': 'error',
+
+    /**
+     * Helpful warnings
+     */
+
+    // disallow invalid exports, e.g. multiple defaults
+    'import/export': 'error',
+
+    // import 一个文件时，禁止 default import 的名字跟文件内的命名 export 相同
+    'import/no-named-as-default': 'error',
+
+    // 访问 default export 的属性时，如果该文件有与属性同名的命名 export，则给出警告
+    'import/no-named-as-default-member': 'warn',
+
+    // disallow use of jsdoc-marked-deprecated imports
+    'import/no-deprecated': 'off',
+
+    // Forbid the use of extraneous packages
+    'import/no-extraneous-dependencies': 'off',
+
+    // Forbid mutable exports
+    'import/no-mutable-exports': 'off',
+
+    /**
+     * Module systems
+     */
+
+    // Report potentially ambiguous parse goal (script vs. module)
+    'import/unambiguous': 'off',
+
+    // disallow require()
+    'import/no-commonjs': 'off',
+
+    // disallow AMD require/define
+    'import/no-amd': 'warn',
+
+    // No Node.js builtin modules
+    'import/no-nodejs-modules': 'off',
+
+    /**
+     * Style guide
+     */
+
+    // import 语句需要放到模块的最上方
+    // @unessential
+    'import/first': 'error',
+
+    // 不要用多个 import 引入同一模块
+    'import/no-duplicates': 'error',
+
+    // disallow namespace imports
+    'import/no-namespace': 'off',
+
+    // Ensure consistent use of file extension within the import path
+    'import/extensions': 'off',
+
+    // import 语句的排序
+    'import/order': ['off', {
+      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+      'newlines-between': 'never',
+    }],
+
+    // 在最后一个 import / require 语句后保留一个空行
+    'import/newline-after-import': 'warn',
+
+    // 当模块内只有一个 export 时，使用 default export
+    'import/prefer-default-export': 'off',
+
+    // Restrict which files can be imported in a given folder
+    'import/no-restricted-paths': 'off',
+
+    // Forbid modules to have too many dependencies
+    'import/max-dependencies': ['off', { max: 10 }],
+
+    // Forbid import of modules using absolute paths
+    'import/no-absolute-path': 'off',
+
+    // Forbid require() calls with expressions
+    'import/no-dynamic-require': 'off',
+
+    // prevent importing the submodules of other modules
+    'import/no-internal-modules': ['off', {
+      allow: [],
+    }],
+
+    // Forbid Webpack loader syntax in imports
+    'import/no-webpack-loader-syntax': 'off',
+
+    // Prevent unassigned imports
+    // importing for side effects is perfectly acceptable, if you need side effects.
+    'import/no-unassigned-import': 'off',
+
+    // 禁止 import { default as foo } from './foo.js'
+    // 应写成 import foo from './foo.js'
+    'import/no-named-default': 'off',
+
+    // Reports if a module's default export is unnamed
+    'import/no-anonymous-default-export': ['off', {
+      allowArray: false,
+      allowArrowFunction: false,
+      allowAnonymousClass: false,
+      allowAnonymousFunction: false,
+      allowLiteral: false,
+      allowObject: false,
+    }],
+
+    // This rule enforces that all exports are declared at the bottom of the file.
+    'import/exports-last': 'off',
+
+    // Prefer named exports to be grouped together in a single export declaration
+    'import/group-exports': 'off',
+
+    // forbid default exports. this is a terrible rule, do not use it.
+    'import/no-default-export': 'off',
+
+    // 不要产生自引用
+    'import/no-self-import': 'error',
+
+    // 不要产生循环引用
+    'import/no-cycle': ['error', { maxDepth: Infinity }],
+
+    // Ensures that there are no useless path segments
+    'import/no-useless-path-segments': 'off',
+
+    // dynamic imports require a leading comment with a webpackChunkName
+    'import/dynamic-import-chunkname': ['off', {
+      importFunctions: [],
+      webpackChunknameFormat: '[0-9a-zA-Z-_/.]+',
+    }],
+
+    // Use this rule to prevent imports to folders in relative parent paths.
+    'import/no-relative-parent-imports': 'off',
+  },
+};

package/rules/jsx-a11y.js

@@ -1,23 +1,23 @@
-/**
- * 本文件的规则由 eslint-plugin-jsx-a11y 提供
- * @link https://github.com/evcohen/eslint-plugin-jsx-a11y
- */
-
-module.exports = {
-  plugins: ['jsx-a11y'],
-  rules: {
-    'jsx-a11y/alt-text': 'warn',
-    'jsx-a11y/img-redundant-alt': 'warn',
-    'jsx-a11y/anchor-has-content': 'warn',
-    'jsx-a11y/aria-props': 'warn',
-    'jsx-a11y/aria-proptypes': 'warn',
-    'jsx-a11y/aria-unsupported-elements': 'warn',
-    'jsx-a11y/aria-role': ['warn', { ignoreNonDOM: true }], // ignoreNonDom 为 true 时不检查用户自定义元素
-    'jsx-a11y/role-has-required-aria-props': 'warn',
-    'jsx-a11y/role-supports-aria-props': 'warn',
-    'jsx-a11y/iframe-has-title': 'warn',
-    'jsx-a11y/no-access-key': 'warn',
-    'jsx-a11y/no-distracting-elements': 'warn',
-    'jsx-a11y/scope': 'warn',
-  },
-};
+/**
+ * 本文件的规则由 eslint-plugin-jsx-a11y 提供
+ * @link https://github.com/evcohen/eslint-plugin-jsx-a11y
+ */
+
+module.exports = {
+  plugins: ['jsx-a11y'],
+  rules: {
+    'jsx-a11y/alt-text': 'warn',
+    'jsx-a11y/img-redundant-alt': 'warn',
+    'jsx-a11y/anchor-has-content': 'warn',
+    'jsx-a11y/aria-props': 'warn',
+    'jsx-a11y/aria-proptypes': 'warn',
+    'jsx-a11y/aria-unsupported-elements': 'warn',
+    'jsx-a11y/aria-role': ['warn', { ignoreNonDOM: true }], // ignoreNonDom 为 true 时不检查用户自定义元素
+    'jsx-a11y/role-has-required-aria-props': 'warn',
+    'jsx-a11y/role-supports-aria-props': 'warn',
+    'jsx-a11y/iframe-has-title': 'warn',
+    'jsx-a11y/no-access-key': 'warn',
+    'jsx-a11y/no-distracting-elements': 'warn',
+    'jsx-a11y/scope': 'warn',
+  },
+};

package/rules/node.js

@@ -1,11 +1,11 @@
-/**
- * 本文件继承了 egg-config-egg 的 node 规则，规则由 eslint-plugin-node 提供
- * @link https://github.com/eggjs/eslint-config-egg/blob/master/lib/rules/node.js
- * @link https://github.com/mysticatea/eslint-plugin-node
- */
-
-module.exports = {
-  extends: [
-    'eslint-config-egg/lib/rules/node',
-  ],
-};
+/**
+ * 本文件继承了 egg-config-egg 的 node 规则，规则由 eslint-plugin-node 提供
+ * @link https://github.com/eggjs/eslint-config-egg/blob/master/lib/rules/node.js
+ * @link https://github.com/mysticatea/eslint-plugin-node
+ */
+
+module.exports = {
+  extends: [
+    'eslint-config-egg/lib/rules/node',
+  ],
+};