@shopgate/eslint-config 7.30.0-alpha.10 → 7.30.0-alpha.11

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "@shopgate/eslint-config",
-  "version": "7.30.0-alpha.10",
+  "version": "7.30.0-alpha.11",
   "description": "Eslint configuration for the Shopgate Connect projects.",
   "author": "Shopgate <support@shopgate.com>",
   "license": "Apache-2.0",
   "main": "./ruleset/index.js",
   "dependencies": {
-    "babel-eslint": "^10.0.2",
-    "eslint-config-airbnb": "~17.1.0",
-    "eslint-import-resolver-babel-module": "^5.1.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-import-resolver-babel-module": "^5.3.2",
+    "eslint-import-resolver-exports": "^1.0.0-beta.5",
     "eslint-plugin-cypress": "^2.6.1",
-    "eslint-plugin-eslint-comments": "^3.1.2",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-extra-rules": "~0.0.0-development",
-    "eslint-plugin-import": "~2.18.0",
-    "eslint-plugin-json": "^1.3.2",
-    "eslint-plugin-jsx-a11y": "~6.2.3",
-    "eslint-plugin-react": "~7.14.2",
-    "eslint-plugin-react-hooks": "~1.5.0",
-    "eslint-plugin-tss-unused-classes": "1.0.3"
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-tss-unused-classes": "^1.0.3"
   },
   "devDependencies": {
-    "eslint": "~5.12.0"
+    "eslint": "^8.57.1"
   },
   "peerDependencies": {
-    "eslint": "~5.12.0"
+    "eslint": "^8.57.1"
   }
 }

package/ruleset/main.js

@@ -1,6 +1,5 @@
 module.exports = {
   extends: 'airbnb',
-  parser: 'babel-eslint',
   env: {
     browser: true,
     node: true,
@@ -9,18 +8,13 @@ module.exports = {
     'cypress/globals': true,
   },
   parserOptions: {
-    ecmaVersion: 6,
+    ecmaVersion: 2022,
     sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
   },
   rules: {
-    // Added this according to: https://eslint.org/docs/rules/camelcase#allow
-    camelcase: ['error', {
-      allow: [
-        'UNSAFE_componentWillMount',
-        'UNSAFE_componentWillReceiveProps',
-        'UNSAFE_componentWillUpdate',
-      ],
-    }],
     'capitalized-comments': 0,
     'comma-dangle': ['error', {
       arrays: 'always-multiline',
@@ -95,12 +89,86 @@ module.exports = {
     }],
     'operator-linebreak': 0,
     'implicit-arrow-linebreak': 0,
+
+    // ## Fixes of Airbnb rules for our use cases
+
+    // Error on inconsistent line breaks in function parentheses
+    'function-paren-newline': ['error', 'consistent'],
+    'no-restricted-exports': [
+      'warn',
+      {
+      // Allow export { default } from '...';
+        restrictDefaultExports: { defaultFrom: false },
+      },
+    ],
+    // Just warn about non-camelcase variables since sometimes they are required (e.g., API data)
+    camelcase: 'warn',
+    // Just warn about class methods that don't use 'this' to avoid heavy refactoring
+    'class-methods-use-this': 'warn',
+    // Just warn about unexpected side effects by using async functions as Promise executors
+    'no-async-promise-executor': 'warn',
+    // Just warn about circular dependencies since they are hard to avoid completely
+    'import/no-cycle': 'warn',
+
+    // Omit parentheses when there is only one argument to an arrow function
+    'arrow-parens': [
+      'error',
+      'as-needed',
+      { requireForBlockBody: true },
+    ],
+
+    // ## ESLint complain makes sense - revisit at the next refactoring
+
+    // In functions parameters with default values should be last - violated e.g. in reducers where
+    // state = initialState is the first parameter, but the action parameter has no default value.
+    'default-param-last': 'warn',
+    // In switch statements, require 'default' case to be last
+    'default-case-last': 'warn',
+    // Return values of Promise executor functions don't make sense
+    'no-promise-executor-return': 'warn',
+    // Prefer Object spread over Object.assign
+    'prefer-object-spread': 'warn',
+    // Catch blocks that only rethrow the caught error are redundant
+    'no-useless-catch': 'warn',
+    // Prefer regex literals over RegExp constructor
+    'prefer-regex-literals': 'warn',
+
+    // ## Autofixable - can be removed when ESLint update pull request is merged
+    indent: 'warn',
+    semi: ['warn', 'always'],
   },
+  // Overrides for files that are tests or mocks
+  overrides: [
+    {
+      files: [
+        '**/*.spec.js',
+        '**/*.spec.jsx',
+        '**/*.test.js',
+        '**/*.test.jsx',
+        '**/*.mock.js',
+        '**/*.mock.jsx',
+        '**/spec.js',
+        '**/spec.jsx',
+        '**/mock.js',
+        '**/mock.jsx',
+      ],
+      rules: {
+        // Allow more than one class per file in test files
+        'max-classes-per-file': 'off',
+        // Allow non-camelcase names in test files (e.g., snake_case from API)
+        camelcase: 'off',
+      },
+    },
+  ],
   settings: {
     'import/extensions': [
       '.js',
       '.json',
       '.jsx',
     ],
+    'import/resolver': {
+      exports: {},
+      node: {},
+    },
   },
 };

package/ruleset/react.js

@@ -1,55 +1,86 @@
 module.exports = {
-  plugins: [
-    'react-hooks',
-  ],
+  plugins: ['react-hooks'],
   rules: {
-    'react/sort-prop-types': [2, {
-      callbacksLast: false,
-      ignoreCase: true,
-      requiredFirst: true,
-    }],
-    'react/destructuring-assignment': 0,
-    'react/jsx-wrap-multilines': 0,
-    'jsx-a11y/label-has-for': 0,
-    'react-hooks/rules-of-hooks': 1,
-    'react-hooks/exhaustive-deps': 1,
+    'react/sort-prop-types': [
+      'error',
+      {
+        callbacksLast: false,
+        ignoreCase: true,
+        requiredFirst: true,
+      },
+    ],
+    'react/destructuring-assignment': 'off',
+    'react/jsx-wrap-multilines': 'off',
+    'jsx-a11y/label-has-for': 'off',
+    'react-hooks/rules-of-hooks': 'warn',
+    'react-hooks/exhaustive-deps': 'warn',
     // Added this according to: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md#rule-options
-    'react/sort-comp': ['error', {
-      order: [
-        'static-methods',
-        'lifecycle',
-        'everything-else',
-        'render',
-      ],
-      groups: {
-        lifecycle: [
-          'displayName',
-          'propTypes',
-          'contextTypes',
-          'childContextTypes',
-          'mixins',
-          'statics',
-          'defaultProps',
-          'constructor',
-          'getDefaultProps',
-          'state',
-          'getInitialState',
-          'getChildContext',
-          'getDerivedStateFromProps',
-          'componentWillMount',
-          'UNSAFE_componentWillMount',
-          'componentDidMount',
-          'componentWillReceiveProps',
-          'UNSAFE_componentWillReceiveProps',
-          'shouldComponentUpdate',
-          'componentWillUpdate',
-          'UNSAFE_componentWillUpdate',
-          'getSnapshotBeforeUpdate',
-          'componentDidUpdate',
-          'componentDidCatch',
-          'componentWillUnmount',
+    'react/sort-comp': [
+      'error',
+      {
+        order: [
+          'static-variables',
+          'static-methods',
+          'lifecycle',
+          'everything-else',
+          'render',
         ],
+        groups: {
+          lifecycle: [
+            'displayName',
+            'propTypes',
+            'defaultProps',
+            'contextTypes',
+            'childContextTypes',
+            'mixins',
+            'statics',
+            'constructor',
+            'getDefaultProps',
+            'state',
+            'getInitialState',
+            'getChildContext',
+            'getDerivedStateFromProps',
+            'componentWillMount',
+            'UNSAFE_componentWillMount',
+            'componentDidMount',
+            'componentWillReceiveProps',
+            'UNSAFE_componentWillReceiveProps',
+            'shouldComponentUpdate',
+            'componentWillUpdate',
+            'UNSAFE_componentWillUpdate',
+            'getSnapshotBeforeUpdate',
+            'componentDidUpdate',
+            'componentDidCatch',
+            'componentWillUnmount',
+          ],
+        },
       },
-    }],
+    ],
+
+    // ## Fixes of Airbnb rules for our use cases
+
+    'react/no-unknown-property': ['error', { ignore: ['test-id'] }],
+    // Warn about unstable nested components, but allow them as props to other components
+    'react/no-unstable-nested-components': ['warn', { allowAsProps: true }],
+    // Don't care about placement of static properties in React components
+    'react/static-property-placement': 'off',
+    // Allow prop spreading
+    'react/jsx-props-no-spreading': 'off',
+    // Allow function components to be defined using arrow functions
+    'react/function-component-definition': 'off',
+    // Warn about usage of .bind() or array functions in JSX props
+    'react/jsx-no-bind': 'warn',
+
+    // ## TBD
+    'react/jsx-curly-newline': ['warn', 'consistent'],
+
+    // ## ESLint complain makes sense - revisit at the next refactoring
+
+    'react/state-in-constructor': 'warn',
+
+    // ## Autofixable - can be removed when ESLint update pull request is merged
+    'react/jsx-curly-brace-presence': 'warn',
+    'react/jsx-indent-props': 'warn',
+    'react/jsx-fragments': 'warn',
   },
 };