feat(eslint-config): add support for import resolvers

harshcut · Jul 31, 2022 · 6cf5c25 · 6cf5c25
1 parent a254c15
commit 6cf5c25
Show file tree

Hide file tree

Showing 7 changed files with 291 additions and 7 deletions.
diff --git a/.changeset/beige-zoos-obey.md b/.changeset/beige-zoos-obey.md
@@ -0,0 +1,5 @@
+---
+'@styx-ui/eslint-config': minor
+---
+
+Add support for import resolvers for Node and TypeScript.
diff --git a/.changeset/curly-toes-dance.md b/.changeset/curly-toes-dance.md
@@ -0,0 +1,5 @@
+---
+'@styx-ui/eslint-config': minor
+---
+
+Extend recommended rules for `import` with support for TypeScript.
diff --git a/.changeset/sour-mails-cover.md b/.changeset/sour-mails-cover.md
@@ -0,0 +1,5 @@
+---
+'@styx-ui/eslint-config': minor
+---
+
+Enforce a convention in the order of import statements.
diff --git a/.changeset/stale-wolves-behave.md b/.changeset/stale-wolves-behave.md
@@ -0,0 +1,5 @@
+---
+'@styx-ui/eslint-config': minor
+---
+
+Map file extensions for `import/parsers` and `import/resolver`.
diff --git a/packages/eslint-config/index.js b/packages/eslint-config/index.js
@@ -22,6 +22,8 @@ module.exports = {
   },
   extends: [
     'eslint:recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
     'plugin:react/recommended',
     'plugin:react-hooks/recommended',
     'plugin:jsx-a11y/recommended',
@@ -37,6 +39,13 @@ module.exports = {
     'no-console': 'error',
     'no-inline-comments': 'warn',
     'no-var': 'error',
+    'import/no-anonymous-default-export': 'warn',
+    'import/order': [
+      'warn',
+      {
+        groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+      },
+    ],
     'react/display-name': 'off',
     'react/prop-types': 'off',
     'react/react-in-jsx-scope': 'off',
@@ -66,5 +75,16 @@ module.exports = {
     react: {
       version: 'detect',
     },
+    'import/parsers': {
+      [require.resolve('@typescript-eslint/parser')]: ['.ts', '.tsx', '.d.ts'],
+    },
+    'import/resolver': {
+      [require.resolve('eslint-import-resolver-node')]: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
+      },
+      [require.resolve('eslint-import-resolver-typescript')]: {
+        alwaysTryTypes: true,
+      },
+    },
   },
 }
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -26,6 +26,9 @@
     "@rushstack/eslint-patch": "^1.1.3",
     "@typescript-eslint/parser": "^5.29.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-node": "^0.3.6",
+    "eslint-import-resolver-typescript": "^3.3.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsx-a11y": "^6.6.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.30.1",