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

package/README.md

@@ -1,17 +1,17 @@
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=# W5s ESLint configuration _(${name})_) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=# W5s ESLint configuration _(${name})_) -->
 # W5s ESLint configuration _(@w5s/eslint-config)_
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 [![NPM Version][package-version-svg]][package-url]
 [![License][license-image]][license-url]
 
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=> ${description}&unknownTxt= ) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=> ${description}&unknownTxt= ) -->
 > ESLint configuration presets
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 ## Installation
 
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=```console\nnpm install --save-dev ${name}\n```) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=```console\nnpm install --save-dev ${name}\n```) -->
 ```console
 npm install --save-dev @w5s/eslint-config
 ```
@@ -67,19 +67,19 @@ For most kind of project, just edit `eslintrc.json` and cherry pick only configu
 - `@w5s/eslint-config/ts`: for typescript files
 
 ## License
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[${license}][license-url] © ${author}) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[${license}][license-url] © ${author}) -->
 [MIT][license-url] © Julien Polo <julien.polo@gmail.com>
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 <!-- VARIABLES -->
 
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
 [package-version-svg]: https://img.shields.io/npm/v/@w5s/eslint-config.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
 [package-url]: https://www.npmjs.com/package/@w5s/eslint-config
 <!-- AUTO-GENERATED-CONTENT:END -->
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
 [license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
 [license-url]: ../../LICENSE

package/es.js

@@ -1,23 +1,4 @@
 // http://eslint.org/docs/user-guide/configuring
 module.exports = {
-  extends: [
-    require.resolve('./rules/base'),
-    require.resolve('./rules/jsdoc'),
-    require.resolve('./rules/import'),
-    require.resolve('./rules/unicorn'),
-    'prettier',
-    require.resolve('./rules/prettier'),
-  ],
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    babelOptions: {
-      plugins: ['@babel/plugin-syntax-class-properties', '@babel/plugin-syntax-jsx'],
-    },
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 2020,
-    requireConfigFile: false,
-    sourceType: 'module',
-  },
+  extends: [require.resolve('./lib/es.js'), require.resolve('./lib/prettier.js')],
 };

package/ignore.js

@@ -0,0 +1 @@
+module.exports = require('./lib/ignore.js');

package/index.js

@@ -1,19 +1,33 @@
 // http://eslint.org/docs/user-guide/configuring
+/**
+ * @param {string} name
+ */
+function tryResolve(name) {
+  try {
+    require.resolve(name);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * @template T
+ * @param {boolean} condition
+ * @param {() => T} getValue
+ */
+function includeIf(condition, getValue) {
+  return condition ? [getValue()] : [];
+}
+
 module.exports = {
-  extends: [require.resolve('./es'), require.resolve('./react'), require.resolve('./json')],
-  overrides: [
-    {
-      extends: [require.resolve('./ts')],
-      files: ['*.+(ts|tsx)'],
-    },
-    {
-      extends: [require.resolve('./jest')],
-      files: [
-        '**/__mocks__/**/*.+(ts|tsx|js|jsx)',
-        '**/__tests__/**/*.+(ts|tsx|js|jsx)',
-        '**/?(*.)+(spec|test).+(ts|tsx|js|jsx)',
-      ],
-    },
+  extends: [
+    require.resolve('./ignore.js'),
+    require.resolve('./es.js'),
+    ...includeIf(tryResolve('typescript'), () => require.resolve('./ts.js')),
+    require.resolve('./json.js'),
+    require.resolve('./yml.js'),
+    require.resolve('./jest.js'),
   ],
   root: true,
 };

package/jest.js

@@ -1,4 +1,17 @@
-// http://eslint.org/docs/user-guide/configuring
+// eslint-disable-next-line import/no-unresolved
+const { EXTENSIONS_WITHOUT_DOT } = require('@w5s/dev');
+
+const extensions = EXTENSIONS_WITHOUT_DOT.join('|');
+
 module.exports = {
-  extends: [require.resolve('./rules/jest')],
+  overrides: [
+    {
+      extends: [require.resolve('./lib/jest.js')],
+      files: [
+        `**/__mocks__/**/*.+(${extensions})`,
+        `**/__tests__/**/*.+(${extensions})`,
+        `**/?(*.)+(spec|test).+(${extensions})`,
+      ],
+    },
+  ],
 };

package/json.js

@@ -1,8 +1,10 @@
+/* cspell:disable */
+// https://github.com/keithamus/sort-package-json/blob/master/defaultRules.md
 module.exports = {
-  plugins: ['json-format'],
-  settings: {
-    'json/ignore-files': ['**/package-lock.json'],
-    'json/json-with-comments-files': ['**/tsconfig.json', '.vscode/**'],
-    'json/sort-package-json': 'standard',
-  },
+  overrides: [
+    {
+      extends: [require.resolve('./lib/jsonc.js')],
+      files: ['*.json', '*.json5', '*.jsonc'],
+    },
+  ],
 };

package/lib/_rule.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function fixme(_status: Linter.RuleLevel | [Linter.RuleLevel, ...any[]] | undefined): "off";

package/lib/_rule.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixme = void 0;
+function fixme(_status) {
+    return 'off';
+}
+exports.fixme = fixme;

package/lib/es/base.d.ts

@@ -0,0 +1,4 @@
+import type eslint from 'eslint';
+import '@rushstack/eslint-patch/modern-module-resolution.js';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es/base.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dev_1 = require("@w5s/dev");
+// Fix eslint shareable config (https://github.com/eslint/eslint/issues/3458)
+// @ts-ignore No typing available
+require("@rushstack/eslint-patch/modern-module-resolution.js");
+// @ts-ignore No typing available
+const best_practices_1 = __importDefault(require("eslint-config-airbnb-base/rules/best-practices"));
+// @ts-ignore No typing available
+const errors_1 = __importDefault(require("eslint-config-airbnb-base/rules/errors"));
+// @ts-ignore No typing available
+const es6_1 = __importDefault(require("eslint-config-airbnb-base/rules/es6"));
+// @ts-ignore No typing available
+const node_1 = __importDefault(require("eslint-config-airbnb-base/rules/node"));
+// @ts-ignore No typing available
+const strict_1 = __importDefault(require("eslint-config-airbnb-base/rules/strict"));
+// @ts-ignore No typing available
+const style_1 = __importDefault(require("eslint-config-airbnb-base/rules/style"));
+// @ts-ignore No typing available
+const variables_1 = __importDefault(require("eslint-config-airbnb-base/rules/variables"));
+const baseConfig = dev_1.ESLintConfig.concat(best_practices_1.default, errors_1.default, es6_1.default, node_1.default, strict_1.default, style_1.default, variables_1.default);
+const config = dev_1.ESLintConfig.concat(baseConfig, 
+// overrides
+{
+    env: {
+        [`es${dev_1.ECMA_VERSION}`]: true,
+    },
+    globals: {
+        __DEV__: 'readonly',
+        __PROD__: 'readonly',
+        __TEST__: 'readonly',
+    },
+    parser: 'espree',
+    parserOptions: {
+        ecmaFeatures: {
+            jsx: true,
+        },
+        ecmaVersion: dev_1.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 }],
+    },
+});
+module.exports = config;

package/lib/es/import.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es/import.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dev_1 = require("@w5s/dev");
+// @ts-ignore airbnb is not typed
+const imports_1 = __importDefault(require("eslint-config-airbnb-base/rules/imports"));
+const _rule_js_1 = require("../_rule.js");
+// @see https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
+const config = dev_1.ESLintConfig.concat(imports_1.default, 
+// Overrides
+{
+    rules: {
+        'import/extensions': [
+            'error',
+            'ignorePackages',
+            {
+            // js: 'never',
+            // jsx: 'never',
+            // mjs: 'never',
+            },
+        ],
+        'import/no-deprecated': 'off',
+        'import/no-extraneous-dependencies': [
+            'error',
+            {
+                ...imports_1.default.rules['import/no-extraneous-dependencies'][1],
+                devDependencies: [
+                    ...imports_1.default.rules['import/no-extraneous-dependencies'][1].devDependencies,
+                    '**/*.config.[jt]s?(x)',
+                    '**/*.config.cjs',
+                ],
+            },
+        ],
+        'import/no-named-as-default': 'off',
+        'import/no-unused-modules': 'off',
+        'import/prefer-default-export': 'off',
+        'import/unambiguous': (0, _rule_js_1.fixme)('off'), // Disable because proposal still in progress
+    },
+    settings: {
+        'import/extensions': dev_1.EXTENSIONS,
+        // Resolve type definition packages
+        'import/external-module-folders': ['node_modules', 'node_modules/@types'],
+        'import/ignore': [...dev_1.IGNORE_LIST, dev_1.EXTENSIONS_RESOURCES_REGEX],
+        // Apply special parsing for TypeScript files
+        'import/parsers': {
+            '@typescript-eslint/parser': dev_1.EXTENSIONS.filter((ext) => !ext.includes('js')),
+        },
+        // Append 'ts' extensions to Airbnb 'import/resolver' setting
+        'import/resolver': {
+            node: {
+                extensions: [...dev_1.EXTENSIONS, '.json'],
+            },
+        },
+    },
+});
+module.exports = config;

package/lib/es/jsdoc.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es/jsdoc.js

@@ -0,0 +1,20 @@
+"use strict";
+const config = {
+    extends: ['plugin:jsdoc/recommended'],
+    plugins: ['jsdoc'],
+    rules: {
+        'jsdoc/no-undefined-types': 'off',
+        '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',
+        strict: ['error', 'safe'],
+    },
+    settings: {
+        jsdoc: {
+            mode: 'typescript',
+        },
+    },
+};
+module.exports = config;

package/lib/es/promise.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es/promise.js

@@ -0,0 +1,12 @@
+"use strict";
+const dev_1 = require("@w5s/dev");
+const _rule_js_1 = require("../_rule.js");
+const config = dev_1.ESLintConfig.concat({
+    extends: ['plugin:promise/recommended'],
+    plugins: ['promise'],
+    rules: {
+        'promise/prefer-await-to-callbacks': (0, _rule_js_1.fixme)('error'),
+        'promise/prefer-await-to-then': 'error',
+    },
+});
+module.exports = config;

package/lib/es/unicorn.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es/unicorn.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dev_1 = require("@w5s/dev");
+// @ts-ignore unicorn config is not typed
+const recommended_js_1 = __importDefault(require("eslint-plugin-unicorn/configs/recommended.js"));
+const config = dev_1.ESLintConfig.concat(recommended_js_1.default, {
+    // 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',
+        'unicorn/new-for-builtins': 'off',
+        'unicorn/no-abusive-eslint-disable': 'error',
+        'unicorn/no-array-instanceof': 'error',
+        'unicorn/no-console-spaces': 'off',
+        'unicorn/no-fn-reference-in-iterator': 'off',
+        'unicorn/no-for-loop': 'error',
+        'unicorn/no-hex-escape': 'error',
+        'unicorn/no-new-buffer': 'error',
+        'unicorn/no-null': 'off',
+        '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',
+        'unicorn/no-array-callback-reference': 'off',
+        'unicorn/no-array-for-each': 'off',
+        'unicorn/no-array-method-this-argument': 'off',
+        'unicorn/no-array-reduce': 'off',
+        '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 !!
+    },
+});
+module.exports = config;

package/lib/es.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/es.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dev_1 = require("@w5s/dev");
+const base_js_1 = __importDefault(require("./es/base.js"));
+const promise_js_1 = __importDefault(require("./es/promise.js"));
+const jsdoc_js_1 = __importDefault(require("./es/jsdoc.js"));
+const import_js_1 = __importDefault(require("./es/import.js"));
+const unicorn_js_1 = __importDefault(require("./es/unicorn.js"));
+// import prettierConfig from './prettier.js';
+const config = dev_1.ESLintConfig.concat(base_js_1.default, promise_js_1.default, jsdoc_js_1.default, import_js_1.default, unicorn_js_1.default
+// prettierConfig
+);
+module.exports = config;

package/lib/ignore.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/ignore.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const node_fs_1 = require("node:fs");
+const find_up_1 = __importDefault(require("find-up"));
+const parse_gitignore_1 = __importDefault(require("parse-gitignore"));
+const getGitignore = () => {
+    const found = find_up_1.default.sync('.gitignore');
+    if (found != null) {
+        return parse_gitignore_1.default.parse((0, node_fs_1.readFileSync)(found)).patterns;
+    }
+    return [];
+};
+const 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(),
+    ],
+};
+module.exports = config;

package/lib/jest.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/jest.js

@@ -0,0 +1,57 @@
+"use strict";
+const dev_1 = require("@w5s/dev");
+const config = dev_1.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',
+        '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',
+    },
+});
+module.exports = config;

package/lib/jsonc.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;