eslint-plugin-oxlint/src/build-from-oxlint-config/rules.spec.ts

Turn off all rules already supported by oxlint

import { describe, expect, it } from 'vitest';
import { handleRulesScope } from './rules.js';
import {
  unicornRulesExtendEslintRules,
  viteTestCompatibleRules,
} from '../constants.js';

describe('handleRulesScope', () => {
  for (const ruleSetting of [
    'error',
    ['error'],
    'warn',
    ['warn'],
    1,
    [1],
    2,
    [2],
  ]) {
    it(`detect active rule ${JSON.stringify(ruleSetting)} inside "rules" scope`, () => {
      const rules = {};
      handleRulesScope(
        {
          eqeqeq: ruleSetting,
        },
        rules
      );

      expect(rules).toStrictEqual({
        eqeqeq: 'off',
      });
    });
  }

  for (const ruleSetting of ['off', ['off'], 0, [0]]) {
    it(`skip deactive rule ${JSON.stringify(ruleSetting)} inside "rules" scope`, () => {
      const rules = {};
      handleRulesScope(
        {
          eqeqeq: ruleSetting,
        },
        rules
      );

      expect(rules).toStrictEqual({});
    });
  }

  for (const ruleSetting of ['on', ['on'], 3, [3]]) {
    it(`skip invalid ${JSON.stringify(ruleSetting)} inside "rules" scope`, () => {
      const rules = {};
      handleRulesScope(
        {
          eqeqeq: ruleSetting,
        },
        rules
      );

      expect(rules).toStrictEqual({});
    });
  }

  // look here: <https://github.com/oxc-project/oxc/blob/542bbd77ed50ad037c275b3af169b1edfab59988/crates/oxc_linter/src/config/rules.rs#L283-L296>
  it('detects oxlint rules with plugin alias inside rules block', () => {
    const rules = {};
    handleRulesScope(
      {
        'eslint/eqeqeq': 'warn',
        'typescript/no-unused-vars': 'warn',
        'react_perf/jsx-no-new-array-as-prop': 'warn',
        'nextjs/no-img-element': 'warn',
        'jsx_a11y/alt-text': 'warn',
        'react/rules-of-hooks': 'warn',
        'import-x/namespace': 'warn',
        // 'deepscan/xxx': 'warn',
      },
      rules
    );

    expect(rules).toStrictEqual({
      eqeqeq: 'off',
      '@typescript-eslint/no-unused-vars': 'off',
      'react-perf/jsx-no-new-array-as-prop': 'off',
      '@next/next/no-img-element': 'off',
      'jsx-a11y/alt-text': 'off',
      'react-hooks/rules-of-hooks': 'off',
      'import/namespace': 'off',
    });
  });

  it('detects rules without plugin name', () => {
    const rules = {};
    handleRulesScope(
      {
        'no-unused-vars': 'warn',
        'jsx-no-new-array-as-prop': 'warn',
        'no-img-element': 'warn',
        'no-array-reduce': 'warn',
      },
      rules
    );

    expect(rules).toStrictEqual({
      'no-unused-vars': 'off', // ToDo: should be @typescript-eslint/
      'react-perf/jsx-no-new-array-as-prop': 'off',
      '@next/next/no-img-element': 'off',
      'unicorn/no-array-reduce': 'off',
    });
  });

  it('skips unknown oxlint rules', () => {
    const rules = {};
    handleRulesScope(
      {
        unknown: 'warn',
        'typescript/no-img-element': 'warn', // valid rule, but wrong plugin-name
      },
      rules
    );

    expect(rules).toStrictEqual({});
  });

  for (const alias of viteTestCompatibleRules) {
    it(`disables vitest jest alias rules for ${alias}`, () => {
      for (const rule of [`jest/${alias}`, `vitest/${alias}`]) {
        const rules = {};
        handleRulesScope(
          {
            [rule]: 'warn',
          },
          rules
        );

        expect(rules).toStrictEqual({
          [rule]: 'off',
        });
      }
    });
  }

  for (const alias of unicornRulesExtendEslintRules) {
    it(`disables unicorn eslint alias rules for ${alias}`, () => {
      for (const rule of [`unicorn/${alias}`, alias]) {
        const rules = {};
        handleRulesScope(
          {
            [rule]: 'warn',
          },
          rules
        );

        expect(rules).toStrictEqual({
          [rule]: 'off',
        });
      }
    });
  }
});