@jsimck/eslint-config 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsimck/eslint-config",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Very opinionated eslint config I use on my projects, includes: prettier, TS, jest, sonarqube and unicorn. And many others.",
   "type": "module",
   "main": "./index.js",

package/src/configs/base.js

@@ -0,0 +1,100 @@
+import globals from 'globals';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    ignores: [
+      '**/out/**',
+      '**/*.gen.ts',
+      '**/node_modules/**',
+      '**/.next/**',
+      '**/.expo/**',
+      '**/dist/**',
+      '**/build/**',
+      '**/docs/**',
+      '**/storybook-static/**',
+      '**/.docusaurus/**',
+      '**/coverage/**',
+    ],
+  },
+  {
+    files: [...files.js, ...files.ts],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      // Stylistic has to be migrated -->>
+      // Lines between class member methods
+      'lines-between-class-members': [
+        'error',
+        'always',
+        {
+          exceptAfterSingleLine: true,
+        },
+      ],
+
+      // Line spacing
+      'padding-line-between-statements': [
+        'error',
+        {
+          blankLine: 'always',
+          next: 'class',
+          prev: '*',
+        },
+        {
+          blankLine: 'always',
+          next: '*',
+          prev: 'class',
+        },
+        {
+          blankLine: 'always',
+          next: 'return',
+          prev: '*',
+        },
+        {
+          blankLine: 'always',
+          next: 'case',
+          prev: '*',
+        },
+        {
+          blankLine: 'always',
+          next: 'default',
+          prev: '*',
+        },
+        {
+          blankLine: 'always',
+          next: 'export',
+          prev: '*',
+        },
+        {
+          blankLine: 'any',
+          next: 'case',
+          prev: 'case',
+        },
+        {
+          blankLine: 'any',
+          next: 'export',
+          prev: 'export',
+        },
+        {
+          blankLine: 'always',
+          next: '*',
+          prev: 'import',
+        },
+        {
+          blankLine: 'any',
+          next: 'import',
+          prev: 'import',
+        },
+      ],
+    },
+  },
+];

package/src/configs/import.js

@@ -0,0 +1,62 @@
+import importPlugin from 'eslint-plugin-import-x';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.js, ...files.ts],
+    plugins: { 'import-x': importPlugin },
+    settings: {
+      'import-x/parsers': {
+        espree: ['.js', '.cjs', '.mjs', '.jsx'],
+      },
+      'import-x/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+    rules: {
+      ...importPlugin.configs.recommended.rules,
+      'import-x/no-duplicates': ['error', { 'prefer-inline': true }],
+      'import-x/newline-after-import': ['error', { considerComments: false }],
+      'import-x/no-unresolved': [
+        'warn',
+        {
+          ignore: [
+            String.raw`^@/`, // ignore @/* aliases
+            '@(docusaurus|theme)',
+          ],
+        },
+      ],
+      'import-x/order': [
+        'error',
+        {
+          groups: ['builtin', 'external', 'internal'],
+          pathGroups: [
+            {
+              pattern: '{preact|react|svelte|docusaurus|theme}{/**,**}',
+              group: 'external',
+              position: 'before',
+            },
+            {
+              pattern: '@/**',
+              group: 'internal',
+              position: 'after',
+            },
+            {
+              pattern: '*.{css,less,json,html,txt,csv,png,jpg,svg}',
+              group: 'object',
+              patternOptions: { matchBase: true },
+              position: 'after',
+            },
+          ],
+          'newlines-between': 'always',
+          alphabetize: {
+            order: 'asc',
+            caseInsensitive: true,
+          },
+        },
+      ],
+    },
+  },
+];

package/src/configs/index.d.ts

@@ -0,0 +1,9 @@
+export const base: [];
+export const imprt: [];
+export const jest: [];
+export const next: [];
+export const prettier: [];
+export const react: [];
+export const typescript: [];
+export const unusedImports: [];
+export const typescriptTypeChecked: [];

package/src/configs/index.js

@@ -0,0 +1,13 @@
+export { default as base } from './base.js';
+export { default as javascript } from './javascript.js';
+export { default as imprt } from './import.js';
+export { default as jest } from './jest.js';
+export { default as next } from './next.js';
+export { default as prettier } from './prettier.js';
+export { default as react } from './react.js';
+export { default as typescript } from './typescript.js';
+export { default as unusedImports } from './unusedImports.js';
+export { default as typescriptTypeChecked } from './typescriptTypeChecked.js';
+export { default as sonarjs } from './sonarjs.js';
+export { default as unicorn } from './unicorn.js';
+export { default as sortClassMembers } from './sortClassMembers.js';

package/src/configs/javascript.js

@@ -0,0 +1,32 @@
+import js from '@eslint/js';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.js],
+    ...js.configs.recommended,
+    rules: {
+      ...js.configs.recommended.rules,
+      'no-return-await': 'error',
+      'no-console': [
+        'warn',
+        {
+          allow: ['warn', 'error'],
+        },
+      ],
+      curly: ['error', 'all'],
+      'dot-notation': ['error'],
+      'no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+          args: 'none',
+        },
+      ],
+    },
+  },
+];

package/src/configs/jest.js

@@ -0,0 +1,66 @@
+import jest from 'eslint-plugin-jest';
+import jestFormatting from 'eslint-plugin-jest-formatting';
+import globals from 'globals';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: files.test,
+    plugins: {
+      jest,
+      'jest-formatting': jestFormatting,
+    },
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+    rules: {
+      // Jest plugin customization
+      ...jest.configs.recommended.rules,
+      ...jest.configs.style.rules,
+      'jest/consistent-test-it': ['error', { fn: 'it' }],
+      'jest/max-nested-describe': [
+        'error',
+        {
+          max: 3,
+        },
+      ],
+      'jest/no-duplicate-hooks': 'error',
+      'jest/no-conditional-in-test': 'warn',
+      'jest/no-done-callback': 'warn',
+      'jest/no-large-snapshots': ['warn', { maxSize: 100, inlineMaxSize: 20 }],
+      'jest/no-mocks-import': 'off',
+      'jest/no-test-return-statement': 'warn',
+      'jest/prefer-expect-resolves': 'error',
+      'jest/prefer-strict-equal': 'warn',
+      'jest/prefer-spy-on': 'off',
+      'jest/prefer-hooks-on-top': 'error',
+      'jest/prefer-todo': 'error',
+      'jest/require-hook': 'warn',
+      'jest/prefer-called-with': 'warn',
+      'jest/no-conditional-expect': 'warn',
+      'jest/no-identical-title': 'warn',
+      'jest/prefer-each': 'error',
+      'jest/prefer-equality-matcher': 'error',
+      'jest/prefer-comparison-matcher': 'error',
+      'jest/prefer-mock-promise-shorthand': 'error',
+      'jest/prefer-lowercase-title': [
+        'error',
+        {
+          ignore: ['describe'],
+        },
+      ],
+
+      // Jest-formatting plugin customization
+      'jest-formatting/padding-around-after-all-blocks': 'error',
+      'jest-formatting/padding-around-after-each-blocks': 'error',
+      'jest-formatting/padding-around-before-all-blocks': 'error',
+      'jest-formatting/padding-around-before-each-blocks': 'error',
+      'jest-formatting/padding-around-expect-groups': 'error',
+      'jest-formatting/padding-around-describe-blocks': 'error',
+      'jest-formatting/padding-around-test-blocks': 'error',
+    },
+  },
+];

package/src/configs/next.js

@@ -0,0 +1,13 @@
+import next from '@next/eslint-plugin-next';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.js, ...files.ts],
+    plugins: { '@next/next': next },
+    rules: {
+      ...next.configs.recommended.rules,
+    },
+  },
+];

package/src/configs/prettier.js

@@ -0,0 +1,30 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+export default [
+  ...compat.extends('plugin:prettier/recommended'),
+  {
+    rules: {
+      'prettier/prettier': [
+        'error',
+        {
+          singleQuote: true,
+          semi: true,
+          trailingComma: 'all',
+          jsxSingleQuote: true,
+          bracketSameLine: false,
+          arrowParens: 'avoid',
+        },
+      ],
+    },
+  },
+];

package/src/configs/react.js

@@ -0,0 +1,176 @@
+import jsxAlly from 'eslint-plugin-jsx-a11y';
+import reactPlugin from 'eslint-plugin-react';
+import hooksPlugin from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: files.jsx,
+    plugins: {
+      react: reactPlugin,
+      'jsx-a11y': jsxAlly,
+      'react-refresh': reactRefresh,
+    },
+    settings: {
+      react: {
+        version: '18',
+      },
+    },
+    rules: {
+      ...reactPlugin.configs.recommended.rules,
+      ...reactPlugin.configs['jsx-runtime'].rules,
+      'react-refresh/only-export-components': 'warn',
+      'react/boolean-prop-naming': 'off',
+      // 'react/boolean-prop-naming': [
+      //   'error',
+      //   {
+      //     message:
+      //       'Invalid boolean prop name, use one of (is|has|show|hide) prefixes.',
+      //     propTypeNames: ['bool', 'mutuallyExclusiveTrueProps'],
+      //     rule: '^(is|has|show|hide)[A-Z]([A-Za-z0-9]?)+',
+      //   },
+      // ],
+      'react/jsx-no-useless-fragment': ['error', { allowExpressions: true }],
+      'react/default-props-match-prop-types': 'off',
+      'react/display-name': ['off'],
+      'react/function-component-definition': [
+        'error',
+        {
+          namedComponents: 'function-declaration',
+          unnamedComponents: 'arrow-function',
+        },
+      ],
+      'react/hook-use-state': ['warn', { allowDestructuredState: true }],
+      'react/no-access-state-in-setstate': 'error',
+      'react/no-adjacent-inline-elements': 'error',
+      'react/no-array-index-key': 'warn',
+      'react/no-arrow-function-lifecycle': 'error',
+      'react/no-did-update-set-state': 'error',
+      'react/no-find-dom-node': 'error',
+      'react/no-multi-comp': 'error',
+      'react/no-namespace': 'error',
+      'react/no-redundant-should-component-update': 'error',
+      'react/no-invalid-html-attribute': 'error',
+      'react/no-this-in-sfc': 'error',
+      'react/no-typos': 'error',
+      'react/no-unsafe': 'error',
+      'react/no-unstable-nested-components': ['warn', { allowAsProps: true }],
+      'react/no-unused-class-component-methods': 'warn',
+      'react/no-unused-prop-types': 'off',
+      'react/no-unused-state': 'error',
+      'react/no-will-update-set-state': 'error',
+      'react/prefer-es6-class': ['error', 'always'],
+      'react/prefer-stateless-function': 'error',
+      'react/prop-types': 'off',
+      'react/require-render-return': 'error',
+      'react/no-unknown-property': 'warn',
+      'react/self-closing-comp': 'error',
+      'react/state-in-constructor': ['error', 'always'],
+      'react/static-property-placement': [
+        'error',
+        'property assignment',
+        {
+          childContextTypes: 'static getter',
+          contextType: 'static getter',
+          contextTypes: 'static getter',
+          defaultProps: 'static getter',
+          displayName: 'static getter',
+          propTypes: 'static getter',
+        },
+      ],
+      'react/style-prop-object': 'error',
+      'react/void-dom-elements-no-children': 'error',
+
+      // jsx specifics
+      'react/jsx-boolean-value': [
+        'error',
+        'never',
+        {
+          always: [],
+        },
+      ],
+      'react/jsx-child-element-spacing': 'error',
+      'react/jsx-closing-bracket-location': ['error', 'tag-aligned'],
+      'react/jsx-closing-tag-location': 'error',
+      'react/jsx-curly-brace-presence': [
+        'error',
+        {
+          children: 'never',
+          props: 'never',
+        },
+      ],
+      'react/jsx-curly-newline': [
+        'error',
+        {
+          multiline: 'consistent',
+          singleline: 'consistent',
+        },
+      ],
+      'react/jsx-filename-extension': [
+        'error',
+        {
+          extensions: ['.jsx', '.tsx'],
+        },
+      ],
+      'react/jsx-first-prop-new-line': ['error', 'multiline-multiprop'],
+      'react/jsx-fragments': ['error', 'syntax'],
+      'react/jsx-handler-names': [
+        'warn',
+        {
+          eventHandlerPrefix: 'handle',
+          eventHandlerPropPrefix: 'on',
+          checkLocalVariables: false,
+          checkInlineFunction: false,
+        },
+      ],
+      'react/jsx-max-props-per-line': [
+        'error',
+        {
+          maximum: 1,
+          when: 'multiline',
+        },
+      ],
+      'react/jsx-newline': ['error', { prevent: true }],
+      'react/jsx-no-constructed-context-values': 'error',
+      'react/jsx-no-script-url': 'error',
+      'react/jsx-one-expression-per-line': [
+        'error',
+        {
+          allow: 'single-child',
+        },
+      ],
+      'react/jsx-pascal-case': [
+        'error',
+        {
+          allowAllCaps: true,
+          ignore: [],
+        },
+      ],
+      'react/jsx-props-no-multi-spaces': 'error',
+      'react/jsx-wrap-multilines': [
+        'error',
+        {
+          arrow: 'parens-new-line',
+          assignment: 'parens-new-line',
+          condition: 'parens-new-line',
+          declaration: 'parens-new-line',
+          logical: 'parens-new-line',
+          prop: 'parens-new-line',
+          return: 'parens-new-line',
+        },
+      ],
+    },
+  },
+  {
+    // Hooks are usually defined in non-jsx extension files
+    files: [...files.ts, ...files.js],
+    plugins: {
+      'react-hooks': hooksPlugin,
+    },
+    rules: {
+      ...hooksPlugin.configs.recommended.rules,
+    },
+  },
+];

package/src/configs/sonarjs.js

@@ -0,0 +1,25 @@
+import sonarjs from 'eslint-plugin-sonarjs';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.ts, ...files.js],
+    plugins: { sonarjs },
+    rules: {
+      ...sonarjs.configs.recommended.rules,
+      'sonarjs/cognitive-complexity': 'warn',
+      'sonarjs/no-identical-functions': ['warn', 3],
+      'sonarjs/no-duplicate-string': ['warn', { threshold: 10 }],
+      'sonarjs/no-nested-template-literals': 'off',
+      'sonarjs/no-useless-catch': 'warn',
+      'sonarjs/no-inverted-boolean-check': 'warn',
+    },
+  },
+  {
+    files: files.test,
+    rules: {
+      'sonarjs/no-duplicate-string': 'off',
+    },
+  },
+];

package/src/configs/sortClassMembers.js

@@ -0,0 +1,28 @@
+import sortClassMembers from 'eslint-plugin-sort-class-members';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.js, ...files.ts],
+    ...sortClassMembers.configs['flat/recommended'],
+    rules: {
+      ...sortClassMembers.configs['flat/recommended'].rules,
+      'sort-class-members/sort-class-members': [
+        'error',
+        {
+          order: [
+            '[static-properties]',
+            '[static-methods]',
+            '[properties]',
+            '[conventional-private-properties]',
+            'constructor',
+            '[methods]',
+            '[conventional-private-methods]',
+          ],
+          accessorPairPositioning: 'together',
+        },
+      ],
+    },
+  },
+];

package/src/configs/typescript.js

@@ -0,0 +1,58 @@
+import tsEslint from 'typescript-eslint';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: files.ts,
+    languageOptions: {
+      parser: tsEslint.parser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        jsDocParsingMode: 'none',
+        jsxPragma: null,
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsEslint.plugin,
+    },
+    rules: {
+      ...tsEslint.configs.eslintRecommended.rules,
+      ...tsEslint.configs.recommended.rules,
+      ...tsEslint.configs.stylistic.rules,
+      '@typescript-eslint/prefer-nullish-coalescing': 'off',
+      'default-param-last': 'off',
+      '@typescript-eslint/default-param-last': 'error',
+      '@typescript-eslint/method-signature-style': ['error', 'property'],
+      'dot-notation': 'off',
+      '@typescript-eslint/no-require-imports': 'error',
+      '@typescript-eslint/no-useless-empty-export': 'error',
+      '@typescript-eslint/consistent-type-definitions': 'off',
+      '@typescript-eslint/no-import-type-side-effects': 'error',
+      '@typescript-eslint/consistent-type-imports': [
+        'error',
+        { prefer: 'type-imports' },
+      ],
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/ban-ts-comment': [
+        'error',
+        { 'ts-expect-error': 'allow-with-description' },
+      ],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+          args: 'none',
+        },
+      ],
+      '@typescript-eslint/no-namespace': ['error', { allowDeclarations: true }],
+      // turn off eslint undef
+      'no-undef': 'off',
+    },
+  },
+];

package/src/configs/typescriptTypeChecked.js

@@ -0,0 +1,18 @@
+import tsEslint from 'typescript-eslint';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: files.ts,
+    languageOptions: {
+      parserOptions: { projectService: true },
+    },
+    rules: {
+      ...tsEslint.configs.recommendedTypeChecked.rules,
+      ...tsEslint.configs.stylisticTypeChecked.rules,
+      '@typescript-eslint/consistent-type-exports': 'error',
+      'no-undef': 'off',
+    },
+  },
+];

package/src/configs/unicorn.js

@@ -0,0 +1,57 @@
+import unicorn from 'eslint-plugin-unicorn';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.ts, ...files.js],
+    ...unicorn.configs['flat/recommended'],
+    rules: {
+      ...unicorn.configs['flat/recommended'].rules,
+      'unicorn/filename-case': 'off',
+      'unicorn/no-array-callback-reference': 'off',
+      'unicorn/no-array-for-each': 'off',
+      'unicorn/no-array-reduce': 'off',
+      'unicorn/no-document-cookie': 'warn',
+      'unicorn/no-null': 'off',
+      'unicorn/no-static-only-class': 'off',
+      'unicorn/no-unused-properties': 'warn',
+      'unicorn/numeric-separators-style': [
+        'error',
+        { onlyIfContainsSeparator: true },
+      ],
+      'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
+      'unicorn/prefer-module': 'warn',
+      'unicorn/switch-case-braces': ['error', 'avoid'],
+      'unicorn/prefer-object-from-entries': 'warn',
+      'unicorn/catch-error-name': 'off',
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/relative-url-style': ['error', 'always'],
+      'unicorn/consistent-function-scoping': 'warn',
+      'unicorn/prefer-spread': 'off',
+      'unicorn/no-negated-condition': 'warn',
+      'unicorn/no-typeof-undefined': ['error', { checkGlobalVariables: false }],
+      'unicorn/no-await-expression-member': 'off',
+      'unicorn/explicit-length-check': 'off',
+      'unicorn/prefer-logical-operator-over-ternary': 'warn',
+      'unicorn/consistent-destructuring': 'warn',
+      'unicorn/no-unreadable-iife': 'warn',
+      'unicorn/prefer-event-target': 'warn',
+      'unicorn/prefer-query-selector': 'off',
+      'unicorn/prefer-string-slice': 'off',
+      'unicorn/no-useless-undefined': ['error', { checkArguments: false }],
+
+      // Style rules turned off due to prettier
+      'unicorn/empty-brace-spaces': 'off',
+
+      // This causes issues with some frameworks but is really rare to use
+      'unicorn/no-array-method-this-argument': 'off',
+    },
+  },
+  {
+    files: files.test,
+    rules: {
+      'unicorn/no-duplicate-string': 'off',
+    },
+  },
+];

package/src/configs/unusedImports.js

@@ -0,0 +1,24 @@
+import unusedImportsPlugin from 'eslint-plugin-unused-imports';
+
+import { files } from '../utils/helpers.js';
+
+export default [
+  {
+    files: [...files.js, ...files.ts],
+    plugins: { 'unused-imports': unusedImportsPlugin },
+    rules: {
+      'no-unused-vars': 'off',
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+          args: 'none',
+        },
+      ],
+    },
+  },
+];

package/src/utils/helpers.js

@@ -0,0 +1,20 @@
+/**
+ * File extensions for specific file types.
+ */
+export const files = {
+  ts: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+  js: ['**/*.js', '**/*.jsx', '**/*.mjs', '**/*.cjs'],
+  jsx: ['**/*.tsx', '**/*.jsx'],
+  test: [
+    '**/*.test.*',
+    '**/*_test.*',
+    '**/*Test.*',
+    '**/*.spec.*',
+    '**/*_spec.*',
+    '**/*Spec.*',
+    '**/__tests__/**/*',
+    '**/__integration__/**/*',
+    '**/__regression__/**/*',
+    '**/__mocks__/**/*',
+  ],
+};