@voiceflow/eslint-config 7.1.0 → 7.2.0

package/package.json

@@ -1,86 +1,44 @@
 {
   "name": "@voiceflow/eslint-config",
-  "description": "ESLint config for voiceflow",
-  "version": "7.1.0",
-  "author": "Eric Hacke",
-  "bugs": {
-    "url": "https://github.com/voiceflow/eslint-config/issues"
+  "version": "7.2.0",
+  "main": "src/index.js",
+  "files": [
+    "src/*"
+  ],
+  "scripts": {
+    "lint": "yarn g:run-p -c lint:eslint lint:prettier",
+    "lint:eslint": "yarn g:eslint",
+    "lint:fix": "yarn g:run-p -c \"lint:eslint --fix\" \"lint:prettier --write\"",
+    "lint:prettier": "yarn g:prettier --check",
+    "test:dependencies": "yarn g:depcruise ."
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+  "prettier": "../prettier-config/src",
+  "eslintConfig": {
+    "extends": "./src"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "5.59.1",
-    "@typescript-eslint/parser": "5.59.1",
+    "@typescript-eslint/eslint-plugin": "7.6.0",
+    "@typescript-eslint/parser": "7.6.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "8.8.0",
-    "eslint-import-resolver-typescript": "3.5.5",
-    "eslint-plugin-compat": "4.1.4",
-    "eslint-plugin-cypress": "2.13.2",
-    "eslint-plugin-eslint-comments": "^3.1.1",
-    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-jsx-a11y": "6.7.1",
-    "eslint-plugin-lodash": "7.4.0",
-    "eslint-plugin-mocha": "10.1.0",
-    "eslint-plugin-no-secrets": "^0.8.9",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "4.2.1",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-import-resolver-typescript": "3.6.1",
+    "eslint-plugin-eslint-comments": "3.2.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-no-secrets": "0.8.9",
+    "eslint-plugin-prefer-arrow": "1.2.3",
+    "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-react": "7.32.2",
-    "eslint-plugin-react-hooks": "4.6.0",
-    "eslint-plugin-simple-import-sort": "10.0.0",
-    "eslint-plugin-sonarjs": "0.19.0",
-    "eslint-plugin-unicorn": "46.0.0",
-    "eslint-plugin-xss": "0.1.12",
-    "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0"
-  },
-  "devDependencies": {
-    "@voiceflow/commitlint-config": "2.1.0",
-    "@voiceflow/git-branch-check": "1.4.0",
-    "@voiceflow/prettier-config": "1.3.0",
-    "commitizen": "4.3.0",
-    "commitlint": "17.6.1",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "8.39.0",
-    "fixpack": "^4.0.0",
-    "husky": "8.0.3",
-    "lint-staged": "13.1.2",
-    "prettier": "2.8.8"
+    "eslint-plugin-simple-import-sort": "12.0.0",
+    "eslint-plugin-sonarjs": "0.25.1",
+    "eslint-plugin-unicorn": "52.0.0",
+    "eslint-plugin-you-dont-need-lodash-underscore": "6.14.0",
+    "globals": "15.0.0"
   },
-  "files": [
-    "*.js",
-    "config/*.js",
-    "overrides/*.js",
-    "!scratch.*"
-  ],
-  "homepage": "https://github.com/voiceflow/eslint-config#readme",
-  "keywords": [
-    "config",
-    "eslint",
-    "lint"
-  ],
-  "license": "MIT",
-  "main": "index.js",
-  "peerDependencies": {
-    "@voiceflow/prettier-config": "^1.0.2",
-    "eslint": "^8.0.0"
+  "engines": {
+    "node": "20"
   },
-  "prettier": "@voiceflow/prettier-config",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/voiceflow/eslint-config.git"
+  "volta": {
+    "extends": "../../package.json"
   },
-  "scripts": {
-    "commit": "git-cz",
-    "lint": "eslint \"./**/*.{js,ts}\"",
-    "lint:fix": "yarn lint --fix",
-    "lint:quiet": "yarn lint --quiet",
-    "lint:report": "yarn lint --format json -o sonar/report.json",
-    "prepare": "husky install",
-    "test": "yarn test:run",
-    "test:run": "echo \"Error: no test specified\" && exit 1"
-  }
+  "gitHead": "ca46718f7b4bbac9c11e5bc57047eb6181156e47"
 }

package/src/base.js

@@ -0,0 +1,13 @@
+const airbnb = require('./presets/airbnb');
+const common = require('./presets/common');
+const import_ = require('./presets/import');
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+module.exports = [
+  {
+    ignores: ['**/build/**', '**/node_modules/**', '**/sonar/**', '**/.yarn/**'],
+  },
+  ...airbnb,
+  ...common,
+  ...import_,
+];

package/src/index.js

@@ -0,0 +1,5 @@
+const base = require('./base');
+const typescript = require('./presets/typescript');
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+module.exports = [...base, typescript];

package/src/presets/airbnb.js

@@ -0,0 +1,10 @@
+const airbnbBestPractices = require('eslint-config-airbnb-base/rules/best-practices');
+const airbnbErrors = require('eslint-config-airbnb-base/rules/errors');
+const airbnbStyle = require('eslint-config-airbnb-base/rules/style');
+const airbnbVariables = require('eslint-config-airbnb-base/rules/variables');
+const airbnbStrict = require('eslint-config-airbnb-base/rules/strict');
+const { env: _nodeEnv, ...airbnbNode } = require('eslint-config-airbnb-base/rules/node');
+const { env: _es6Env, parserOptions: _es6Parser, ...airbnbES6 } = require('eslint-config-airbnb-base/rules/es6');
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+module.exports = [airbnbBestPractices, airbnbErrors, airbnbNode, airbnbStyle, airbnbVariables, airbnbES6, airbnbStrict];

package/src/presets/common.js

@@ -0,0 +1,105 @@
+const sonarjs = require('eslint-plugin-sonarjs');
+const promise = require('eslint-plugin-promise');
+const preferArrow = require('eslint-plugin-prefer-arrow');
+const noSecrets = require('eslint-plugin-no-secrets');
+const comments = require('eslint-plugin-eslint-comments');
+const youDontNeed = require('eslint-plugin-you-dont-need-lodash-underscore');
+const unicorn = require('eslint-plugin-unicorn');
+const prettier = require('eslint-plugin-prettier/recommended');
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+module.exports = [
+  {
+    plugins: {
+      sonarjs,
+      promise,
+      unicorn,
+      'eslint-comments': comments,
+      'you-dont-need-lodash-underscore': youDontNeed,
+      'prefer-arrow': preferArrow,
+      'no-secrets': noSecrets,
+    },
+  },
+  { ...sonarjs.configs.recommended, plugins: {} },
+  { ...promise.configs.recommended, plugins: {} },
+  { ...comments.configs.recommended, plugins: {} },
+  { ...youDontNeed.configs.compatible, plugins: {} },
+  prettier,
+  {
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+    },
+
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 2021,
+      },
+    },
+
+    rules: {
+      // error
+      'arrow-parens': ['error', 'always'],
+      'callback-return': 'error',
+      'capitalized-comments': 'error',
+      'handle-callback-err': 'error',
+      'max-depth': ['error', 3],
+      'max-len': [
+        'error',
+        {
+          code: 150,
+          ignoreUrls: true,
+          ignoreStrings: true,
+          ignoreTemplateLiterals: true,
+          ignoreRegExpLiterals: true,
+        },
+      ],
+      'max-nested-callbacks': ['error', 5],
+      'max-params': ['error', 5],
+      'no-console': 'error',
+      'no-process-exit': 'error',
+      'no-useless-call': 'error',
+      'quote-props': ['error', 'as-needed'],
+      'prefer-arrow-callback': 'error',
+      'lines-between-class-members': 'error',
+
+      'prefer-arrow/prefer-arrow-functions': [
+        'error',
+        {
+          disallowPrototype: false,
+          singleReturnOnly: true,
+          classPropertiesAllowed: false,
+        },
+      ],
+
+      'eslint-comments/no-unused-disable': 'error',
+      'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
+
+      'no-secrets/no-secrets': 'error',
+
+      'unicorn/better-regex': 'error',
+      'unicorn/prefer-set-has': 'error',
+
+      // warn
+      'sonarjs/no-duplicate-string': 'warn',
+
+      // off
+      'no-plusplus': 'off',
+      'no-continue': 'off',
+      'require-jsdoc': 'off', // not sure we want this
+      quotes: ['error', 'single', 'avoid-escape'],
+      'valid-jsdoc': 'off',
+      'func-names': 'off',
+      'class-methods-use-this': 'off',
+      camelcase: 'off',
+      'no-underscore-dangle': 'off',
+      'no-restricted-syntax': 'off',
+
+      // disabled until eslint 9 is supported
+      'sonarjs/no-gratuitous-expressions': 'off',
+      'sonarjs/no-extra-arguments': 'off',
+      'sonarjs/no-use-of-empty-return-value': 'off',
+      'sonarjs/no-empty-collection': 'off',
+      'sonarjs/no-unused-collection': 'off',
+    },
+  },
+];

package/src/presets/import.js

@@ -0,0 +1,50 @@
+const globals = require('globals');
+const import_ = require('eslint-plugin-import');
+const simpleImportSort = require('eslint-plugin-simple-import-sort');
+const {
+  env: _importsEnv,
+  parserOptions: _importsParser,
+  ...airbnbImports
+} = require('eslint-config-airbnb-base/rules/imports');
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+module.exports = [
+  {
+    plugins: {
+      import: import_,
+      'simple-import-sort': simpleImportSort,
+    },
+  },
+  { ...airbnbImports, plugins: {} },
+  {
+    languageOptions: {
+      parserOptions: {
+        sourceType: 'module',
+      },
+      globals: {
+        ...globals.es2021,
+      },
+    },
+
+    rules: {
+      // error
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+      'import/first': 'error',
+      'import/no-duplicates': 'error',
+
+      // off
+      'sort-imports': 'off',
+      'import/order': 'off',
+      'import/no-amd': 'off',
+      'import/no-named-as-default': 'off',
+      'import/newline-after-import': 'off',
+      'import/extensions': 'off',
+      'import/no-extraneous-dependencies': 'off',
+      'import/prefer-default-export': 'off',
+      'import/no-unresolved': 'off',
+      'import/no-self-import': 'off',
+      'import/no-mutable-exports': 'off',
+    },
+  },
+];

package/src/presets/typescript.js

@@ -0,0 +1,59 @@
+const typescript = require('@typescript-eslint/eslint-plugin');
+const typescriptParser = require('@typescript-eslint/parser');
+
+/** @type {import('eslint').Linter.FlatConfig} */
+module.exports = {
+  files: ['**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts'],
+
+  plugins: {
+    '@typescript-eslint': typescript,
+  },
+
+  languageOptions: {
+    parser: typescriptParser,
+  },
+
+  rules: {
+    ...typescript.configs.recommended.rules,
+
+    // error
+    '@typescript-eslint/no-empty-interface': [
+      'error',
+      {
+        // Allow `interface T extends U {}`
+        allowSingleExtends: true,
+      },
+    ],
+    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+    '@typescript-eslint/no-unused-vars': ['error', { varsIgnorePattern: '^_', argsIgnorePattern: '^_' }],
+    '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports' }],
+
+    // off
+    'no-shadow': 'off',
+    'no-unused-vars': 'off',
+    'no-use-before-define': 'off',
+    'no-useless-constructor': 'off',
+
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+
+    'import/no-unresolved': 'off',
+    'import/export': 'off',
+    'import/named': 'off',
+    'import/no-named-as-default-member': 'off',
+  },
+
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true,
+
+        project: 'tsconfig.json',
+      },
+    },
+  },
+};

package/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['.'],
-  rules: {
-    'no-secrets/no-secrets': 'off',
-  },
-};

package/.lintstagedrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  'package.json': ['fixpack'],
-  '**/*.{js,ts}': ['eslint --fix'],
-};

package/README.md

@@ -1,6 +0,0 @@
-# eslint-config
-
-## Install
-```bash
-npm i -S @voiceflow/eslint-config
-```

package/commitlint.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@voiceflow/commitlint-config'],
-};

package/config/base.js

@@ -1,73 +0,0 @@
-module.exports = {
-  extends: [
-    'airbnb-base', // include import rules
-    'plugin:sonarjs/recommended',
-    'plugin:promise/recommended',
-    'plugin:eslint-comments/recommended',
-    'plugin:you-dont-need-lodash-underscore/compatible',
-  ],
-  plugins: ['sonarjs', 'promise', 'prefer-arrow', 'no-secrets', 'you-dont-need-lodash-underscore', 'unicorn'],
-  parserOptions: {
-    ecmaVersion: 9,
-  },
-  // https://eslint.org/docs/user-guide/configuring/rules#report-unused-eslint-disable-comments
-  reportUnusedDisableDirectives: true,
-  rules: {
-    // error
-    'arrow-parens': ['error', 'always'],
-    'callback-return': 'error',
-    'capitalized-comments': 'error',
-    'handle-callback-err': 'error',
-    'max-depth': ['error', 3],
-    'max-len': [
-      'error',
-      {
-        code: 150,
-        ignoreUrls: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-        ignoreRegExpLiterals: true,
-      },
-    ],
-    'max-nested-callbacks': ['error', 5],
-    'max-params': ['error', 5],
-    'no-console': 'error',
-    'no-process-exit': 'error',
-    'no-useless-call': 'error',
-    'quote-props': ['error', 'as-needed'],
-    'prefer-arrow-callback': 'error',
-    'lines-between-class-members': 'error',
-
-    'prefer-arrow/prefer-arrow-functions': [
-      'error',
-      {
-        disallowPrototype: false,
-        singleReturnOnly: true,
-        classPropertiesAllowed: false,
-      },
-    ],
-
-    'eslint-comments/no-unused-disable': 'error',
-    'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
-
-    'no-secrets/no-secrets': 'error',
-
-    'unicorn/better-regex': 'error',
-    'unicorn/prefer-set-has': 'error',
-
-    // warn
-    'sonarjs/no-duplicate-string': 'warn',
-
-    // off
-    'no-plusplus': 'off',
-    'no-continue': 'off',
-    'require-jsdoc': 'off', // not sure we want this
-    quotes: ['error', 'single', 'avoid-escape'],
-    'valid-jsdoc': 'off',
-    'func-names': 'off',
-    'class-methods-use-this': 'off',
-    'import/prefer-default-export': 'off',
-    camelcase: 'off',
-    'no-underscore-dangle': 'off',
-  },
-};

package/config/import.js

@@ -1,27 +0,0 @@
-module.exports = {
-  plugins: ['simple-import-sort', 'import'],
-  parserOptions: {
-    sourceType: 'module',
-  },
-  env: {
-    es6: true,
-  },
-  rules: {
-    // error
-    'simple-import-sort/imports': 'error',
-    'simple-import-sort/exports': 'error',
-
-    'import/extensions': ['error', 'ignorePackages', { js: 'never', ts: 'never', jsx: 'never', tsx: 'never' }],
-    'import/first': 'error',
-    'import/newline-after-import': 'error',
-    'import/no-duplicates': 'error',
-
-    // off
-    'sort-imports': 'off',
-    'import/order': 'off',
-    'import/no-named-as-default': 'off',
-  },
-  settings: {
-    'import/extensions': ['.js', '.ts', '.jsx', '.tsx'],
-  },
-};

package/config/prettier.js

@@ -1,4 +0,0 @@
-module.exports = {
-  extends: ['plugin:prettier/recommended'],
-  plugins: ['prettier'],
-};

package/config/react.js

@@ -1,41 +0,0 @@
-module.exports = {
-  extends: ['plugin:react/recommended', 'plugin:jsx-a11y/recommended'],
-  plugins: ['react', 'react-hooks', 'jsx-a11y'],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-  rules: {
-    // error
-    'react/jsx-fragments': 'error',
-
-    'react-hooks/rules-of-hooks': 'error',
-
-    // warn
-    'react/jsx-curly-brace-presence': 'warn',
-    'react/jsx-filename-extension': ['warn', { extensions: ['.jsx', '.tsx'] }],
-
-    'jsx-a11y/click-events-have-key-events': 'warn',
-    'jsx-a11y/label-has-for': 'warn',
-    'jsx-a11y/label-has-associated-control': 'warn',
-    'jsx-a11y/no-static-element-interactions': 'warn',
-
-    // off
-    'react/destructuring-assignment': 'off',
-    'react/no-unescaped-entities': 'off',
-    'react/prop-types': 'off',
-
-    // high performance overhead & low value
-    'react/display-name': 'off',
-    'react/no-string-refs': 'off',
-    'react/require-render-return': 'off',
-    'react/no-direct-mutation-state': 'off',
-    'react/no-deprecated': 'off',
-  },
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-};

package/cypress.js

@@ -1,10 +0,0 @@
-module.exports = {
-  extends: ['plugin:cypress/recommended'],
-  plugins: ['cypress'],
-  rules: {
-    'promise/catch-or-return': 'off',
-  },
-  env: {
-    'cypress/globals': true,
-  },
-};

package/frontend.js

@@ -1,17 +0,0 @@
-module.exports = {
-  extends: ['./config/react.js'],
-  plugins: ['xss', 'lodash'],
-  env: {
-    browser: true,
-  },
-  rules: {
-    // error
-    'xss/no-mixed-html': 'error',
-    'xss/no-location-href-assign': 'error',
-
-    'lodash/import-scope': 'error',
-  },
-  settings: {
-    polyfills: ['Number.isNaN', 'Promise', 'Array.from', 'Object.assign', 'Object.values', 'Set'],
-  },
-};

package/index.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['./config/base.js', './config/import.js', './config/prettier.js'],
-};

package/jest.js

@@ -1,7 +0,0 @@
-module.exports = {
-  extends: ['plugin:jest/recommended'],
-  plugins: ['jest'],
-  env: {
-    'jest/globals': true,
-  },
-};

package/mocha.js

@@ -1,16 +0,0 @@
-module.exports = {
-  plugins: ['mocha'],
-  env: {
-    mocha: true,
-  },
-  rules: {
-    'mocha/handle-done-callback': 'error',
-    'mocha/no-exclusive-tests': 'error',
-    'mocha/no-global-tests': 'error',
-    'mocha/no-identical-title': 'error',
-    'mocha/no-nested-tests': 'error',
-    'mocha/no-pending-tests': 'error',
-    'mocha/no-return-and-callback': 'error',
-    'mocha/no-sibling-hooks': 'error',
-  },
-};

package/overrides/monorepo.js

@@ -1,19 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-module.exports = (rootDir = process.cwd(), workspace = 'packages') => {
-  const packagesDir = path.join(rootDir, workspace);
-  const packages = fs.readdirSync(packagesDir);
-
-  return packages.map((pkg) => ({
-    files: [`${workspace}/${pkg}/**/*`],
-    extends: ['@voiceflow/eslint-config/typescript'],
-    settings: {
-      'import/resolver': {
-        typescript: {
-          project: path.join(packagesDir, pkg, 'tsconfig.json'),
-        },
-      },
-    },
-  }));
-};

package/typescript.js

@@ -1,47 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  overrides: [
-    {
-      files: ['*.ts', '*.tsx'],
-      extends: ['plugin:@typescript-eslint/recommended'],
-      rules: {
-        // error
-        '@typescript-eslint/no-empty-interface': [
-          'error',
-          {
-            // Allow `interface T extends U {}`
-            allowSingleExtends: true,
-          },
-        ],
-        '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
-
-        // off
-        'no-shadow': 'off',
-        'no-unused-vars': 'off',
-        'no-use-before-define': 'off',
-        'no-useless-constructor': 'off',
-
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/no-non-null-assertion': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-
-        'import/no-unresolved': 'off',
-        'import/export': 'off',
-        'import/named': 'off',
-      },
-    },
-  ],
-  settings: {
-    'import/parsers': {
-      '@typescript-eslint/parser': ['.ts', '.tsx'],
-    },
-    'import/resolver': {
-      typescript: {
-        alwaysTryTypes: true,
-
-        project: 'tsconfig.json',
-      },
-    },
-  },
-};

package/utility.js

@@ -1,13 +0,0 @@
-module.exports = {
-  rules: {
-    // error
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: true,
-      },
-    ],
-
-    '@typescript-eslint/no-var-requires': 'off',
-  },
-};