@gitlab/eslint-plugin 21.4.1 → 22.0.0

package/eslint9/configs/base.js

@@ -1,140 +0,0 @@
-const confusingBrowserGlobals = require('confusing-browser-globals');
-const globals = require('globals');
-const unicornPlugin = require('eslint-plugin-unicorn');
-const promisePlugin = require('eslint-plugin-promise');
-const importPlugin = require('eslint-plugin-import');
-
-// Import all the base configurations
-const bestPracticesConfig = require('../../lib/configs/base/best-practices');
-const errorsConfig = require('../../lib/configs/base/errors');
-const nodeConfig = require('../../lib/configs/base/node');
-const styleConfig = require('../../lib/configs/base/style');
-const variablesConfig = require('../../lib/configs/base/variables');
-const es6Config = require('../../lib/configs/base/es6');
-const importsConfig = require('../../lib/configs/base/imports');
-const strictConfig = require('../../lib/configs/base/strict');
-
-/*
-  This plugin contains rules related to GitLab JavaScript style guide
-  Vue specific rules are in lib/configs/vue.js
-*/
-module.exports = {
-  languageOptions: {
-    globals: {
-      ...globals.browser,
-      ...globals.es2020,
-      ...globals.node,
-      ...globals.es6,
-    },
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    parserOptions: {
-      parser: 'espree',
-    },
-  },
-  plugins: {
-    unicorn: unicornPlugin,
-    promise: promisePlugin,
-    import: importPlugin,
-  },
-  settings: {
-    // Merge import settings from imports config
-    ...importsConfig.settings,
-  },
-  rules: {
-    ...promisePlugin.configs['flat/recommended'].rules,
-    // Merge all rules from the base configurations
-    ...bestPracticesConfig.rules,
-    ...errorsConfig.rules,
-    ...nodeConfig.rules,
-    ...styleConfig.rules,
-    ...variablesConfig.rules,
-    ...es6Config.rules,
-    ...importsConfig.rules,
-    ...strictConfig.rules,
-    // Override specific rules from base configs
-    // Promise rule customizations
-    'promise/catch-or-return': [
-      'error',
-      {
-        allowFinally: true,
-      },
-    ],
-    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,
-      },
-    ],
-    '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/configs/base.js

@@ -1,115 +0,0 @@
-const confusingBrowserGlobals = require('confusing-browser-globals');
-
-/*
-  This plugin contains rules related to GitLab JavaScript style guide
-  Vue specific rules are in lib/configs/vue.js
-*/
-module.exports = {
-  env: {
-    browser: true,
-    es2020: true,
-  },
-  extends: [
-    ...[
-      './base/best-practices.js',
-      './base/errors',
-      './base/node',
-      './base/style',
-      './base/variables',
-      './base/es6',
-      './base/imports',
-      './base/strict',
-    ].map((f) => require.resolve(f)),
-    'prettier',
-    'plugin:promise/recommended',
-  ],
-  parserOptions: {
-    parser: 'espree',
-    ecmaVersion: 'latest',
-  },
-  plugins: ['unicorn', 'promise', 'import', '@gitlab'],
-  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/configs/default.js

@@ -1,17 +0,0 @@
-const baseConfig = require('./base');
-const vueConfig = require('./vue');
-
-module.exports = {
-  ...baseConfig,
-  extends: [
-    ...baseConfig.extends,
-    'prettier',
-    'plugin:promise/recommended',
-    'plugin:vue/recommended',
-  ],
-  rules: {
-    ...baseConfig.rules,
-    ...vueConfig.rules,
-  },
-  overrides: vueConfig.overrides,
-};

package/lib/configs/i18n.js

@@ -1,10 +0,0 @@
-module.exports = {
-  plugins: ['@gitlab'],
-  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/configs/jest.js

@@ -1,21 +0,0 @@
-module.exports = {
-  extends: ['plugin:jest/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/configs/tailwind.js

@@ -1,10 +0,0 @@
-module.exports = {
-  plugins: ['@gitlab', 'tailwindcss'],
-  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/lib/configs/typescript.js

@@ -1,95 +0,0 @@
-const baseConfig = require('./base');
-
-const tsConfig = {
-  env: {
-    mocha: true,
-    jest: true,
-  },
-  parserOptions: baseConfig.parserOptions,
-  extends: [...baseConfig.extends],
-  plugins: [...baseConfig.plugins],
-  rules: {
-    ...baseConfig.rules,
-    'import/extensions': [
-      'error',
-      'ignorePackages',
-      {
-        js: 'never',
-        jsx: 'never',
-        ts: 'never',
-        tsx: 'never',
-      },
-    ],
-  },
-  overrides: [
-    {
-      files: ['**/*.ts'],
-      parserOptions: {
-        parser: '@typescript-eslint/parser',
-        project: ['./tsconfig.json'],
-      },
-      plugins: ['@typescript-eslint', 'import'],
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/strict',
-        'plugin:import/typescript',
-      ],
-      reportUnusedDisableDirectives: true,
-      rules: {
-        semi: [2, 'always'],
-        'max-params': 'off',
-        'no-throw-literal': 'off',
-        'no-shadow': 'off',
-        'no-empty-function': 'off',
-        'no-plusplus': 'off',
-        'unicorn/no-array-callback-reference': 'off',
-        '@typescript-eslint/no-throw-literal': '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/explicit-member-accessibility': [
-          'error',
-          {
-            accessibility: 'no-public',
-          },
-        ],
-        'class-methods-use-this': 'off',
-        'import/no-cycle': 'error',
-        'promise/param-names': 'off',
-        'no-use-before-define': ['warn', 'nofunc'],
-        'no-restricted-syntax': [
-          'error',
-          {
-            selector: ':matches(PropertyDefinition, MethodDefinition)[accessibility="private"]',
-            message: 'Use # prefix instead of `private` to indicate private class members.',
-          },
-          {
-            selector: 'ForInStatement',
-            message:
-              'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
-          },
-          {
-            selector: 'LabeledStatement',
-            message:
-              'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
-          },
-          {
-            selector: 'WithStatement',
-            message:
-              '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',
-          },
-        ],
-      },
-    },
-    {
-      files: ['*.test.ts', '*.test.js'],
-      rules: {
-        'max-classes-per-file': 'off',
-        '@typescript-eslint/no-non-null-assertion': 'off',
-      },
-    },
-  ],
-};
-
-module.exports = tsConfig;

package/lib/configs/vue.js

@@ -1,90 +0,0 @@
-/*
-  This plugin contains rules related to GitLab Vue style guide
-  base JavaScript rules are in lib/configs/base.js
-*/
-
-module.exports = {
-  env: {
-    browser: true,
-    es2020: true,
-  },
-  extends: ['plugin:vue/recommended', 'prettier'],
-  parserOptions: {
-    parser: 'espree',
-    ecmaVersion: 'latest',
-  },
-  plugins: ['unicorn', 'promise', 'import', '@gitlab'],
-  rules: {
-    'vue/html-self-closing': [
-      'error',
-      {
-        html: {
-          void: 'any',
-          normal: 'never',
-          component: 'always',
-        },
-        svg: 'always',
-        math: 'always',
-      },
-    ],
-    'vue/component-tags-order': [
-      'error',
-      {
-        order: ['script', 'template', 'style'],
-      },
-    ],
-    // Turning this off for now as we violate this rule in many places.
-    'vue/max-attributes-per-line': 'off',
-    'vue/component-options-name-casing': ['error', 'PascalCase'],
-    'vue/component-name-in-template-casing': ['error', 'kebab-case'],
-    '@gitlab/vue-require-required-key': 'error',
-    'vue/v-slot-style': [
-      'error',
-      {
-        atComponent: 'shorthand',
-      },
-    ],
-    '@gitlab/vue-no-data-toggle': 'error',
-    '@gitlab/vue-prefer-dollar-scopedslots': 'error',
-    '@gitlab/vue-slot-name-casing': 'error',
-    '@gitlab/no-runtime-template-compiler': 'error',
-    'import/order': [
-      'error',
-      {
-        groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-      },
-    ],
-    // See https://gitlab.com/gitlab-org/frontend/eslint-plugin/-/issues/52.
-    'vue/component-api-style': ['error', ['options']],
-    // We might not want to enable vue/singleline-html-element-content-newline and vue/multiline-html-element-content-newline
-    // just yet as they might cause regression depending on how the consumers compile Vue templates.
-    'vue/singleline-html-element-content-newline': 'off',
-    'vue/multiline-html-element-content-newline': 'off',
-    // Disabling these as they might conflict with prettier.
-    'vue/html-indent': 'off',
-    'vue/html-closing-bracket-newline': 'off',
-    // BEGIN rules to aid migration from Vue 2.x to 3.x.
-    // See https://gitlab.com/groups/gitlab-org/-/epics/3174 for more details.
-    'vue/no-deprecated-data-object-declaration': 'error',
-    'vue/no-deprecated-events-api': 'error',
-    'vue/no-deprecated-filter': 'error',
-    'vue/no-deprecated-functional-template': 'error',
-    'vue/no-deprecated-html-element-is': 'error',
-    'vue/no-deprecated-inline-template': 'error',
-    'vue/no-deprecated-props-default-this': 'error',
-    'vue/no-deprecated-scope-attribute': 'error',
-    'vue/no-deprecated-slot-attribute': 'error',
-    'vue/no-deprecated-slot-scope-attribute': 'error',
-    'vue/no-deprecated-v-on-number-modifiers': 'error',
-    'vue/no-deprecated-vue-config-keycodes': 'error',
-    // END rules to aid migration from Vue 2.x to 3.x.
-  },
-  overrides: [
-    {
-      files: ['**/*.vue'],
-      rules: {
-        'import/no-default-export': 'off',
-      },
-    },
-  ],
-};