@w5s/eslint-config 1.0.0-alpha.9 → 1.0.0

package/src/es/base.ts

@@ -0,0 +1,80 @@
+import type eslint from 'eslint';
+import { ECMA_VERSION, ESLintConfig } from '@w5s/dev';
+
+// Fix eslint shareable config (https://github.com/eslint/eslint/issues/3458)
+// @ts-ignore No typing available
+import '@rushstack/eslint-patch/modern-module-resolution.js';
+// @ts-ignore No typing available
+import bestPracticesConfig from 'eslint-config-airbnb-base/rules/best-practices';
+// @ts-ignore No typing available
+import errorsConfig from 'eslint-config-airbnb-base/rules/errors';
+// @ts-ignore No typing available
+import es6Config from 'eslint-config-airbnb-base/rules/es6';
+// @ts-ignore No typing available
+import nodeConfig from 'eslint-config-airbnb-base/rules/node';
+// @ts-ignore No typing available
+import strictConfig from 'eslint-config-airbnb-base/rules/strict';
+// @ts-ignore No typing available
+import styleConfig from 'eslint-config-airbnb-base/rules/style';
+// @ts-ignore No typing available
+import variablesConfig from 'eslint-config-airbnb-base/rules/variables';
+
+const baseConfig = ESLintConfig.concat(
+  bestPracticesConfig,
+  errorsConfig,
+  es6Config,
+  nodeConfig,
+  strictConfig,
+  styleConfig,
+  variablesConfig
+);
+
+const config: eslint.Linter.Config = ESLintConfig.concat(
+  baseConfig,
+  // overrides
+  {
+    env: {
+      [`es${ECMA_VERSION}`]: true,
+    },
+    globals: {
+      __DEV__: 'readonly',
+      __PROD__: 'readonly',
+      __TEST__: 'readonly',
+    },
+    parser: 'espree',
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+      ecmaVersion: ECMA_VERSION,
+      sourceType: 'module',
+    },
+    reportUnusedDisableDirectives: true,
+    rules: {
+      // Annoying because it is not always wanted
+      'default-case': 'off',
+      // We do not want console.* in production. Disable this rule on a per line basis if needed
+      'no-console': 'error',
+      // Often useful in jsx
+      'no-nested-ternary': 'off',
+      // Too strict, for pure code prefer the functional plugin
+      'no-param-reassign': ['error', { props: false }],
+      // Allow for-of syntax
+      // @ts-ignore No typing available
+      'no-restricted-syntax': baseConfig.rules['no-restricted-syntax'].filter(
+        // @ts-ignore No typing available
+        ({ selector }) => selector !== 'ForOfStatement'
+      ),
+      // underscore is often used (mongodb, etc)
+      'no-underscore-dangle': 'off',
+      // Ignore underscore case arguments
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      // Allow in some cases https://github.com/airbnb/javascript/issues/1089#issuecomment-1024351821
+      'no-use-before-define': ['error', 'nofunc'],
+      // Allow statements, to be compatible with '@typescript-eslint/no-floating-promises' fix
+      'no-void': ['error', { allowAsStatement: true }],
+    },
+  }
+);
+
+export = config;

package/src/es/import.ts

@@ -0,0 +1,61 @@
+import { ESLintConfig, EXTENSIONS, EXTENSIONS_RESOURCES_REGEX, IGNORE_LIST } from '@w5s/dev';
+import type eslint from 'eslint';
+// @ts-ignore airbnb is not typed
+import importConfig from 'eslint-config-airbnb-base/rules/imports';
+import { fixme } from '../_rule.js';
+
+// @see https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
+
+const config: eslint.Linter.Config = ESLintConfig.concat(
+  importConfig,
+  // Overrides
+  {
+    rules: {
+      'import/extensions': [
+        'error',
+        'ignorePackages',
+        {
+          // js: 'never',
+          // jsx: 'never',
+          // mjs: 'never',
+        },
+      ],
+      'import/no-deprecated': 'off', // Performance issues
+      'import/no-extraneous-dependencies': [
+        'error',
+        {
+          ...importConfig.rules['import/no-extraneous-dependencies'][1],
+          devDependencies: [
+            ...importConfig.rules['import/no-extraneous-dependencies'][1].devDependencies,
+            '**/*.config.[jt]s?(x)',
+            '**/*.config.cjs',
+          ],
+        },
+      ],
+      'import/no-named-as-default': 'off', // Performance issues
+      'import/no-unused-modules': 'off', // Performance issues
+      'import/prefer-default-export': 'off', // Not aligned, default export does not bring sufficient semantic
+      'import/unambiguous': fixme('off'), // Disable because proposal still in progress
+    },
+    settings: {
+      'import/extensions': EXTENSIONS,
+
+      // Resolve type definition packages
+      'import/external-module-folders': ['node_modules', 'node_modules/@types'],
+      'import/ignore': [...IGNORE_LIST, EXTENSIONS_RESOURCES_REGEX],
+
+      // Apply special parsing for TypeScript files
+      'import/parsers': {
+        '@typescript-eslint/parser': EXTENSIONS.filter((ext) => !ext.includes('js')),
+      },
+      // Append 'ts' extensions to Airbnb 'import/resolver' setting
+      'import/resolver': {
+        node: {
+          extensions: [...EXTENSIONS, '.json'],
+        },
+      },
+    },
+  }
+);
+
+export = config;

package/src/es/jsdoc.ts

@@ -0,0 +1,22 @@
+import type eslint from 'eslint';
+
+const config: eslint.Linter.Config = {
+  extends: ['plugin:jsdoc/recommended'],
+  plugins: ['jsdoc'],
+  rules: {
+    'jsdoc/no-undefined-types': 'off', // https://github.com/gajus/eslint-plugin-jsdoc/issues/839
+    'jsdoc/require-hyphen-before-param-description': ['warn', 'always'],
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/valid-types': 'off', // FIXME: reports lots of false positive
+    strict: ['error', 'safe'],
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript',
+    },
+  },
+};
+
+export = config;

package/src/es/promise.ts

@@ -0,0 +1,13 @@
+import { ESLintConfig } from '@w5s/dev';
+import type eslint from 'eslint';
+import { fixme } from '../_rule.js';
+
+const config: eslint.Linter.Config = ESLintConfig.concat({
+  extends: ['plugin:promise/recommended'],
+  plugins: ['promise'],
+  rules: {
+    'promise/prefer-await-to-callbacks': fixme('error'), // https://github.com/xjamundx/eslint-plugin-promise/issues/212
+    'promise/prefer-await-to-then': 'error',
+  },
+});
+export = config;

package/src/es/unicorn.ts

@@ -0,0 +1,75 @@
+import { ESLintConfig } from '@w5s/dev';
+import type eslint from 'eslint';
+// @ts-ignore unicorn config is not typed
+import unicornConfig from 'eslint-plugin-unicorn/configs/recommended.js';
+
+const config: eslint.Linter.Config = ESLintConfig.concat(
+  unicornConfig,
+  {
+    // extends: ['plugin:unicorn/recommended'],
+    plugins: ['unicorn'],
+    rules: {
+      'unicode-bom': ['error', 'never'],
+      'unicorn/better-regex': 'error',
+      'unicorn/catch-error-name': ['error', { name: 'error' }],
+      'unicorn/custom-error-definition': 'error',
+      'unicorn/error-message': 'error',
+      'unicorn/explicit-length-check': ['error', { 'non-zero': 'greater-than' }],
+      'unicorn/filename-case': 'off',
+      'unicorn/import-index': 'off', // Not playing well with ES Module
+      'unicorn/new-for-builtins': 'off', // error, @see https://github.com/sindresorhus/eslint-plugin-unicorn/issues/122
+      'unicorn/no-abusive-eslint-disable': 'error',
+      'unicorn/no-array-instanceof': 'error',
+      'unicorn/no-console-spaces': 'off',
+      'unicorn/no-fn-reference-in-iterator': 'off', // error ?
+      'unicorn/no-for-loop': 'error',
+      'unicorn/no-hex-escape': 'error',
+      'unicorn/no-new-buffer': 'error',
+      'unicorn/no-null': 'off', // https://github.com/sindresorhus/eslint-plugin-unicorn/issues/612
+      'unicorn/no-process-exit': 'off',
+      'unicorn/no-unreadable-array-destructuring': 'off',
+      'unicorn/no-unsafe-regex': 'error',
+      'unicorn/no-unused-properties': 'warn',
+      'unicorn/no-useless-undefined': 'off',
+      'unicorn/no-zero-fractions': 'error',
+      'unicorn/number-literal-case': 'error',
+      'unicorn/prefer-add-event-listener': 'off',
+      'unicorn/prefer-event-key': 'error',
+      'unicorn/prefer-exponentiation-operator': 'error',
+      'unicorn/prefer-flat-map': 'error',
+      'unicorn/prefer-includes': 'error',
+      'unicorn/prefer-node-append': 'error',
+      'unicorn/prefer-node-remove': 'error',
+      'unicorn/prefer-number-properties': 'error',
+      'unicorn/prefer-query-selector': 'error',
+      'unicorn/prefer-set-has': 'off',
+      'unicorn/prefer-spread': 'off',
+      'unicorn/prefer-starts-ends-with': 'error',
+      'unicorn/prefer-text-content': 'error',
+      'unicorn/prefer-type-error': 'error',
+      'unicorn/throw-new-error': 'error',
+    },
+  },
+  {
+    overrides: [
+      {
+        files: ['**/*.config.cjs', '**/*.config.js'],
+        rules: {
+          'unicorn/prefer-module': 'off',
+        },
+      },
+    ],
+    rules: {
+      'unicorn/consistent-destructuring': 'off',
+      'unicorn/consistent-function-scoping': 'off', // Too many false positive
+      'unicorn/no-array-callback-reference': 'off', // Many false positive reported
+      'unicorn/no-array-for-each': 'off', // This rule could change browser compatibility
+      'unicorn/no-array-method-this-argument': 'off', // Many false positive reported
+      'unicorn/no-array-reduce': 'off', // Array#reduce can be used
+      'unicorn/no-object-as-default-parameter': 'off',
+      'unicorn/prefer-default-parameters': 'off',
+      'unicorn/prevent-abbreviations': 'off', // This rule is so dangerous : it potentially break code while fixing in many cases !!
+    },
+  }
+);
+export = config;

package/src/es.ts

@@ -0,0 +1,18 @@
+import type eslint from 'eslint';
+import { ESLintConfig } from '@w5s/dev';
+import baseConfig from './es/base.js';
+import promiseConfig from './es/promise.js';
+import jsdocConfig from './es/jsdoc.js';
+import importConfig from './es/import.js';
+import unicornConfig from './es/unicorn.js';
+// import prettierConfig from './prettier.js';
+
+const config: eslint.Linter.Config = ESLintConfig.concat(
+  baseConfig,
+  promiseConfig,
+  jsdocConfig,
+  importConfig,
+  unicornConfig
+  // prettierConfig
+);
+export = config;

package/src/ignore.ts

@@ -0,0 +1,41 @@
+import type eslint from 'eslint';
+import { readFileSync } from 'node:fs';
+import findUp from 'find-up';
+import parseGitignore from 'parse-gitignore';
+
+const getGitignore = () => {
+  const found = findUp.sync('.gitignore');
+  if (found != null) {
+    return parseGitignore.parse(readFileSync(found)).patterns;
+  }
+
+  return [];
+};
+
+const config: eslint.Linter.Config = {
+  ignorePatterns: [
+    '!.*',
+    '.yarn',
+    '.common/',
+    '.config/package-lock.json',
+    '.config/yarn.lock',
+    '.go/',
+    '.modules/',
+    '.pnpm-store/',
+    '.venv/',
+    'deprecated/',
+    'angular.json',
+    'esbuild.js',
+    'package-lock.json',
+    'pnpm-lock.yaml',
+    'slim.report.json',
+    'test-output/',
+    'venv/',
+    'yarn.lock',
+    '_generated_/',
+    '*.toml',
+    ...getGitignore(),
+  ],
+};
+
+export = config;

package/src/jest.ts

@@ -0,0 +1,61 @@
+import { ESLintConfig } from '@w5s/dev';
+import type eslint from 'eslint';
+
+const config: eslint.Linter.Config = ESLintConfig.concat(
+  {
+    env: {
+      'jest/globals': true,
+    },
+    extends: ['plugin:jest/recommended'],
+    globals: {
+      context: true,
+    },
+    plugins: ['jest'],
+    rules: {
+      'jest/consistent-test-it': 'error',
+      'jest/expect-expect': 'off', // Disabled because it does not handle functions that does the expect
+      'jest/no-alias-methods': 'error',
+      'jest/prefer-spy-on': 'error',
+      'jest/prefer-to-contain': 'error',
+      'jest/valid-title': ['error', { ignoreTypeOfDescribeName: true }],
+    },
+    settings: {
+      jest: {
+        // Compatibility with mocha, cypress, etc.
+        globalAliases: {
+          describe: ['context'],
+          fdescribe: ['fcontext'],
+          xdescribe: ['xcontext'],
+        },
+
+        version: 'latest',
+      },
+    },
+  },
+  /**
+   * Unicorn less strict to help writing tests
+   */
+  {
+    rules: {
+      'unicorn/consistent-function-scoping': 'off',
+      'unicorn/no-useless-undefined': 'off',
+      'unicorn/prefer-module': 'off',
+    },
+  },
+  /**
+   * Typescript config is set to be less strict because we often have "hack", "mock" in tests
+   */
+  {
+    rules: {
+      '@typescript-eslint/naming-convention': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/restrict-template-expressions': 'off',
+      '@typescript-eslint/unbound-method': 'off',
+    },
+  }
+);
+export = config;

package/src/jsonc.ts

@@ -0,0 +1,187 @@
+/* cspell:disable */
+import type eslint from 'eslint';
+
+// https://github.com/keithamus/sort-package-json/blob/master/defaultRules.md
+
+const config: eslint.Linter.Config = {
+  extends: ['plugin:jsonc/recommended-with-jsonc', 'plugin:jsonc/prettier'],
+  overrides: [
+    {
+      files: ['tsconfig*.json'],
+      rules: {
+        'jsonc/sort-keys': [
+          'error',
+          {
+            order: ['$schema', 'display', 'extends', 'compilerOptions', 'include', 'exclude', 'files', 'references'],
+            pathPattern: '^$',
+          },
+          {
+            order: { type: 'asc' },
+            pathPattern: '.*',
+          },
+        ],
+      },
+    },
+    {
+      files: ['package.json'],
+      rules: {
+        'jsonc/sort-keys': [
+          'error',
+          {
+            order: [
+              '$schema',
+              'name',
+              'displayName',
+              'version',
+              'private',
+              'description',
+              'categories',
+              'keywords',
+              'homepage',
+              'bugs',
+              'repository',
+              'funding',
+              'license',
+              'qna',
+              'author',
+              'maintainers', // Key order (per item): name, email, url
+              'contributors', // Key order (per item): name, email, url
+              'publisher',
+              'sideEffects',
+              'type',
+              'imports',
+              'exports',
+              'main',
+              'svelte',
+              'umd:main',
+              'jsdelivr',
+              'unpkg',
+              'module',
+              'source',
+              'jsnext:main',
+              'browser',
+              'react-native',
+              'types',
+              'typesVersions',
+              'typings',
+              'style',
+              'example',
+              'examplestyle',
+              'assets',
+              'bin',
+              'man',
+              'directories', // Key order: lib, bin, man, doc, example, test
+              'files', // Unique items
+              'workspaces',
+              'binary', //	Key order: module_name, module_path, remote_path, package_name, host
+              'scripts', // Script sort
+              'betterScripts', // Script sort
+              'contributes',
+              'activationEvents', // Unique items
+              'husky', //	Sorts the hooks field using git hook sort
+              'simple-git-hooks', // Key sort using git hook sort
+              'pre-commit',
+              'commitlint',
+              'lint-staged',
+              'config',
+              'nodemonConfig',
+              'browserify',
+              'babel',
+              'browserslist',
+              'xo',
+              'prettier', // Prettier sort
+              'eslintConfig', // ESLint sort
+              'eslintIgnore',
+              'npmpackagejsonlint', // Key sort (also recognizes: npmPackageJsonLintConfig, npmpkgjsonlint)
+              'release',
+              'remarkConfig',
+              'stylelint',
+              'ava',
+              'jest',
+              'mocha',
+              'nyc',
+              'tap',
+              'resolutions',
+              'dependencies',
+              'devDependencies',
+              'dependenciesMeta', //	Key sort (deep)
+              'peerDependencies',
+              'peerDependenciesMeta', //	Key sort (deep)
+              'optionalDependencies',
+              'bundledDependencies',
+              'bundleDependencies',
+              'extensionPack',
+              'extensionDependencies',
+              'flat',
+              'packageManager',
+              'engines',
+              'engineStrict',
+              'volta', //	Key order: node, npm, yarn
+              'languageName',
+              'os',
+              'cpu',
+              'preferGlobal',
+              'publishConfig',
+              'icon',
+              'badges', //	Key order (per item): description, url, href
+              'galleryBanner',
+              'preview',
+              'markdown',
+            ],
+            pathPattern: '^$',
+          },
+          {
+            order: ['url', 'email'],
+            pathPattern: `^bugs$`,
+          },
+          ...['repository', 'funding', 'license', 'author'].map((key) => ({
+            order: ['type', 'name', 'email', 'url'],
+            pathPattern: `^${key}$`,
+          })),
+          ...['scripts', 'betterScripts'].map((key) => ({
+            order: { type: 'asc' },
+            pathPattern: `^${key}$`,
+          })),
+          ...[
+            'bin',
+            'contributes',
+            'commitlint',
+            'config',
+            'nodemonConfig',
+            'browserify',
+            'babel',
+            'xo',
+            'release',
+            'remarkConfig',
+            'ava',
+            'jest',
+            'mocha',
+            'nyc',
+            'tap',
+            'resolutions',
+            'engines',
+            'engineStrict',
+            'preferGlobal',
+            'publishConfig',
+            'galleryBanner',
+          ].map((key) => ({
+            order: { type: 'asc' },
+            pathPattern: `^${key}$`,
+          })),
+          {
+            order: { type: 'asc' },
+            pathPattern: '^(?:dev|peer|optional|bundled|extension)?[Dd]ependencies$',
+          },
+          {
+            order: ['types', 'require', 'import'],
+            pathPattern: '^exports.*$',
+          },
+        ],
+      },
+    },
+  ],
+  parser: 'jsonc-eslint-parser',
+  plugins: ['jsonc'],
+};
+
+export = config;

package/src/prettier.ts

@@ -0,0 +1,47 @@
+/* eslint-disable global-require */
+/* eslint-disable import/no-dynamic-require */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+import type eslint from 'eslint';
+import type * as prettier from 'prettier';
+
+const getPackageScope = (): string | undefined => {
+  try {
+    const { name } = require('../package.json') as { name?: string };
+    const prefixMatch = (name ?? '').match(/(@\w+)\//);
+    const packageScope = prefixMatch == null ? undefined : prefixMatch[1];
+    return packageScope;
+  } catch (error_: unknown) {
+    // eslint-disable-next-line no-console
+    console.warn(error_);
+
+    return undefined;
+  }
+};
+const getPrettierConfig = (moduleName: string): prettier.Config | undefined => {
+  try {
+    const moduleConfig = require(moduleName);
+    return moduleConfig as prettier.Config | undefined;
+  } catch {
+    return undefined;
+  }
+};
+
+// Try require '@my-organization/prettier-config'
+const getPrettierConfigDefault = () => {
+  const defaultConfig: prettier.Config = {
+    trailingComma: 'es5',
+  };
+  const packageScope = getPackageScope();
+  return (packageScope == null ? undefined : getPrettierConfig(`${packageScope}/prettier-config`)) ?? defaultConfig;
+};
+
+const config: eslint.Linter.Config = {
+  extends: ['prettier'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': ['error', getPrettierConfigDefault()],
+  },
+};
+export = config;