@gitlab/eslint-plugin 21.5.0 → 22.0.0

package/lib/flat-configs/base.js

@@ -0,0 +1,122 @@
+const globals = require('globals');
+const unicornPlugin = require('eslint-plugin-unicorn');
+const promisePlugin = require('eslint-plugin-promise');
+const importPlugin = require('eslint-plugin-import');
+
+const confusingBrowserGlobals = require('../confusing-browser-globals');
+const gitlabPlugin = require('../plugin.js');
+const prettierRules = require('../prettier-rules');
+
+const bestPractices = require('../configs/base/best-practices');
+const errors = require('../configs/base/errors');
+const node = require('../configs/base/node');
+const style = require('../configs/base/style');
+const variables = require('../configs/base/variables');
+const es6 = require('../configs/base/es6');
+const imports = require('../configs/base/imports');
+const strict = require('../configs/base/strict');
+
+/*
+  Rules related to the GitLab JavaScript style guide.
+  Vue-specific rules live in lib/flat-configs/vue.js
+*/
+module.exports = [
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.es2020,
+        ...globals.es2015,
+        ...globals.node,
+      },
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+    plugins: {
+      unicorn: unicornPlugin,
+      promise: promisePlugin,
+      import: importPlugin,
+      '@gitlab': gitlabPlugin,
+    },
+    settings: imports.settings,
+  },
+  /*
+    One config object per rule set, not one merged `rules` block: a
+    severity-only override later in the array (`'no-restricted-syntax': 'off'`)
+    keeps the options it inherits from an earlier object. Merging these would
+    strip the inherited options from 56 rules at unchanged severity.
+  */
+  { rules: bestPractices.rules },
+  { rules: errors.rules },
+  { rules: node.rules },
+  { rules: style.rules },
+  { rules: variables.rules },
+  { rules: es6.rules },
+  { rules: imports.rules },
+  { rules: strict.rules },
+  { rules: promisePlugin.configs['flat/recommended'].rules },
+  { rules: prettierRules },
+  {
+    rules: {
+      camelcase: ['error', { properties: 'never', ignoreDestructuring: true }],
+      'default-param-last': 'off',
+      'arrow-body-style': 'off',
+      'unicorn/filename-case': ['error', { case: 'snakeCase' }],
+      'unicorn/no-array-callback-reference': 'error',
+      'import/prefer-default-export': 'off',
+      'import/no-default-export': 'error',
+      'import/no-deprecated': 'error',
+      'import/no-dynamic-require': ['error', { esmodule: true }],
+      'no-implicit-coercion': ['error', { boolean: true, number: true, string: true }],
+      'no-param-reassign': [
+        'error',
+        {
+          props: true,
+          ignorePropertyModificationsFor: ['acc', 'accumulator', 'el', 'element', 'state'],
+        },
+      ],
+      'no-restricted-exports': [
+        'error',
+        {
+          restrictedNamedExports: [
+            'then', // avoid confusion when used with dynamic `import()` promise
+          ],
+        },
+      ],
+      'no-restricted-syntax': 'off',
+      'no-sequences': ['error', { allowInParentheses: false }],
+      'promise/catch-or-return': ['error', { allowFinally: true }],
+      'no-restricted-globals': [
+        'error',
+        {
+          name: 'isFinite',
+          message:
+            'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+        },
+        {
+          name: 'isNaN',
+          message:
+            'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+        },
+        {
+          name: 'escape',
+          message:
+            "The global `escape` function is unsafe. Did you mean to use `encodeURI`, `encodeURIComponent` or lodash's `escape` instead?",
+        },
+        {
+          name: 'unescape',
+          message:
+            "The global `unescape` function is unsafe. Did you mean to use `decodeURI`, `decodeURIComponent` or lodash's `unescape` instead?",
+        },
+      ].concat(confusingBrowserGlobals),
+      'import/order': [
+        'error',
+        {
+          groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+        },
+      ],
+      // https://docs.gitlab.com/ee/development/fe_guide/style/javascript.html#limit-number-of-parameters
+      'max-params': ['error', { max: 3 }],
+    },
+  },
+];

package/lib/flat-configs/default.js

@@ -0,0 +1,13 @@
+const base = require('./base');
+const { presetAndSetup, gitlabRules } = require('../vue-fragments');
+
+/*
+  The GitLab JavaScript and Vue rules combined. This is the config most
+  consumers want.
+
+  Not `[...base, ...vue]`. base already contributes eslint-config-prettier, and
+  it lands *before* the vue preset here, where lib/flat-configs/vue.js puts it
+  after -- so six vue formatting rules stay at the preset's `warn` in this
+  config and are `off` in vue. That asymmetry is inherited, not a bug.
+*/
+module.exports = [...base, ...presetAndSetup, ...gitlabRules];

package/lib/flat-configs/i18n.js

@@ -0,0 +1,14 @@
+const gitlabPlugin = require('../plugin.js');
+
+module.exports = [
+  {
+    plugins: { '@gitlab': gitlabPlugin },
+    rules: {
+      '@gitlab/require-i18n-strings': 'error',
+      '@gitlab/vue-require-i18n-attribute-strings': 'error',
+      '@gitlab/vue-require-i18n-strings': 'error',
+      '@gitlab/require-valid-i18n-helpers': 'error',
+      '@gitlab/vue-require-valid-i18n-helpers': 'error',
+    },
+  },
+];

package/lib/flat-configs/jest.js

@@ -0,0 +1,20 @@
+const jestPlugin = require('eslint-plugin-jest');
+
+module.exports = [
+  jestPlugin.configs['flat/recommended'],
+  {
+    rules: {
+      'jest/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
+      'jest/no-conditional-expect': 'off',
+      'jest/valid-title': ['error', { ignoreTypeOfDescribeName: true }],
+      'jest/no-restricted-matchers': [
+        'error',
+        {
+          toBeFalsy: 'Prefer a stronger matcher like `toBe(false)`',
+          toBeTruthy: 'Prefer a stronger matcher like `toBe(true)`',
+        },
+      ],
+      'jest/prefer-to-have-length': 'error',
+    },
+  },
+];

package/lib/flat-configs/tailwind.js

@@ -0,0 +1,19 @@
+const tailwindPlugin = require('eslint-plugin-tailwindcss');
+
+const gitlabPlugin = require('../plugin.js');
+
+module.exports = [
+  {
+    plugins: {
+      '@gitlab': gitlabPlugin,
+      tailwindcss: tailwindPlugin,
+    },
+    rules: {
+      '@gitlab/tailwind-no-interpolation': 'error',
+      '@gitlab/vue-tailwind-no-interpolation': 'error',
+      '@gitlab/tailwind-no-max-width-media-queries': 'error',
+      '@gitlab/vue-tailwind-no-max-width-media-queries': 'error',
+      'tailwindcss/no-arbitrary-value': 'error',
+    },
+  },
+];

package/{eslint9/configs → lib/flat-configs}/typescript.js

@@ -1,98 +1,83 @@
-const baseConfig = require('./base');
-const tsEslint = require('@typescript-eslint/eslint-plugin');
+const js = require('@eslint/js');
+const tsPlugin = require('@typescript-eslint/eslint-plugin');
 const tsParser = require('@typescript-eslint/parser');
+const importPlugin = require('eslint-plugin-import');
 const globals = require('globals');
 
-const tsConfig = [
+const base = require('./base');
+
+/*
+  Rules related to the GitLab TypeScript style guide.
+  Base JavaScript rules live in lib/flat-configs/base.js
+
+  Two things here are load-bearing:
+
+  1. base is spread first and the `.ts` layer second, so eslint:recommended and
+     the TypeScript preset win over eslint-config-prettier inside .ts files,
+     as eslintrc's `overrides` did. Putting prettier last would not.
+
+  2. `flat/eslint-recommended` is spread alongside `strict`, because eslintrc's
+     `plugin:@typescript-eslint/strict` extended it. Without it, 19 core rules
+     that a TypeScript-aware replacement or the compiler already covers stay
+     enabled.
+*/
+const tsEslintRecommended = tsPlugin.configs['flat/eslint-recommended'];
+const tsStrict = tsPlugin.configs.strict;
+const importTypescript = importPlugin.flatConfigs.typescript;
+
+module.exports = [
+  ...base,
   {
+    name: '@gitlab/typescript/setup',
     languageOptions: {
       globals: {
-        ...baseConfig.languageOptions.globals,
         ...globals.mocha,
         ...globals.jest,
       },
-      ecmaVersion: baseConfig.languageOptions.ecmaVersion,
-      sourceType: baseConfig.languageOptions.sourceType,
-      parserOptions: baseConfig.languageOptions.parserOptions || {},
-    },
-    plugins: {
-      ...baseConfig.plugins,
-    },
-    settings: {
-      ...baseConfig.settings,
     },
     rules: {
-      ...baseConfig.rules,
+      'import/extensions': [
+        'error',
+        'ignorePackages',
+        { js: 'never', jsx: 'never', ts: 'never', tsx: 'never' },
+      ],
     },
   },
-  // TypeScript-specific config
   {
-    files: ['**/*.ts', '**/*.tsx'],
+    name: '@gitlab/typescript/ts',
+    files: ['**/*.ts'],
     languageOptions: {
       parser: tsParser,
       parserOptions: {
         project: ['./tsconfig.json'],
-        tsconfigRootDir: process.cwd(),
       },
     },
     plugins: {
-      '@typescript-eslint': tsEslint,
+      '@typescript-eslint': tsPlugin,
+      import: importPlugin,
     },
-    settings: {
-      'import/resolver': {
-        node: {
-          extensions: ['.mjs', '.js', '.json', '.node', '.ts', '.tsx'],
-        },
-      },
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
     },
+    settings: importTypescript.settings,
     rules: {
-      'import/extensions': [
-        'error',
-        'ignorePackages',
-        {
-          js: 'never',
-          jsx: 'never',
-          ts: 'never',
-          tsx: 'never',
-        },
-      ],
+      ...js.configs.recommended.rules,
+      ...tsEslintRecommended.rules,
+      ...tsStrict.rules,
+      ...importTypescript.rules,
       semi: [2, 'always'],
       'max-params': 'off',
       'no-throw-literal': 'off',
       'no-shadow': 'off',
       'no-empty-function': 'off',
       'no-plusplus': 'off',
-      'no-unused-vars': 'off',
-      'no-await-in-loop': 'error',
       'unicorn/no-array-callback-reference': 'off',
-      'generator-star-spacing': 'off',
-      'max-len': 'off',
-      'no-console': 'warn',
-      'indent': 'off',
-      'quotes': 'off',
-      'implicit-arrow-linebreak': 'off',
-      'function-paren-newline': 'off',
-      'no-redeclare': 'off',
-      'brace-style': 'off',
-      'no-undef': 'off',
-      'no-tabs': 'off',
-      'operator-linebreak': 'off',
-      'no-confusing-arrow': 'off',
-      'object-curly-newline': 'off',
       '@typescript-eslint/only-throw-error': 'error',
       '@typescript-eslint/no-unused-vars': 'error',
       '@typescript-eslint/no-shadow': 'error',
       '@typescript-eslint/return-await': 'error',
       '@typescript-eslint/no-floating-promises': 'error',
-      '@typescript-eslint/no-explicit-any': 'error',
-      '@typescript-eslint/no-non-null-assertion': 'error',
-      '@typescript-eslint/no-var-requires': 'error',
-      '@typescript-eslint/explicit-member-accessibility': [
-        'error',
-        {
-          accessibility: 'no-public',
-        },
-      ],
+      '@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
       'class-methods-use-this': 'off',
       'import/no-cycle': 'error',
       'promise/param-names': 'off',
@@ -121,8 +106,10 @@ const tsConfig = [
       ],
     },
   },
-  // Test files config
   {
+    // Recursive: eslintrc matched a bare `*.test.ts` at any depth, flat globs
+    // are path-relative.
+    name: '@gitlab/typescript/tests',
     files: ['**/*.test.ts', '**/*.test.js'],
     rules: {
       'max-classes-per-file': 'off',
@@ -130,5 +117,3 @@ const tsConfig = [
     },
   },
 ];
-
-module.exports = tsConfig;

package/lib/flat-configs/vue.js

@@ -0,0 +1,16 @@
+const prettierRules = require('../prettier-rules');
+const { presetAndSetup, gitlabRules } = require('../vue-fragments');
+
+/*
+  Rules related to the GitLab Vue style guide.
+  Base JavaScript rules live in lib/flat-configs/base.js
+
+  eslint-config-prettier sits between the preset and this package's rules,
+  switching the preset's formatting rules off. lib/flat-configs/default.js
+  orders it the other way -- see the note there.
+*/
+module.exports = [
+  ...presetAndSetup,
+  { name: '@gitlab/vue/prettier', rules: prettierRules },
+  ...gitlabRules,
+];

package/lib/index.js

@@ -1,46 +1,37 @@
 /**
  * This file is GENERATED, please run `yarn update` after adding or renaming a rule
  */
+const plugin = require('./plugin.js');
+
+/*
+  Getters, so requiring the plugin never loads a config the consumer is not
+  using: `typescript` pulls in optional peer dependencies, and eagerly
+  requiring it would throw for anyone without the TypeScript toolchain. Getters
+  in an object literal are enumerable, so `Object.keys(configs)` is unaffected.
+*/
 module.exports = {
-  rules: {
-    'no-global-event-off': require('./rules/no-global-event-off.js'),
-    'no-hardcoded-urls': require('./rules/no-hardcoded-urls.js'),
-    'no-runtime-template-compiler': require('./rules/no-runtime-template-compiler.js'),
-    'require-i18n-strings': require('./rules/require-i18n-strings.js'),
-    'require-valid-i18n-helpers': require('./rules/require-valid-i18n-helpers.js'),
-    'tailwind-no-interpolation': require('./rules/tailwind-no-interpolation.js'),
-    'tailwind-no-max-width-media-queries': require('./rules/tailwind-no-max-width-media-queries.js'),
-    'vtu-no-explicit-wrapper-destroy': require('./rules/vtu-no-explicit-wrapper-destroy.js'),
-    'vtu-no-wrapper-vm': require('./rules/vtu-no-wrapper-vm.js'),
-    'vue-no-data-toggle': require('./rules/vue-no-data-toggle.js'),
-    'vue-no-hardcoded-urls': require('./rules/vue-no-hardcoded-urls.js'),
-    'vue-no-new-non-primitive-in-template': require('./rules/vue-no-new-non-primitive-in-template.js'),
-    'vue-no-popover-target-dollar-el': require('./rules/vue-no-popover-target-dollar-el.js'),
-    'vue-no-undef-apollo-properties': require('./rules/vue-no-undef-apollo-properties.js'),
-    'vue-prefer-dollar-scopedslots': require('./rules/vue-prefer-dollar-scopedslots.js'),
-    'vue-require-i18n-attribute-strings': require('./rules/vue-require-i18n-attribute-strings.js'),
-    'vue-require-i18n-strings': require('./rules/vue-require-i18n-strings.js'),
-    'vue-require-required-key': require('./rules/vue-require-required-key.js'),
-    'vue-require-valid-i18n-helpers': require('./rules/vue-require-valid-i18n-helpers.js'),
-    'vue-slot-name-casing': require('./rules/vue-slot-name-casing.js'),
-    'vue-tailwind-no-interpolation': require('./rules/vue-tailwind-no-interpolation.js'),
-    'vue-tailwind-no-max-width-media-queries': require('./rules/vue-tailwind-no-max-width-media-queries.js'),
-  },
+  ...plugin,
   configs: {
-    base: require('./configs/base.js'),
-    'best-practices': require('./configs/base/best-practices.js'),
-    errors: require('./configs/base/errors.js'),
-    es6: require('./configs/base/es6.js'),
-    imports: require('./configs/base/imports.js'),
-    node: require('./configs/base/node.js'),
-    strict: require('./configs/base/strict.js'),
-    style: require('./configs/base/style.js'),
-    variables: require('./configs/base/variables.js'),
-    default: require('./configs/default.js'),
-    i18n: require('./configs/i18n.js'),
-    jest: require('./configs/jest.js'),
-    tailwind: require('./configs/tailwind.js'),
-    typescript: require('./configs/typescript.js'),
-    vue: require('./configs/vue.js'),
+    get base() {
+      return require('./flat-configs/base.js');
+    },
+    get default() {
+      return require('./flat-configs/default.js');
+    },
+    get i18n() {
+      return require('./flat-configs/i18n.js');
+    },
+    get jest() {
+      return require('./flat-configs/jest.js');
+    },
+    get tailwind() {
+      return require('./flat-configs/tailwind.js');
+    },
+    get typescript() {
+      return require('./flat-configs/typescript.js');
+    },
+    get vue() {
+      return require('./flat-configs/vue.js');
+    },
   },
 };

package/lib/plugin.js

@@ -0,0 +1,32 @@
+/**
+ * This file is GENERATED, please run `yarn update` after adding or renaming a rule
+ */
+const { name, version } = require('../package.json');
+
+module.exports = {
+  meta: { name, version },
+  rules: {
+    'no-global-event-off': require('./rules/no-global-event-off.js'),
+    'no-hardcoded-urls': require('./rules/no-hardcoded-urls.js'),
+    'no-runtime-template-compiler': require('./rules/no-runtime-template-compiler.js'),
+    'require-i18n-strings': require('./rules/require-i18n-strings.js'),
+    'require-valid-i18n-helpers': require('./rules/require-valid-i18n-helpers.js'),
+    'tailwind-no-interpolation': require('./rules/tailwind-no-interpolation.js'),
+    'tailwind-no-max-width-media-queries': require('./rules/tailwind-no-max-width-media-queries.js'),
+    'vtu-no-explicit-wrapper-destroy': require('./rules/vtu-no-explicit-wrapper-destroy.js'),
+    'vtu-no-wrapper-vm': require('./rules/vtu-no-wrapper-vm.js'),
+    'vue-no-data-toggle': require('./rules/vue-no-data-toggle.js'),
+    'vue-no-hardcoded-urls': require('./rules/vue-no-hardcoded-urls.js'),
+    'vue-no-new-non-primitive-in-template': require('./rules/vue-no-new-non-primitive-in-template.js'),
+    'vue-no-popover-target-dollar-el': require('./rules/vue-no-popover-target-dollar-el.js'),
+    'vue-no-undef-apollo-properties': require('./rules/vue-no-undef-apollo-properties.js'),
+    'vue-prefer-dollar-scopedslots': require('./rules/vue-prefer-dollar-scopedslots.js'),
+    'vue-require-i18n-attribute-strings': require('./rules/vue-require-i18n-attribute-strings.js'),
+    'vue-require-i18n-strings': require('./rules/vue-require-i18n-strings.js'),
+    'vue-require-required-key': require('./rules/vue-require-required-key.js'),
+    'vue-require-valid-i18n-helpers': require('./rules/vue-require-valid-i18n-helpers.js'),
+    'vue-slot-name-casing': require('./rules/vue-slot-name-casing.js'),
+    'vue-tailwind-no-interpolation': require('./rules/vue-tailwind-no-interpolation.js'),
+    'vue-tailwind-no-max-width-media-queries': require('./rules/vue-tailwind-no-max-width-media-queries.js'),
+  },
+};

package/lib/prettier-rules.js

@@ -0,0 +1,10 @@
+const prettierConfig = require('eslint-config-prettier');
+
+/*
+  eslint-config-prettier v10 also turns off `@stylistic/*` rules. This package
+  does not register that plugin, so those 180 entries are dropped. Consumers
+  using `@stylistic` should apply eslint-config-prettier themselves.
+*/
+module.exports = Object.fromEntries(
+  Object.entries(prettierConfig.rules).filter(([rule]) => !rule.startsWith('@stylistic/')),
+);

package/lib/rules/no-runtime-template-compiler.js

@@ -2,7 +2,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 const { DOCS_BASE_URL } = require('../constants');
-const utils = require('eslint-plugin-vue/lib/utils');
+const utils = require('eslint-plugin-vue/dist/utils').default;
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -30,7 +30,10 @@ module.exports = {
 
     return {
       ...utils.executeOnVue(context, (node, type) => {
-        if (type === 'definition' && utils.getVueComponentDefinitionType(node) === 'mixin') {
+        if (
+          type === 'definition' &&
+          utils.getVueComponentDefinitionType(context, node) === 'mixin'
+        ) {
           return;
         }
 

package/lib/rules/vue-no-new-non-primitive-in-template.js

@@ -1,7 +1,7 @@
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-const utils = require('eslint-plugin-vue/lib/utils');
+const utils = require('eslint-plugin-vue/dist/utils').default;
 const { pickBy, identity } = require('lodash');
 const { DOCS_BASE_URL } = require('../constants');
 const { closest, NODE_TYPES } = require('../utils/rule-utils');

package/lib/rules/vue-no-undef-apollo-properties.js

@@ -2,7 +2,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 const { DOCS_BASE_URL } = require('../constants');
-const utils = require('eslint-plugin-vue/lib/utils');
+const utils = require('eslint-plugin-vue/dist/utils').default;
 
 // ------------------------------------------------------------------------------
 //   Helpers

package/lib/rules/vue-prefer-dollar-scopedslots.js

@@ -4,7 +4,7 @@
 
 const { DOCS_BASE_URL } = require('../constants');
 const { defineTemplateBodyVisitor } = require('../utils/index');
-const utils = require('eslint-plugin-vue/lib/utils');
+const utils = require('eslint-plugin-vue/dist/utils').default;
 
 // ------------------------------------------------------------------------------
 //   Helpers

package/lib/rules/vue-require-required-key.js

@@ -13,7 +13,7 @@ const NATIVE_TYPES = new Set([
   'Symbol',
 ]);
 
-const utils = require('eslint-plugin-vue/lib/utils');
+const utils = require('eslint-plugin-vue/dist/utils').default;
 
 module.exports = {
   meta: {

package/lib/rules/vue-slot-name-casing.js

@@ -4,8 +4,8 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const utils = require('eslint-plugin-vue/lib/utils');
-const casing = require('eslint-plugin-vue/lib/utils/casing');
+const utils = require('eslint-plugin-vue/dist/utils').default;
+const casing = require('eslint-plugin-vue/dist/utils/casing');
 const { DOCS_BASE_URL } = require('../constants');
 
 // ------------------------------------------------------------------------------