@oriflame/config-eslint 4.2.1 → 5.0.3

package/src/rules/unicorn.ts

@@ -1,108 +0,0 @@
-import { ESLintConfig } from '@beemo/driver-eslint';
-
-const config: ESLintConfig['rules'] = {
-  // override ESLint rules
-  'no-nested-ternary': 'off', // disallow nested ternary expressions
-  'no-warning-comments': 'off', // disallow specified warning terms in comments
-
-  // eslint-plugin-unicorn rules
-  'unicorn/better-regex': 'warn', // improve regexes by making them shorter, consistent, and safer
-  'unicorn/catch-error-name': 'warn', // enforce a specific parameter name in catch clauses
-  'unicorn/consistent-destructuring': 'error', // use destructured variables over properties.
-  'unicorn/consistent-function-scoping': 'error', // move function definitions to the highest possible scope
-  'unicorn/custom-error-definition': 'error', // enforce correct Error subclassing
-  'unicorn/empty-brace-spaces': 'off', // enforce no spaces between braces
-  'unicorn/error-message': 'error', // enforce passing a message value when throwing a built-in error
-  'unicorn/escape-case': 'warn', // require escape sequences to use uppercase values
-  'unicorn/expiring-todo-comments': [
-    'warn',
-    {
-      terms: ['todo:', 'fixme:', 'debug:'],
-    },
-  ], // add expiration conditions to to do comments
-  'unicorn/explicit-length-check': 'off', // enforce explicitly comparing the length property of a value
-  'unicorn/filename-case': 'off', // enforce a case style for filenames
-  'unicorn/import-index': 'error', // enforce importing index files with .
-  'unicorn/import-style': 'warn', // enforce specific import styles per module
-  'unicorn/new-for-builtins': 'warn', // enforce the use of new for all builtins, except String, Number, Boolean, Symbol and BigInt
-  'unicorn/no-abusive-eslint-disable': 'off', // enforce specifying rules to disable in eslint-disable comments
-  'unicorn/no-array-callback-reference': 'off', // prevent passing a function reference directly to iterator methods
-  'unicorn/no-array-for-each': 'off', // prefer for…of over Array#forEach(…)
-  'unicorn/no-array-method-this-argument': 'error', // disallow using the this argument in array methods
-  'unicorn/no-array-push-push': 'error', // enforce combining multiple Array#push() into one call
-  'unicorn/no-array-reduce': 'off', // disallow Array#reduce() and Array#reduceRight()
-  'unicorn/no-console-spaces': 'off', // do not use leading/trailing space between console.log parameters
-  'unicorn/no-document-cookie': 'error', // do not use document.cookie directly
-  'unicorn/no-for-loop': 'warn', // Do not use a for loop that can be replaced with a for-of loop
-  'unicorn/no-hex-escape': 'warn', // enforce the use of Unicode escapes instead of hexadecimal escapes
-  'unicorn/no-instanceof-array': 'error', // require Array.isArray() instead of instanceof Array
-  'unicorn/no-keyword-prefix': 'off', // disallow identifiers starting with new or class
-  'unicorn/no-lonely-if': 'warn', // disallow if statements as the only statement in if blocks without else
-  'unicorn/no-nested-ternary': 'error', // disallow nested ternary expressions
-  'unicorn/no-new-array': 'error', // disallow new Array()
-  'unicorn/no-new-buffer': 'error', // enforce the use of Buffer.from() and Buffer.alloc() instead of the deprecated new Buffer()
-  'unicorn/no-null': 'off', // disallow the use of the null literal
-  'unicorn/no-object-as-default-parameter': 'error', // disallow the use of objects as default parameters
-  'unicorn/no-process-exit': 'off', // disallow process.exit()
-  'unicorn/no-static-only-class': 'error', // forbid classes that only have static members
-  'unicorn/no-this-assignment': 'off', // disallow assigning this to a variable
-  'unicorn/no-unreadable-array-destructuring': 'warn', // disallow unreadable array destructuring
-  'unicorn/no-unsafe-regex': 'off', // disallow unsafe regular expressions
-  'unicorn/no-unused-properties': 'off', // disallow unused object properties
-  'unicorn/no-useless-length-check': 'off', // disallow useless array length check
-  'unicorn/no-useless-spread': 'error', // disallow unnecessary spread
-  'unicorn/no-useless-undefined': 'off', // disallow useless undefined
-  'unicorn/no-zero-fractions': 'error', // disallow number literals with zero fractions or dangling dots
-  'unicorn/number-literal-case': 'error', // enforce lowercase identifier and uppercase value for number literals
-  'unicorn/numeric-separators-style': 'off', // enforce the style of numeric separators by correctly grouping digits
-  'unicorn/prefer-add-event-listener': 'error', // prefer .addEventListener() and .removeEventListener() over on-functions
-  'unicorn/prefer-array-find': 'warn', // prefer .find(…) over the first element from .filter(…)
-  'unicorn/prefer-array-flat': 'warn', // prefer Array#flat() over legacy techniques to flatten arrays
-  'unicorn/prefer-array-flat-map': 'warn', // prefer .flatMap(…) over .map(…).flat()
-  'unicorn/prefer-array-index-of': 'warn', // prefer Array#indexOf() over Array#findIndex() when looking for the index of an item
-  'unicorn/prefer-array-some': 'warn', // prefer .some(…) over .find(…)
-  'unicorn/prefer-at': 'warn', // prefer .at() method for index access and String#charAt()
-  'unicorn/prefer-date-now': 'warn', // prefer Date.now() to get the number of milliseconds since the Unix Epoch
-  'unicorn/prefer-default-parameters': 'error', // prefer default parameters over reassignment
-  'unicorn/prefer-dom-node-append': 'warn', // prefer Node#append() over Node#appendChild()
-  'unicorn/prefer-dom-node-dataset': 'warn', // prefer using .dataset on DOM elements over .setAttribute(…)
-  'unicorn/prefer-dom-node-remove': 'warn', // prefer childNode.remove() over parentNode.removeChild(childNode)
-  'unicorn/prefer-dom-node-text-content': 'warn', // prefer .textContent over .innerText
-  'unicorn/prefer-includes': 'off', // prefer .includes() over .indexOf() when checking for existence or non-existence
-  'unicorn/prefer-keyboard-event-key': 'warn', // prefer KeyboardEvent#key over KeyboardEvent#keyCode.
-  'unicorn/prefer-math-trunc': 'warn', // enforce the use of Math.trunc instead of bitwise operators
-  'unicorn/prefer-modern-dom-apis': 'warn', // prefer .before() over .insertBefore(), .replaceWith() over .replaceChild(), prefer one of .before(), .after(), .append() or .prepend() over insertAdjacentText() and insertAdjacentElement()
-  // FIXME [@rajzik]: This is good rule but adoption isn't great so far
-  'unicorn/prefer-module': 'off', // Prefer JavaScript modules (ESM) over CommonJS
-  // FIXME [eslint-plugin-import]: Once https://github.com/benmosher/eslint-plugin-import/issues/2035 is closed can be enabled
-  'unicorn/prefer-node-protocol': 'off', // Prefer using the `node:` protocol when importing Node.js builtin modules
-  'unicorn/prefer-negative-index': 'warn', // prefer negative index over .length - index for {String,Array,TypedArray}#slice() and Array#splice()
-  'unicorn/prefer-number-properties': 'warn', // prefer Number static properties over global ones
-  'unicorn/prefer-object-from-entries': 'warn', // prefer using Object.fromEntries(…) to transform a list of key-value pairs into an object
-  'unicorn/prefer-object-has-own': 'warn', // prefer Object.hasOwn(…) over Object.prototype.hasOwnProperty.call(…)
-  'unicorn/prefer-optional-catch-binding': 'off', // prefer omitting the catch binding parameter
-  'unicorn/prefer-prototype-methods': 'warn', // prefer borrowing methods from the prototype instead of the instance
-  'unicorn/prefer-query-selector': 'off', // prefer .querySelector() over .getElementById(), .querySelectorAll() over .getElementsByClassName() and .getElementsByTagName()
-  'unicorn/prefer-reflect-apply': 'off', // prefer Reflect.apply() over Function#apply()
-  'unicorn/prefer-regexp-test': 'warn', // prefer RegExp#test() over String#match() and RegExp#exec()
-  // Autofix can be breaking
-  'unicorn/prefer-set-has': 'warn', // prefer Set#has() over Array#includes() when checking for existence or non-existence
-  'unicorn/prefer-spread': 'error', // prefer the spread operator over Array.from()
-  'unicorn/prefer-string-replace-all': 'warn', // prefer String#replaceAll() over regex searches with the global flag
-  'unicorn/prefer-string-slice': 'warn', // prefer String#slice() over String#substr() and String#substring()
-  'unicorn/prefer-string-starts-ends-with': 'warn', // prefer String#startsWith() & String#endsWith() over more complex alternatives
-  'unicorn/prefer-string-trim-start-end': 'warn', // prefer String#trimStart() / String#trimEnd() over String#trimLeft() / String#trimRight()
-  'unicorn/prefer-switch': 'off', // prefer switch over multiple else-if
-  'unicorn/prefer-ternary': 'off', // prefer ternary expressions over simple if-else statements
-  // FIXME [@jakubmazanec]: enable when we support top-level await
-  'unicorn/prefer-top-level-await': 'off', // prefer top-level await over top-level promises and async function calls
-  'unicorn/prefer-type-error': 'warn', // enforce throwing TypeError in type checking conditions
-  'unicorn/prevent-abbreviations': 'off', // Prevent abbreviations.
-  'unicorn/require-array-join-separator': 'error', // enforce using the separator argument with Array#join()
-  'unicorn/require-number-to-fixed-digits-argument': 'error', // enforce using the digits argument with Number#toFixed()
-  'unicorn/require-post-message-target-origin': 'error', // enforce using the targetOrigin argument with window.postMessage()
-  'unicorn/string-content': 'off', // enforce better string content
-  'unicorn/throw-new-error': 'error', // require new when throwing an error
-};
-
-export = config;

package/test/index.test.ts

@@ -1,46 +0,0 @@
-import { getExtendsList, ESLintOptions } from '../src';
-import { getErrors } from './utils/getErrors';
-
-interface OptionsShape {
-  filePath?: string;
-}
-
-describe('Check that eslint rules are correct', () => {
-  test.each<[ESLintOptions, string, OptionsShape?]>([
-    [{}, 'javascript.js', undefined],
-    [{ node: true }, 'node.js', undefined],
-    [{ prettier: true }, 'prettier.js', undefined],
-  ])(
-    'Config (options: %o) should work with file: %s and cliOptions: %o',
-    async (options, file, cliOptions) => {
-      const output = await getErrors(
-        {
-          extends: getExtendsList(options),
-        },
-        `packages/config-eslint/test/lint-files/${file}`,
-        cliOptions,
-      );
-      expect(output[0].messages.filter((item) => item.severity === 2)).toEqual([]);
-      expect(output[0].errorCount).toBe(0);
-    },
-  );
-
-  test.each<[ESLintOptions, string, OptionsShape | undefined, number]>([
-    [{}, 'javascript.js', undefined, 1],
-    [{ node: true }, 'node.js', undefined, 1],
-    [{ prettier: true }, 'prettier.js', undefined, 4],
-  ])(
-    'Config (options: %o) should throw error with file: %s and cliOptions: %o',
-    async (options, file, cliOptions, expectedErrors) => {
-      const output = await getErrors(
-        {
-          extends: getExtendsList(options),
-        },
-        `packages/config-eslint/test/lint-files/errors/${file}`,
-        cliOptions,
-      );
-
-      expect(output[0].errorCount).toBe(expectedErrors);
-    },
-  );
-});

package/test/lint-files/combo.ts

@@ -1,10 +0,0 @@
-interface Interface {
-  (a: string): void;
-  test: string;
-}
-
-export const b: Interface = (a) => {
-  console.log(a);
-};
-
-b.test = 'test string';

package/test/lint-files/errors/combo.ts

@@ -1,3 +0,0 @@
-class TestClass {
-  constructor() {}
-}

package/test/lint-files/errors/javascript.js

@@ -1,2 +0,0 @@
-let a = 'ahoj';
-console.log(a);

package/test/lint-files/errors/next.js

@@ -1,11 +0,0 @@
-export function A() {
-  return (
-    <>
-      {['a'].map((item, index) => (
-        <p key={index}>{item}</p>
-      ))}
-    </>
-  );
-}
-const regex = new RegExp('myRegex');
-console.log(regex.test('my test'));

package/test/lint-files/errors/node.js

@@ -1,3 +0,0 @@
-const cwd = process.cwd();
-console.log(cwd);
-document.getElementById('');

package/test/lint-files/errors/prettier.js

@@ -1,5 +0,0 @@
-export function A() {
-  return <>
-    {['a'].map(item => <p>{item}</p>)}
-  </>
-}

package/test/lint-files/errors/test.js

@@ -1,3 +0,0 @@
-test('my default test', () => {
-  expect(true).toBe(true);
-});

package/test/lint-files/errors/typescript.ts

@@ -1,3 +0,0 @@
-class TestClass {
-  constructor() {}
-}

package/test/lint-files/javascript.js

@@ -1 +0,0 @@
-console.log('test');

package/test/lint-files/next.ts

@@ -1,5 +0,0 @@
-const a = '    my test';
-
-const b = a.trimStart();
-
-console.log(b);

package/test/lint-files/node.js

@@ -1,2 +0,0 @@
-const cwd = process.cwd();
-console.log(cwd);

package/test/lint-files/prettier.js

@@ -1 +0,0 @@
-console.log('Hello');

package/test/lint-files/test.js

@@ -1,5 +0,0 @@
-describe('my lint test', () => {
-  test('my default test', () => {
-    expect(true).toBe(true);
-  });
-});

package/test/lint-files/typescript.ts

@@ -1,20 +0,0 @@
-interface Interface {
-  (a: string): void;
-  test: string;
-}
-
-export const b: Interface = (a) => {
-  console.log(a);
-};
-
-b.test = 'test string';
-
-interface Item {
-  maybe?: string;
-}
-
-const item: Item = {};
-
-if (!item.maybe) {
-  console.log('test');
-}

package/test/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": false,
-    "emitDeclarationOnly": false,
-    "noEmit": true,
-    "rootDir": "."
-  },
-  "extends": "../../../tsconfig.options.json",
-  "include": [
-    "**/*",
-    "../types/**/*",
-    "../../../types/**/*"
-  ],
-  "references": [
-    {
-      "path": ".."
-    }
-  ]
-}

package/test/utils/getErrors.ts

@@ -1,16 +0,0 @@
-import fs from 'fs';
-import eslint, { ESLint } from 'eslint';
-
-export function getErrors(
-  config: ESLint.Options['baseConfig'],
-  fileToTest: string,
-  options?: Parameters<ESLint['lintText']>[1]
-) {
-  const CLIEngine = eslint.ESLint;
-
-  const cli = new CLIEngine({
-    baseConfig: config,
-  });
-
-  return cli.lintText(fs.readFileSync(fileToTest, 'utf8'), options);
-}

package/tools/check-rules/allRules.ts

@@ -1,99 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-argument */
-/* eslint-disable @typescript-eslint/no-unnecessary-type-assertion */
-const eslint = require('eslint/lib/rules');
-const eslintPluginTypescript = require('@typescript-eslint/eslint-plugin');
-const eslintPluginEslintComments = require('eslint-plugin-eslint-comments');
-const eslintPluginImport = require('eslint-plugin-import');
-const eslintPluginJest = require('eslint-plugin-jest');
-const eslintPluginJsxA11y = require('eslint-plugin-jsx-a11y');
-const eslintPluginNode = require('eslint-plugin-node');
-const eslintPluginPrettier = require('eslint-plugin-prettier');
-const eslintPluginPromise = require('eslint-plugin-promise');
-const eslintPluginReact = require('eslint-plugin-react');
-const eslintPluginReactHooks = require('eslint-plugin-react-hooks');
-const eslintPluginTestingLibrary = require('eslint-plugin-testing-library');
-const eslintPluginUnicorn = require('eslint-plugin-unicorn');
-
-interface Rule {
-  meta: {
-    deprecated: boolean;
-  };
-}
-
-const eslintRules: string[] = [];
-
-for (const [ruleName, rule] of eslint.entries()) {
-  if (!rule.meta.deprecated) {
-    eslintRules.push(ruleName);
-  }
-}
-
-const typescriptRules = (Object.entries(eslintPluginTypescript.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `@typescript-eslint/${ruleName}`);
-
-const eslintCommentsRules = (
-  Object.entries(eslintPluginEslintComments.rules) as Array<[string, Rule]>
-)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `eslint-comments/${ruleName}`);
-
-const importRules = (Object.entries(eslintPluginImport.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `import/${ruleName}`);
-
-const jestRules = (Object.entries(eslintPluginJest.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `jest/${ruleName}`);
-
-const jsxA11yRules = (Object.entries(eslintPluginJsxA11y.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `jsx-a11y/${ruleName}`);
-
-const nodeRules = (Object.entries(eslintPluginNode.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `node/${ruleName}`);
-
-const prettierRules = (Object.entries(eslintPluginPrettier.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `prettier/${ruleName}`);
-
-const promiseRules = (Object.entries(eslintPluginPromise.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `promise/${ruleName}`);
-
-const reactRules = (Object.entries(eslintPluginReact.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `react/${ruleName}`);
-
-const reactHooksRules = (Object.entries(eslintPluginReactHooks.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `react-hooks/${ruleName}`);
-
-const testingLibraryRules = (
-  Object.entries(eslintPluginTestingLibrary.rules) as Array<[string, Rule]>
-)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `testing-library/${ruleName}`);
-
-const unicornRules = (Object.entries(eslintPluginUnicorn.rules) as Array<[string, Rule]>)
-  .filter(([ruleName, rule]) => !rule.meta.deprecated)
-  .map(([ruleName]) => `unicorn/${ruleName}`);
-
-export const allRules = [
-  ...eslintRules,
-  ...typescriptRules,
-  ...eslintCommentsRules,
-  ...importRules,
-  ...jestRules,
-  ...jsxA11yRules,
-  ...nodeRules,
-  ...prettierRules,
-  ...promiseRules,
-  ...reactRules,
-  ...reactHooksRules,
-  ...testingLibraryRules,
-  ...unicornRules,
-];

package/tools/check-rules/index.ts

@@ -1,90 +0,0 @@
-import { allRules } from './allRules';
-
-import a11yRulesConfig from '../../src/rules/a11y';
-import eslintRulesConfig from '../../src/rules/eslint';
-import eslintCommentsRulesConfig from '../../src/rules/eslint-comments';
-import importRulesConfig from '../../src/rules/import';
-import jestRulesConfig from '../../src/rules/jest';
-import nodeRulesConfig from '../../src/rules/node';
-import prettierRulesConfig from '../../src/rules/prettier';
-import promiseRulesConfig from '../../src/rules/promise';
-import reactHooksRulesConfig from '../../src/rules/react-hooks';
-import reactRulesConfig from '../../src/rules/react';
-import testingLibraryRulesConfig from '../../src/rules/testing-library';
-import typescriptRulesConfig from '../../src/rules/typescript';
-import unicornRulesConfig from '../../src/rules/unicorn';
-import { RuleOptions, RuleSetting } from '@beemo/driver-eslint';
-
-const filerDisabledRules = ([ruleName, rule]: [
-  string,
-  RuleSetting | [RuleSetting, ...RuleOptions[]],
-]) => {
-  if (Array.isArray(rule)) {
-    if (rule[0] === 0 || rule[0] === '0' || rule[0] === 'off') {
-      return false;
-    }
-  }
-
-  if (rule === 0 || rule === '0' || rule === 'off') {
-    return false;
-  }
-
-  return true;
-};
-
-const a11yRules = Object.entries(a11yRulesConfig!).map(([ruleName]) => ruleName);
-const eslintRules = Object.entries(eslintRulesConfig!).map(([ruleName]) => ruleName);
-const eslintCommentsRules = Object.entries(eslintCommentsRulesConfig!).map(
-  ([ruleName]) => ruleName,
-);
-const importRules = Object.entries(importRulesConfig!).map(([ruleName]) => ruleName);
-const jestRules = Object.entries(jestRulesConfig!).map(([ruleName]) => ruleName);
-const nodeRules = Object.entries(nodeRulesConfig!).map(([ruleName]) => ruleName);
-const prettierRules = Object.entries(prettierRulesConfig!).map(([ruleName]) => ruleName);
-const promiseRules = Object.entries(promiseRulesConfig!).map(([ruleName]) => ruleName);
-const reactHookRules = Object.entries(reactHooksRulesConfig!).map(([ruleName]) => ruleName);
-const reactRules = Object.entries(reactRulesConfig!).map(([ruleName]) => ruleName);
-const testingLibraryRules = Object.entries(testingLibraryRulesConfig!).map(
-  ([ruleName]) => ruleName,
-);
-const typescriptRules = Object.entries(typescriptRulesConfig!).map(([ruleName]) => ruleName);
-const unicornRules = Object.entries(unicornRulesConfig!).map(([ruleName]) => ruleName);
-
-const usedRules = [
-  ...a11yRules,
-  ...eslintRules,
-  ...eslintCommentsRules,
-  ...importRules,
-  ...jestRules,
-  ...nodeRules,
-  ...prettierRules,
-  ...promiseRules,
-  ...reactHookRules,
-  ...reactRules,
-  ...testingLibraryRules,
-  ...typescriptRules,
-  ...unicornRules,
-].sort();
-
-const missingRules: string[] = [];
-
-allRules.forEach((ruleName) => {
-  if (!usedRules.includes(ruleName)) {
-    missingRules.push(ruleName);
-  }
-});
-
-missingRules.sort();
-
-const deprecatedRules: string[] = [];
-
-usedRules.forEach((ruleName) => {
-  if (!allRules.includes(ruleName)) {
-    deprecatedRules.push(ruleName);
-  }
-});
-
-deprecatedRules.sort();
-
-console.log('Deprecated rules:', deprecatedRules);
-console.log('Missing rules:', missingRules);

package/tools/check-rules/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "declarationDir": "lib",
-    "outDir": "lib",
-    "rootDir": "../../"
-  },
-  "exclude": [
-    "lib",
-    "tests"
-  ],
-  "extends": "../../../../tsconfig.options.json",
-  "include": [
-    "./**/*",
-    "../../src/**/*",
-    "../../../../types/**/*"
-  ]
-}

package/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "declarationDir": "lib",
-    "outDir": "lib",
-    "rootDir": "src"
-  },
-  "exclude": [
-    "lib",
-    "tests"
-  ],
-  "extends": "../../tsconfig.options.json",
-  "include": [
-    "src/**/*",
-    "types/**/*",
-    "../../types/**/*"
-  ],
-  "references": [
-    {
-      "path": "../lumos-common"
-    }
-  ]
-}