@paratco/eslint-config 0.6.3 → 0.7.0

package/index.js

@@ -1,13 +1,13 @@
-import baseConfig from "./src/configs/base.js";
-import reactConfig from "./src/configs/react.js";
-import nodeConfig from "./src/configs/node.js";
-import prettierFormatter from "./src/configs/prettierFormatter.js";
-import stylisticFormatter from "./src/configs/stylisticFormatter.js";
-
-export default {
-  base: baseConfig,
-  react: reactConfig,
-  node: nodeConfig,
-  prettierFormatter,
-  stylisticFormatter
-};
+import baseConfig from "./src/configs/base.js";
+import reactConfig from "./src/configs/react.js";
+import nodeConfig from "./src/configs/node.js";
+import prettierFormatter from "./src/configs/prettierFormatter.js";
+import stylisticFormatter from "./src/configs/stylisticFormatter.js";
+
+export default {
+  base: baseConfig,
+  react: reactConfig,
+  node: nodeConfig,
+  prettierFormatter,
+  stylisticFormatter
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paratco/eslint-config",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "type": "module",
   "main": "index.js",
   "author": "Paratco",
@@ -29,6 +29,7 @@
     "@stylistic/eslint-plugin": "^2.3.0",
     "@types/eslint__js": "^8.42.3",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-react": "^7.34.3",
     "eslint-plugin-react-hooks": "^4.6.2",
     "eslint-plugin-react-refresh": "^0.4.7",

package/src/configs/base.js

@@ -1,18 +1,18 @@
-import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
-
-// Custom Rules
-import typescriptRules from "../lints/typescript/index.js";
-
-export default [
-  // Set predefined configs
-  eslint.configs.recommended,
-  ...tseslint.configs.strictTypeChecked,
-  ...tseslint.configs.stylisticTypeChecked,
-
-  // TypeScript Rules
-  {
-    files: ["**/*.{ts,tsx}"],
-    rules: typescriptRules
-  }
-];
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+// Custom Rules
+import typescriptRules from "../lints/typescript/index.js";
+
+export default [
+  // Set predefined configs
+  eslint.configs.recommended,
+  ...tseslint.configs.strictTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+
+  // TypeScript Rules
+  {
+    files: ["**/*.{ts,tsx}"],
+    rules: typescriptRules
+  }
+];

package/src/configs/import.js

@@ -0,0 +1,25 @@
+import eslintPluginImport from "eslint-plugin-import";
+
+// Custom Rules
+import importRules from "../lints/import/index.js";
+
+export default [
+  // ESLint Plugin Import
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    plugins: {
+      import: eslintPluginImport
+    },
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true
+        }
+      }
+    },
+    rules: {
+      ...eslintPluginImport.configs.recommended.rules,
+      ...importRules
+    }
+  }
+];

package/src/configs/node.js

@@ -1,9 +1,11 @@
-import globals from "globals";
-import baseConfig from "./base.js";
-
-export default [
-  ...baseConfig,
-
-  // Node Only
-  { languageOptions: { globals: globals.node } }
-];
+import globals from "globals";
+import baseConfig from "./base.js";
+import importConfig from "./import.js";
+
+export default [
+  ...baseConfig,
+  ...importConfig,
+
+  // Node Only
+  { languageOptions: { globals: globals.node } }
+];

package/src/configs/prettierFormatter.js

@@ -1,4 +1,4 @@
-// Plugins
-import eslintConfigPrettier from "eslint-config-prettier";
-
-export default [eslintConfigPrettier];
+// Plugins
+import eslintConfigPrettier from "eslint-config-prettier";
+
+export default [eslintConfigPrettier];

package/src/configs/react.js

@@ -1,58 +1,60 @@
-import globals from "globals";
-import baseConfig from "./base.js";
-
-// Plugins
-import react from "eslint-plugin-react";
-import reactHooks from "eslint-plugin-react-hooks";
-import reactRefresh from "eslint-plugin-react-refresh";
-
-// Custom Rules
-import reactRules from "../lints/react/index.js";
-
-export default [
-  ...baseConfig,
-
-  // Browser Only
-  { languageOptions: { globals: globals.browser } },
-
-  // Enable JSX
-  { files: ["**/*.tsx"], languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } } },
-
-  // React Plugin
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    plugins: {
-      react: react,
-      "react-hooks": reactHooks,
-      "react-refresh": reactRefresh
-    },
-    settings: {
-      react: {
-        version: "detect"
-      }
-    },
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
-        }
-      },
-      globals: {
-        ...globals.browser
-      }
-    },
-    rules: {
-      ...reactRules,
-      // ...react.configs.recommended.rules,
-      ...reactHooks.configs.recommended.rules,
-
-      // Enforce Rules of Hooks
-      "react-hooks/rules-of-hooks": ["error"],
-      // Verify the list of the dependencies for Hooks like useEffect and similar
-      "react-hooks/exhaustive-deps": ["error"],
-
-      // React Refresh
-      "react-refresh/only-export-components": ["warn", { allowConstantExport: true }]
-    }
-  }
-];
+import globals from "globals";
+import baseConfig from "./base.js";
+import importConfig from "./import.js";
+
+// Plugins
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+
+// Custom Rules
+import reactRules from "../lints/react/index.js";
+
+export default [
+  ...baseConfig,
+  ...importConfig,
+
+  // Browser Only
+  { languageOptions: { globals: globals.browser } },
+
+  // Enable JSX
+  { files: ["**/*.tsx"], languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } } },
+
+  // React Plugin
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    plugins: {
+      react: react,
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh
+    },
+    settings: {
+      react: {
+        version: "detect"
+      }
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true
+        }
+      },
+      globals: {
+        ...globals.browser
+      }
+    },
+    rules: {
+      ...reactRules,
+      // ...react.configs.recommended.rules,
+      ...reactHooks.configs.recommended.rules,
+
+      // Enforce Rules of Hooks
+      "react-hooks/rules-of-hooks": ["error"],
+      // Verify the list of the dependencies for Hooks like useEffect and similar
+      "react-hooks/exhaustive-deps": ["error"],
+
+      // React Refresh
+      "react-refresh/only-export-components": ["warn", { allowConstantExport: true }]
+    }
+  }
+];

package/src/configs/stylisticFormatter.js

@@ -1,33 +1,33 @@
-import stylistic from "@stylistic/eslint-plugin";
-
-// Custom Rules
-import stylisticRules from "../lints/stylistic/index.js";
-
-export default [
-  // Stylistic Configs
-  stylistic.configs.customize({
-    jsx: true,
-    arrowParens: true,
-    flat: true,
-    blockSpacing: true,
-    braceStyle: "stroustrup",
-    commaDangle: "never",
-    indent: 2,
-    semi: true,
-    quotes: "double",
-    quoteProps: "always"
-  }),
-
-  // Stylistic Rules
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
-        }
-      }
-    },
-    rules: stylisticRules
-  }
-];
+import stylistic from "@stylistic/eslint-plugin";
+
+// Custom Rules
+import stylisticRules from "../lints/stylistic/index.js";
+
+export default [
+  // Stylistic Configs
+  stylistic.configs.customize({
+    jsx: true,
+    arrowParens: true,
+    flat: true,
+    blockSpacing: true,
+    braceStyle: "stroustrup",
+    commaDangle: "never",
+    indent: 2,
+    semi: true,
+    quotes: "double",
+    quoteProps: "always"
+  }),
+
+  // Stylistic Rules
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true
+        }
+      }
+    },
+    rules: stylisticRules
+  }
+];

package/src/lints/import/index.js

@@ -0,0 +1,159 @@
+export default {
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md
+  // Forbid imported names marked with @deprecated documentation tag.
+  "import/no-deprecated": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-empty-named-blocks.md
+  // Forbid empty named import blocks.
+  "import/no-empty-named-blocks": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
+  // Forbid the use of extraneous packages.
+  "import/no-extraneous-dependencies": [
+    "error",
+    { devDependencies: false, optionalDependencies: false, peerDependencies: false }
+  ],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md
+  // Forbid the use of mutable exports with var or let.
+  "import/no-mutable-exports": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md
+  // Forbid modules without exports, or exports without matching import in another module.
+  // TODO: Can be enabled
+  "import/no-unused-modules": ["off", { missingExports: true }],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-amd.md
+  // Forbid AMD require and define calls.
+  "import/no-amd": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-commonjs.md
+  // Forbid CommonJS require calls and module.exports or exports.*.
+  "import/no-commonjs": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-import-module-exports.md
+  // Forbid import statements with CommonJS module.exports.
+  "import/no-import-module-exports": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-nodejs-modules.md
+  // Forbid Node.js builtin modules.
+  // TODO: Can enable for front-end
+  "import/no-nodejs-modules": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/unambiguous.md
+  // Forbid potentially ambiguous parse goal (script vs. module).
+  "import/unambiguous": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md
+  // Forbid import of modules using absolute paths.
+  "import/no-absolute-path": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
+  // Forbid a module from importing a module with a dependency path back to itself.
+  "import/no-cycle": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-dynamic-require.md
+  // Forbid require() calls with expressions.
+  "import/no-dynamic-require": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-internal-modules.md
+  // Forbid importing the submodules of other modules.
+  // TODO: Must define in the project
+  "import/no-internal-modules": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md
+  // Forbid importing packages through relative paths.
+  "import/no-relative-packages": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-parent-imports.md
+  // Forbid importing modules from parent directories.
+  "import/no-relative-parent-imports": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-restricted-paths.md
+  // Enforce which files can be imported in a given folder.
+  // TODO: Can be customized
+  // "import/no-restricted-paths": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md
+  // Forbid a module from importing itself.
+  "import/no-self-import": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md
+  // Forbid unnecessary path segments in import and require statements.
+  "import/no-useless-path-segments": [
+    "warn",
+    {
+      noUselessIndex: true
+    }
+  ],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-webpack-loader-syntax.md
+  // Forbid webpack loader syntax in imports.
+  "import/no-webpack-loader-syntax": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/consistent-type-specifier-style.md
+  // Enforce or ban the use of inline type-only markers for named imports.
+  "import/consistent-type-specifier-style": ["warn", "prefer-top-level"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/dynamic-import-chunkname.md
+  // Enforce a leading comment with the webpackChunkName for dynamic imports.
+  "import/dynamic-import-chunkname": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
+  // Ensure all exports appear after other statements.
+  // TODO: Can be enabled
+  "import/exports-last": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
+  // Ensure consistent use of file extension within the import path.
+  "import/extensions": ["error", "never"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+  // Ensure all imports appear before other statements.
+  "import/first": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md
+  // Prefer named exports to be grouped together in a single export declaration
+  // TODO: Can be enabled
+  "import/group-exports": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/max-dependencies.md
+  // Enforce the maximum number of dependencies a module can have.
+  "import/max-dependencies": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+  // Enforce a newline after import statements.
+  "import/newline-after-import": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-anonymous-default-export.md
+  // Forbid anonymous values as default exports.
+  "import/no-anonymous-default-export": ["error"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
+  // Forbid default exports.
+  "import/no-default-export": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-default.md
+  // Forbid named default exports.
+  "import/no-named-default": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-export.md
+  // Forbid named exports.
+  "import/no-named-export": ["off"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-namespace.md
+  // Forbid namespace (a.k.a. "wildcard" *) imports.
+  "import/no-namespace": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unassigned-import.md
+  // Forbid unassigned imports
+  "import/no-unassigned-import": ["error", { allow: ["**/*.css"] }],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+  // Enforce a convention in module import order.
+  "import/order": ["warn"],
+
+  // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
+  // Prefer a default export if module exports a single name or multiple names.
+  "import/prefer-default-export": ["off"]
+};