@gitlab/eslint-plugin 21.5.0 → 23.0.0

package/scripts/helpers/getConfigs.js

@@ -1,19 +1,28 @@
 const path = require('path');
 const glob = require('glob');
 
-const rulesDir = path.join(__dirname, '../../lib/configs');
+const configsDir = path.join(__dirname, '../../lib/flat-configs');
 
-function getRule(fullPath) {
-  const relative = path.relative(rulesDir, fullPath);
+/*
+  lib/flat-configs/ is a closed set: this glob decides what `yarn update`
+  publishes as `plugin.configs[<basename>]`, so a shared helper dropped in that
+  directory becomes a bogus public config, which tests/lib/configs/exports.spec.js
+  fails on once `yarn update` has regenerated lib/index.js. That is why
+  lib/prettier-rules.js and lib/vue-fragments.js sit at the lib/ root instead;
+  put new shared code there.
+
+  No `.meta` spread, unlike getRules.js: a flat config exports an array.
+*/
+function getConfig(fullPath) {
+  const relative = path.relative(configsDir, fullPath);
   const name = path.basename(relative, '.js');
   return {
-    ...require(fullPath).meta,
     name,
     relative,
     fullPath,
   };
 }
 
-module.exports = function getRules() {
-  return glob.sync(path.join(rulesDir, '**/*.js')).map(getRule);
+module.exports = function getConfigs() {
+  return glob.sync(path.join(configsDir, '*.js')).map(getConfig);
 };

package/scripts/publish_npm_package.mjs

@@ -170,7 +170,6 @@ async function createReleases({ changesets, releases }) {
 
       if (type) {
         releaseDescriptionObject[type].push(
-          // eslint-disable-next-line no-await-in-loop
           await defaultChangelogFunctions.getReleaseLine(changeset, type),
         );
       }
@@ -181,7 +180,6 @@ async function createReleases({ changesets, releases }) {
       .map(([type, lines]) => releaseSection(type, lines))
       .join('\n\n');
 
-    // eslint-disable-next-line no-await-in-loop
     await createRelease({ tag: `v${release.newVersion}`, description });
   }
 }

package/scripts/updateFiles.js

@@ -9,21 +9,40 @@ const libPath = path.join(__dirname, '../lib');
 const rules = getRules();
 const configs = getConfigs();
 
-const createIndexJs = (ruleImports, configImports) => `/**
+const createPluginJs = (ruleImports) => `/**
  * 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: {
 ${ruleImports.join('\n')}
   },
+};
+`;
+
+const createIndexJs = (configImports) => `/**
+ * 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 = {
+  ...plugin,
   configs: {
 ${configImports.join('\n')}
-  }
+  },
 };
 `;
 
 const writeIndexJs = () => {
-  console.log('Updating lib/index.js...');
+  console.log('Updating lib/plugin.js and lib/index.js...');
 
   const ruleImports = rules.map((rule) => {
     const relPath = path.relative(libPath, rule.fullPath);
@@ -32,12 +51,17 @@ const writeIndexJs = () => {
 
   const configImports = configs.map((config) => {
     const relPath = path.relative(libPath, config.fullPath);
-    return `    '${config.name}': require('./${relPath}'),`;
+    // Quoted so a hyphenated filename cannot emit a syntax error; prettier
+    // drops the quotes again where they are redundant.
+    return `    get '${config.name}'() {
+      return require('./${relPath}');
+    },`;
   });
 
-  fs.writeFileSync(path.join(libPath, 'index.js'), createIndexJs(ruleImports, configImports));
+  fs.writeFileSync(path.join(libPath, 'plugin.js'), createPluginJs(ruleImports));
+  fs.writeFileSync(path.join(libPath, 'index.js'), createIndexJs(configImports));
 
-  console.log('Successfully updated lib/index.js');
+  console.log('Successfully updated lib/plugin.js and lib/index.js');
 };
 
 const createDoc = (ruleDocs) => `<!--

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/eslint9/configs/typescript.js

@@ -1,134 +0,0 @@
-const baseConfig = require('./base');
-const tsEslint = require('@typescript-eslint/eslint-plugin');
-const tsParser = require('@typescript-eslint/parser');
-const globals = require('globals');
-
-const tsConfig = [
-  {
-    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,
-    },
-  },
-  // TypeScript-specific config
-  {
-    files: ['**/*.ts', '**/*.tsx'],
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        project: ['./tsconfig.json'],
-        tsconfigRootDir: process.cwd(),
-      },
-    },
-    plugins: {
-      '@typescript-eslint': tsEslint,
-    },
-    settings: {
-      'import/resolver': {
-        node: {
-          extensions: ['.mjs', '.js', '.json', '.node', '.ts', '.tsx'],
-        },
-      },
-    },
-    rules: {
-      'import/extensions': [
-        'error',
-        'ignorePackages',
-        {
-          js: 'never',
-          jsx: 'never',
-          ts: 'never',
-          tsx: 'never',
-        },
-      ],
-      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',
-        },
-      ],
-      '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.',
-        },
-      ],
-    },
-  },
-  // Test files config
-  {
-    files: ['**/*.test.ts', '**/*.test.js'],
-    rules: {
-      'max-classes-per-file': 'off',
-      '@typescript-eslint/no-non-null-assertion': 'off',
-    },
-  },
-];
-
-module.exports = tsConfig;

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;