docs(eslintrc/import): add rules URL 🔗

Author: latipun7

configs/eslint/src/import/helpful-warnings.ts

@@ -2,18 +2,23 @@
 module.exports = {
   rules: {
     // Report any invalid exports, i.e. re-export of the same name
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/export.md
     'import/export': 'error',
 
     // Report use of exported name as identifier of default export
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default.md
     'import/no-named-as-default': 'error',
 
     // Report use of exported name as property of default export
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default-member.md
     'import/no-named-as-default-member': 'error',
 
     // Report imported names marked with `@deprecated` documentation tag
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md
     'import/no-deprecated': 'off',
 
     // Forbid the use of extraneous packages
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
     'import/no-extraneous-dependencies': [
       'error',
       {
@@ -42,9 +47,11 @@ module.exports = {
     ],
 
     // Forbid the use of mutable exports with `var` or `let`.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md
     'import/no-mutable-exports': 'error',
 
     // Report modules without exports, or exports without matching import in another module
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md
     'import/no-unused-modules': 'off',
   },
 };

configs/eslint/src/import/module-systems.ts

@@ -2,18 +2,23 @@
 module.exports = {
   rules: {
     // Report potentially ambiguous parse goal (`script` vs. `module`)
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/unambiguous.md
     'import/unambiguous': 'off',
 
     // Report CommonJS `require` calls and `module.exports` or `exports.*`.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-commonjs.md
     'import/no-commonjs': 'off',
 
     // Report AMD `require` and `define` calls.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-amd.md
     'import/no-amd': 'error',
 
     // No Node.js builtin modules.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-nodejs-modules.md
     'import/no-nodejs-modules': 'off',
 
     // Forbid imports with CommonJS exports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-import-module-exports.md
     'import/no-import-module-exports': 'off',
   },
 };

configs/eslint/src/import/static-analysis.ts

@@ -2,45 +2,59 @@
 module.exports = {
   rules: {
     // Ensure imports point to a file/module that can be resolved.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md
     'import/no-unresolved': ['error', { commonjs: true, caseSensitive: true }],
 
     // Ensure named imports correspond to a named export in the remote file.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/named.md
     'import/named': 'error',
 
     // Ensure a default export is present, given a default import.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/default.md
     'import/default': 'off',
 
     // Ensure imported namespaces contain dereferenced properties as they are dereferenced.
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md
     'import/namespace': 'off',
 
     // Restrict which files can be imported in a given folder
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-restricted-paths.md
     'import/no-restricted-paths': 'off',
 
     // Forbid import of modules using absolute paths
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md
     'import/no-absolute-path': 'error',
 
     // Forbid `require()` calls with expressions
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-dynamic-require.md
     'import/no-dynamic-require': 'error',
 
     // Prevent importing the submodules of other modules
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-internal-modules.md
     'import/no-internal-modules': 'off',
 
     // Forbid webpack loader syntax in imports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-webpack-loader-syntax.md
     'import/no-webpack-loader-syntax': 'error',
 
     // Forbid a module from importing itself
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md
     'import/no-self-import': 'error',
 
     // Forbid a module from importing a module with a dependency path back to itself
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
     'import/no-cycle': ['error', { maxDepth: '∞' }],
 
     // Prevent unnecessary path segments in import and require statements
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md
     'import/no-useless-path-segments': ['error', { commonjs: true }],
 
     // Forbid importing modules from parent directories
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-parent-imports.md
     'import/no-relative-parent-imports': 'off',
 
     // Prevent importing packages through relative paths
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md
     'import/no-relative-packages': 'error',
   },
 };

configs/eslint/src/import/style-guide.ts

@@ -2,18 +2,23 @@
 module.exports = {
   rules: {
     // Ensure all imports appear before other statements
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
     'import/first': 'error',
 
     // Ensure all exports appear after other statements
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
     'import/exports-last': 'off',
 
     // Report repeated import of the same module in multiple places
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md
     'import/no-duplicates': 'error',
 
     // Forbid namespace (a.k.a. "wildcard" *) imports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-namespace.md
     'import/no-namespace': 'off',
 
     // Ensure consistent use of file extension within the import path
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
     'import/extensions': [
       'error',
       'ignorePackages',
@@ -27,39 +32,50 @@ module.exports = {
     ],
 
     // Enforce a convention in module import order
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
     'import/order': [
       'error',
       { groups: [['builtin', 'external', 'internal']] },
     ],
 
     // Enforce a newline after import statements
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
     'import/newline-after-import': 'error',
 
     // Prefer a default export if module exports a single name
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
     'import/prefer-default-export': 'error',
 
     // Limit the maximum number of dependencies a module can have
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/max-dependencies.md
     'import/max-dependencies': 'off',
 
     // Forbid unassigned imports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unassigned-import.md
     'import/no-unassigned-import': 'off',
 
     // Forbid named default exports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-default.md
     'import/no-named-default': 'error',
 
     // Forbid default exports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
     'import/no-default-export': 'off',
 
     // Forbid named exports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-export.md
     'import/no-named-export': 'off',
 
     // Forbid anonymous values as default exports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-anonymous-default-export.md
     'import/no-anonymous-default-export': 'off',
 
     // Prefer named exports to be grouped together in a single export declaration
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md
     'import/group-exports': 'off',
 
     // Enforce a leading comment with the webpackChunkName for dynamic imports
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/dynamic-import-chunkname.md
     'import/dynamic-import-chunkname': 'off',
   },
 };