Merge pull request #373 from Vizzuality/feat/order-imports

feat: order imports eslint configs
Vizzuality · Jul 28, 2021 · 43105f5 · 43105f5
2 parents 2dc03e7 + e36dd48
commit 43105f5
Show file tree

Hide file tree

Showing 3 changed files with 259 additions and 70 deletions.
diff --git a/app/.eslintrc.js b/app/.eslintrc.js
@@ -20,7 +20,7 @@ module.exports = {
     'plugin:react/recommended', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
     'plugin:cypress/recommended',
   ],
-  plugins: ['cypress'],
+  plugins: ['cypress', 'import'],
   rules: {
     // Place to specify ESLint rules.
     // Can be used to overwrite rules specified from the extended configs
@@ -31,5 +31,76 @@ module.exports = {
     'import/no-named-as-default': 0,
     'import/prefer-default-export': 0,
     'no-param-reassign': ['error', { props: false }],
+    'import/order': [
+      'warn',
+      {
+        groups: ['builtin', 'external', 'internal', 'parent', 'sibling'],
+        'newlines-between': 'always',
+        alphabetize: {
+          order: 'asc',
+          caseInsensitive: true,
+        },
+        pathGroups: [
+          {
+            pattern: 'react',
+            group: 'builtin',
+            position: 'before',
+          },
+          {
+            pattern: 'react**',
+            group: 'builtin',
+          },
+          {
+            pattern: '@react**',
+            group: 'builtin',
+          },
+          {
+            pattern: 'next/**',
+            group: 'builtin',
+            position: 'after',
+          },
+          {
+            pattern: 'node_modules/**',
+            group: 'builtin',
+          },
+          {
+            pattern: 'hooks/**',
+            group: 'builtin',
+            position: 'after',
+          },
+          {
+            pattern: 'hoc/**',
+            group: 'external',
+            position: 'before',
+          },
+          {
+            pattern: 'store/**',
+            group: 'external',
+          },
+          {
+            pattern: 'layout/**',
+            group: 'internal',
+            position: 'before',
+          },
+          {
+            pattern: 'components/**',
+            group: 'internal',
+          },
+          {
+            pattern: 'images/**',
+            group: 'internal',
+            position: 'after',
+          },
+          {
+            pattern: 'svgs/**',
+            group: 'internal',
+            position: 'after',
+          },
+        ],
+        pathGroupsExcludedImportTypes: [
+          'react',
+        ],
+      },
+    ],
   },
 };
diff --git a/app/package.json b/app/package.json
@@ -105,7 +105,7 @@
     "eslint": "^7.14.0",
     "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-plugin-cypress": "^2.11.2",
-    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-react": "^7.21.5",
     "eslint-plugin-react-hooks": "^4.2.0",