@prowise/eslint-config-linting-rules 2.4.6 → 3.0.0

package/rules/plugin-import-rules.js

@@ -13,22 +13,11 @@ export default {
 
     rules: {
         /**
-         * Enforce or ban the use of inline type-only markers for named imports.
+         * Enforce or ban the use of inline type-only markers for named imports. 🔧
          * https://github.com/un-ts/eslint-plugin-import-x/blob/v4.5.0/docs/rules/consistent-type-specifier-style.md
+         * Rule turned off: already caught by "typescript/no-import-type-side-effects"
          */
-        "import/consistent-type-specifier-style": ["warn", "prefer-inline"],
-
-        /**
-         * Ensure default import coupled with default export
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/default.md.
-         */
-        // "import/default": "off",
-
-        /**
-         * Dynamic imports require a leading comment with a webpackChunkName
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/dynamic-import-chunkname.md.
-         */
-        // "import/dynamic-import-chunkname": ["off", { importFunctions: [], webpackChunknameFormat: "[0-9a-zA-Z-_/.]+" }],
+        "import/consistent-type-specifier-style": ["off", "prefer-top-level"],
 
         /**
          * Disallow invalid exports, e.g. Multiple defaults
@@ -36,12 +25,6 @@ export default {
          */
         "import/export": "error",
 
-        /**
-         * This rule enforces that all exports are declared at the bottom of the file.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md.
-         */
-        // "import/exports-last": "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.
@@ -51,37 +34,17 @@ export default {
         "import/extensions": ["off", "always", { ignorePackages: true }],
 
         /**
-         * Disallow non-import statements appearing before import statements
+         * Disallow non-import statements appearing before import statements. 🔧
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md.
          */
         "import/first": "error",
 
-        /**
-         * Reports when named exports are not grouped together in a single export declaration
-         * or when multiple assignments to CommonJS module.exports or exports object are present
-         * in a single file.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md.
-         */
-        // "import/group-exports": "off",
-
-        /**
-         * Forbid modules to have too many dependencies
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md.
-         */
-        // "import/max-dependencies": ["off", { max: 10 }],
-
         /**
          * Ensure named imports coupled with named exports
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/named.md#.
          */
         "import/named": "error",
 
-        /**
-         * Enforces names exist at the time they are dereferenced, when imported as a full namespace
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md.
-         */
-        // "import/namespace": "off",
-
         /**
          * Require a newline after the last import/require in a group
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md.
@@ -89,7 +52,7 @@ export default {
         "import/newline-after-import": "error",
 
         /**
-         * Forbid import of modules using absolute paths
+         * 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",
@@ -100,28 +63,6 @@ export default {
          */
         "import/no-amd": "error",
 
-        /**
-         * Reports if a module"s default export is unnamed
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-anonymous-default-export.md.
-         */
-        // "import/no-anonymous-default-export": [
-        //     "off",
-        //     {
-        //         allowArray: false,
-        //         allowArrowFunction: false,
-        //         allowAnonymousClass: false,
-        //         allowAnonymousFunction: false,
-        //         allowLiteral: false,
-        //         allowObject: false,
-        //     },
-        // ],
-
-        /**
-         * Disallow require()
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-commonjs.md.
-         */
-        // "import/no-commonjs": "off",
-
         /**
          * Forbid cyclical dependencies between modules
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md.
@@ -129,22 +70,10 @@ export default {
         "import/no-cycle": ["error", { ignoreExternal: true }],
 
         /**
-         * Forbid default exports. This is a terrible rule, do not use it.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md.
-         */
-        // "import/no-default-export": "off",
-
-        /**
-         * Disallow use of jsdoc-marked-deprecated imports
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md.
-         */
-        // "import/no-deprecated": "off",
-
-        /**
-         * Disallow duplicate imports
+         * Disallow duplicate imports. 🔧
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md.
          */
-        "import/no-duplicates": "error",
+        "import/no-duplicates": ["error", { "prefer-inline": false }],
 
         /**
          * Forbid require() calls with expressions
@@ -153,53 +82,11 @@ export default {
         "import/no-dynamic-require": "error",
 
         /**
-         * Forbid the use of extraneous packages
-         * paths are treated both as absolute paths, and relative to process.cwd()
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md.
-         */
-        // "import/no-extraneous-dependencies": [
-        //     "off",
-        //     {
-        //         devDependencies: [
-        //             "test/**", // tape, common npm pattern
-        //             "tests/**", // also common npm pattern
-        //             "spec/**", // mocha, rspec-like pattern
-        //             "**/__tests__/**", // jest pattern
-        //             "**/__mocks__/**", // jest pattern
-        //             "test.{js,jsx}", // repos with a single test file
-        //             "test-*.{js,jsx}", // repos with multiple top-level test files
-        //             "**/*{.,_}{test,spec}.{js,jsx}", // tests where the extension or filename suffix denotes that it is a test
-        //             "**/jest.config.js", // jest config
-        //             "**/jest.setup.js", // jest setup
-        //             "**/vue.config.js", // vue-cli config
-        //             "**/webpack.config.js", // webpack config
-        //             "**/webpack.config.*.js", // webpack config
-        //             "**/rollup.config.js", // rollup config
-        //             "**/rollup.config.*.js", // rollup config
-        //             "**/gulpfile.js", // gulp config
-        //             "**/gulpfile.*.js", // gulp config
-        //             "**/Gruntfile{,.js}", // grunt config
-        //             "**/protractor.conf.js", // protractor config
-        //             "**/protractor.conf.*.js", // protractor config
-        //             "**/karma.conf.js", // karma config
-        //             "**/.eslintrc.js", // eslint config
-        //         ],
-        //         optionalDependencies: false,
-        //     },
-        // ],
-
-        /**
-         * Reports the use of import declarations with CommonJS exports in any module except for the main module.
-         * Https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md.
+         * Reports the use of import declarations with CommonJS exports in any module except for the main module. ✅ 🔧
+         * Https://github.com/benmosher/eslint-plugin-import/blob/main/docs/rules/no-import-module-exports.md.
          */
         "import/no-import-module-exports": ["error", { exceptions: [] }],
 
-        /**
-         * 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", { allow: [] }],
-
         /**
          * Forbid mutable exports
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md.
@@ -225,74 +112,23 @@ export default {
         "import/no-named-default": "error",
 
         /**
-         * Prohibit named exports. This is a terrible rule, do not use it.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-export.md.
-         */
-        // "import/no-named-export": "off",
-
-        /**
-         * Disallow namespace imports
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-namespace.md.
-         */
-        // "import/no-namespace": "off",
-
-        /**
-         * 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",
-
-        /**
-         * Use this rule to prevent importing packages through relative paths.
+         * Use this rule to 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",
 
         /**
-         * Use this rule to prevent imports to folders in relative parent paths.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-parent-imports.md.
-         */
-        // "import/no-relative-parent-imports": "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 a module from importing itself
+         * 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",
 
-        /**
-         * Prevent unassigned imports
-         * importing for side effects is perfectly acceptable, if you need side effects.
-         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unassigned-import.md.
-         */
-        // "import/no-unassigned-import": "off",
-
         /**
          * Ensure imports point to files/modules 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 }],
 
-        /**
-         * Reports modules without any exports, or with unused exports
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md
-         * TODO: enable once it supports CJS.
-         */
-        // "import/no-unused-modules": [
-        //     "off",
-        //     {
-        //         ignoreExports: [],
-        //         missingExports: true,
-        //         unusedExports: true,
-        //     },
-        // ],
-
         /**
          * Ensures that there are no useless path segments
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md.
@@ -306,13 +142,13 @@ export default {
         "import/no-webpack-loader-syntax": "error",
 
         /**
-         * Ensure absolute imports are above relative imports and that unassigned imports are ignored
+         * Ensure absolute imports are above relative imports and that unassigned imports are ignored. 🔧
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md.
          */
         "import/order": [
             "error",
             {
-                groups: [["builtin", "external", "internal"]],
+                groups: [["builtin", "external", "internal"], ["sibling", "parent", "index"]],
                 pathGroups: [
                     {
                         pattern: "react",
@@ -323,20 +159,5 @@ export default {
                 alphabetize: { order: "asc", caseInsensitive: true },
             },
         ],
-
-        /**
-         * Require modules with a single export to use a default export
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md.
-         */
-        // "import/prefer-default-export": "off",
-
-        /**
-         * Warn if a module could be mistakenly parsed as a script by a consumer
-         * leveraging Unambiguous JavaScript Grammar
-         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/unambiguous.md
-         * this should not be enabled until this proposal has at least been *presented* to TC39.
-         * At the moment, it"s not a thing.
-         */
-        // "import/unambiguous": "off",
     },
 };