@viclafouch/eslint-config-viclafouch 4.1.1 → 4.2.0

package/README.md

@@ -15,7 +15,7 @@ These are the ESLint and Prettier settings for a Next.js project ⚡️
     - [Add the typescript eslint config](#add-the-typescript-eslint-config)
     - [Better typing](#better-typing)
     - [Scripts](#scripts-1)
-  - [Better import sorting](#better-import-sorting)
+  - [If you want to enable imports sorting](#if-you-want-to-enable-imports-sorting)
   - [If you use Next.js](#if-you-use-nextjs)
   - [If you use React.js](#if-you-use-reactjs)
   - [If you want to use Prettier](#if-you-want-to-use-prettier)
@@ -152,24 +152,16 @@ You can add two scripts to your package.json to lint and/or fix your code:
 }
 ```
 
-## Better import sorting
+## If you want to enable imports sorting
 
 If you want to sort your imports using your alias at the same time from your `jsonfig.json` or `tsconfig.json` file.
 
-1. Import the `sortImports` function from the config in your `.eslintrc.js` file:
-
-```js
-const {
-  sortImports
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-} = require('@viclafouch/eslint-config-viclafouch/rules/sort-imports')
-```
-
-2. Include the function in your `overrides` array like this:
-
 ```js
 {
-  overrides: [sortImports(__dirname)]
+  extends: [
+    '@viclafouch/eslint-config-viclafouch',
+    '@viclafouch/eslint-config-viclafouch/imports'
+  ]
 }
 ```
 
@@ -209,6 +201,7 @@ Be sure to add the prettier config at the end of your `extends` array.
 {
   extends: [
     '@viclafouch/eslint-config-viclafouch',
+    '@viclafouch/eslint-config-viclafouch/imports',
     '@viclafouch/eslint-config-viclafouch/react',
     '@viclafouch/eslint-config-viclafouch/hooks',
     '@viclafouch/eslint-config-viclafouch/prettier' // be sure to be the last

package/imports.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: ['./rules/imports.js'].map(require.resolve),
+  rules: {}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viclafouch/eslint-config-viclafouch",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "ESLint and Prettier Config from Victor de la Fouchardiere",
   "main": "index.js",
   "keywords": [
@@ -29,27 +29,28 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@total-typescript/ts-reset": "^0.4.2",
-    "get-tsconfig": "^4.6.2",
-    "@babel/core": "^7.22.9",
-    "@babel/eslint-parser": "^7.22.9",
-    "@next/eslint-plugin-next": "^13.4.12",
-    "@rushstack/eslint-patch": "^1.3.2",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
-    "@typescript-eslint/parser": "^6.2.0",
+    "@babel/core": "^7.22.10",
+    "@babel/eslint-parser": "^7.22.10",
+    "@next/eslint-plugin-next": "^13.4.19",
+    "@rushstack/eslint-patch": "^1.3.3",
+    "@total-typescript/ts-reset": "^0.5.1",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
+    "app-root-path": "^3.1.0",
     "babel-loader": "^9.1.3",
-    "eslint": "^8.45.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.33.0",
+    "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-testing-library": "^5.11.0",
-    "prettier": "^3.0.0",
-    "typescript": "^5.x.x"
+    "eslint-plugin-testing-library": "^6.0.0",
+    "get-tsconfig": "^4.7.0",
+    "prettier": "^3.0.2",
+    "typescript": "^5.1.6"
   },
   "scripts": {
     "lint": "eslint .",

package/rules/imports.js

@@ -1,3 +1,26 @@
+const { getTsconfig } = require('get-tsconfig')
+const appRoot = require('app-root-path')
+
+function extractPaths(paths) {
+  return Object.keys(paths).map((key) => {
+    return key.split('/')[0]
+  })
+}
+
+const tsConfig = getTsconfig(appRoot.path, 'tsconfig.json')
+const jsConfig = getTsconfig(appRoot.path, 'jsconfig.json')
+
+let pathsNames = []
+
+if (tsConfig && tsConfig.config.compilerOptions.paths) {
+  pathsNames = extractPaths(tsConfig.config.compilerOptions.paths)
+} else if (jsConfig && jsConfig.config.compilerOptions.paths) {
+  pathsNames = extractPaths(jsConfig.config.compilerOptions.paths)
+}
+
+/**
+ * @type {import("eslint").Linter.Config}
+ */
 module.exports = {
   parserOptions: {
     sourceType: 'module'
@@ -26,6 +49,9 @@ module.exports = {
             // Anything that starts with a letter
             // e.g: import Downshift from 'downshift'
             '^[a-z]',
+            // Anything that starts with an alias (see jsconfig.json)
+            // e.g: import ListDropdown from '@shared/components/ListDropdown'
+            `^(${pathsNames.join('|')})(/.*|$)`,
             // Anything that starts with @
             // e.g: import { yupResolver } from '@hookform/resolvers/yup'
             '^@',

package/rules/typescript.js

@@ -112,7 +112,11 @@ module.exports = {
         selector: 'typeLike',
         format: ['PascalCase']
       }
-    ]
+    ],
+
+    // Require consistently using T[] instead of Array<T>
+    // https://typescript-eslint.io/rules/array-type
+    '@typescript-eslint/array-type': 'error'
 
     // '@typescript-eslint/ban-types': [
     //   'error',

package/rules/sort-imports.js

@@ -1,62 +0,0 @@
-const { getTsconfig } = require('get-tsconfig')
-
-function extractPaths(paths) {
-  return Object.keys(paths).map((key) => {
-    return key.split('/')[0]
-  })
-}
-
-module.exports = {
-  sortImports: (path) => {
-    const tsConfig = getTsconfig(path, 'tsconfig.json')
-    const jsConfig = getTsconfig(path, 'jsconfig.json')
-
-    let pathsNames = []
-
-    if (tsConfig && tsConfig.config.compilerOptions.paths) {
-      pathsNames = extractPaths(tsConfig.config.compilerOptions.paths)
-    } else if (jsConfig && jsConfig.config.compilerOptions.paths) {
-      pathsNames = extractPaths(jsConfig.config.compilerOptions.paths)
-    }
-
-    return {
-      files: ['*.ts?(x)', '*.js?(x)'],
-      rules: {
-        'simple-import-sort/imports': [
-          'error',
-          {
-            groups: [
-              [
-                // Anything that starts with react
-                // e.g: import { useState } from 'react'
-                // e.g: import { useFela } from 'react-fela'
-                '^react',
-                // Anything that starts with next
-                // e.g: import { useRouter } from 'next/router'
-                '^next',
-                // Anything that starts with a letter
-                // e.g: import Downshift from 'downshift'
-                '^[a-z]',
-                // Anything that starts with an alias (see jsconfig.json)
-                // e.g: import ListDropdown from '@shared/components/ListDropdown'
-                `^(${pathsNames.join('|')})(/.*|$)`,
-                // Anything that starts with @
-                // e.g: import { yupResolver } from '@hookform/resolvers/yup'
-                '^@',
-                // Anything that starts with a dot
-                // e.g: import { matchIsDate } from './utils/date
-                '^\\.',
-                // Side effect imports from lib
-                // e.g: import 'react-toastify/dist/ReactToastify.css'
-                '^\\u0000',
-                // Side effect import that starts with a dot
-                // e.g: import './setup-config'
-                '^\\u0000\\.'
-              ]
-            ]
-          }
-        ]
-      }
-    }
-  }
-}