@fullstacksjs/eslint-config 10.11.1 → 11.1.0

package/src/modules/tests.js

@@ -0,0 +1,48 @@
+const plugin = require('eslint-plugin-jest-formatting');
+const { globs } = require('../utils/globs');
+const { predicate } = require('../utils/conditions');
+const globals = require('globals');
+
+/**
+ * @param {import('../init').Options} options
+ * @return { import('eslint').Linter.FlatConfig }
+ */
+function tests(options = {}) {
+  return {
+    plugins: { 'jest-formatting': plugin },
+    files: [...globs.test, ...globs.e2e],
+    languageOptions: {
+      globals: globals['shared-node-browser'],
+    },
+    rules: {
+      'jest-formatting/padding-around-after-all-blocks': 'warn',
+      'jest-formatting/padding-around-after-each-blocks': 'warn',
+      'jest-formatting/padding-around-before-all-blocks': 'warn',
+      'jest-formatting/padding-around-before-each-blocks': 'warn',
+      'jest-formatting/padding-around-describe-blocks': 'warn',
+      'jest-formatting/padding-around-test-blocks': 'warn',
+
+      'max-lines-per-function': 'off',
+      'no-sparse-arrays': 'off',
+
+      ...predicate(options.fp, {
+        'functional/no-let': 'off',
+        'functional/no-loop-statements': 'off',
+      }),
+
+      ...predicate(options.react, {
+        'react/jsx-no-constructed-context-values': 'off',
+      }),
+
+      ...predicate(options.typescript, {
+        '@typescript-eslint/method-signature-style': 'off',
+        '@typescript-eslint/no-namespace ': 'off',
+        '@typescript-eslint/unbound-method': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-floating-promises': 'off',
+      }),
+    },
+  };
+}
+
+module.exports = tests;

package/src/modules/typescript.js

@@ -0,0 +1,255 @@
+const { parser, plugin } = require('typescript-eslint');
+const { globs } = require('../utils/globs');
+const namingConvention = require('../utils/naming-convention');
+const { predicate } = require('../utils/conditions');
+
+/**
+ * @param {import('../init').Options} options
+ * @return { import('eslint').Linter.FlatConfig }
+ */
+function typescript(options = {}) {
+  return {
+    files: [globs.ts, globs.tsx],
+    plugins: { '@typescript-eslint': plugin },
+    languageOptions: { parser },
+    rules: {
+      '@typescript-eslint/adjacent-overload-signatures': 'error',
+      '@typescript-eslint/array-type': 'error',
+      '@typescript-eslint/ban-ts-comment': [
+        'error',
+        {
+          'ts-expect-error': 'allow-with-description',
+          'ts-ignore': 'allow-with-description',
+          'ts-nocheck': 'allow-with-description',
+          'ts-check': 'allow-with-description',
+          'minimumDescriptionLength': 3,
+        },
+      ],
+      '@typescript-eslint/ban-tslint-comment': 'off',
+      '@typescript-eslint/ban-types': 'error',
+      '@typescript-eslint/camelcase': 'off',
+      '@typescript-eslint/class-literal-property-style': ['error', 'getters'],
+      '@typescript-eslint/consistent-generic-constructors': ['warn', 'constructor'],
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+      '@typescript-eslint/consistent-type-assertions': 'error',
+      '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+      '@typescript-eslint/consistent-type-imports': [
+        'warn',
+        { prefer: 'type-imports', disallowTypeAnnotations: false, fixStyle: 'separate-type-imports' },
+      ],
+      '@typescript-eslint/default-param-last': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-member-accessibility': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/generic-type-naming': 'off',
+      '@typescript-eslint/init-declarations': 'off',
+      '@typescript-eslint/member-naming': 'off',
+      '@typescript-eslint/member-ordering': 'off',
+      '@typescript-eslint/method-signature-style': ['warn', 'property'],
+      '@typescript-eslint/naming-convention': [
+        'warn',
+        ...namingConvention,
+        ...(options.typescript && options.typescript.projects
+          ? [
+              {
+                selector: 'variable',
+                types: ['boolean'],
+                format: ['PascalCase'],
+                prefix: ['is', 'should', 'has', 'can', 'did', 'will', 'enable', 'loading'],
+              },
+            ]
+          : []),
+      ],
+      '@typescript-eslint/no-array-constructor': 'error',
+      '@typescript-eslint/no-base-to-string': 'off', // false negative
+      '@typescript-eslint/no-confusing-non-null-assertion': 'error',
+      '@typescript-eslint/no-dupe-class-members': 'error',
+      '@typescript-eslint/no-duplicate-enum-values': 'error',
+      '@typescript-eslint/no-dynamic-delete': 'error',
+      '@typescript-eslint/no-empty-function': 'error',
+      '@typescript-eslint/no-empty-interface': 'off', // Annoying with auto-fix on save.
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-extra-non-null-assertion': 'error',
+      '@typescript-eslint/no-extraneous-class': ['warn', { allowWithDecorator: true }],
+      '@typescript-eslint/no-import-type-side-effects': 'warn',
+      '@typescript-eslint/no-inferrable-types': 'off',
+      '@typescript-eslint/no-invalid-this': ['error', { capIsConstructor: false }],
+      '@typescript-eslint/no-invalid-void-type': 'error',
+      '@typescript-eslint/no-loop-func': 'error',
+      '@typescript-eslint/no-loss-of-precision': 'error',
+      '@typescript-eslint/no-magic-numbers': ['off', { ignoreEnums: true }], // Not good enough yet
+      '@typescript-eslint/no-misused-new': 'error',
+      '@typescript-eslint/no-namespace': 'error',
+      '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+      '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-redeclare': ['off', { ignoreDeclarationMerge: true }], // useful in FP.
+      '@typescript-eslint/no-require-imports': 'error',
+      '@typescript-eslint/no-restricted-imports': 'off',
+      '@typescript-eslint/no-shadow': 'error',
+      '@typescript-eslint/no-this-alias': 'error',
+      '@typescript-eslint/no-type-alias': 'off',
+      '@typescript-eslint/no-unnecessary-type-constraint': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-declaration-merging': 'warn',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/no-untyped-public-signature': 'off',
+      '@typescript-eslint/no-unused-expressions': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^([iI]gnore(d)?)|(_+)', args: 'after-used', ignoreRestSiblings: true },
+      ],
+      '@typescript-eslint/no-use-before-define': ['error', { functions: false, classes: true }],
+      '@typescript-eslint/no-useless-constructor': 'error',
+      '@typescript-eslint/no-useless-empty-export': 'warn',
+      '@typescript-eslint/no-var-requires': 'error',
+      '@typescript-eslint/object-curly-spacing': 'warn',
+      '@typescript-eslint/parameter-properties': 'off',
+      '@typescript-eslint/prefer-as-const': 'warn',
+      '@typescript-eslint/prefer-enum-initializers': 'off',
+      '@typescript-eslint/prefer-for-of': 'warn',
+      '@typescript-eslint/prefer-function-type': 'warn',
+      '@typescript-eslint/prefer-literal-enum-member': ['error', { allowBitwiseExpressions: true }],
+      '@typescript-eslint/prefer-namespace-keyword': 'error',
+      '@typescript-eslint/prefer-readonly-parameter-types': [
+        'off',
+        { checkParameterProperties: true, ignoreInferredTypes: false, treatMethodsAsReadonly: true },
+      ], // I'm not sure...
+      '@typescript-eslint/prefer-readonly': 'off',
+      '@typescript-eslint/prefer-readonlysemi': 'off', // Annoying with auto-fix on save.
+      '@typescript-eslint/prefer-ts-expect-error': 'off',
+      '@typescript-eslint/promise-function-async': 'off',
+      '@typescript-eslint/restrict-plus-operands': 'off',
+      '@typescript-eslint/sort-type-constituents': [
+        'warn',
+        {
+          checkIntersections: true,
+          checkUnions: true,
+          groupOrder: [
+            'named',
+            'keyword',
+            'operator',
+            'literal',
+            'function',
+            'import',
+            'conditional',
+            'object',
+            'tuple',
+            'intersection',
+            'union',
+            'nullish',
+          ],
+        },
+      ],
+      '@typescript-eslint/strict-boolean-expressions': 'off', // Annoying
+      '@typescript-eslint/space-before-blocks': 'off',
+
+      '@typescript-eslint/triple-slash-reference': 'error',
+      '@typescript-eslint/typedef': ['error', { parameter: false, arrowParameter: false, variableDeclaration: false }],
+      '@typescript-eslint/unified-signatures': 'error',
+      '@typescript-eslint/key-spacing': 'off',
+
+      ...predicate(options.typescript && options.typescript.projects, {
+        '@typescript-eslint/await-thenable': 'error',
+        '@typescript-eslint/consistent-return': 'off',
+        '@typescript-eslint/consistent-type-exports': 'warn',
+        '@typescript-eslint/dot-notation': [
+          'warn',
+          {
+            allowPrivateClassPropertyAccess: false,
+            allowProtectedClassPropertyAccess: false,
+            allowIndexSignaturePropertyAccess: true,
+          },
+        ],
+        '@typescript-eslint/no-confusing-void-expression': ['off', { ignoreArrowShorthand: true, ignoreVoidOperator: true }], // Annoying and conflict with @typescript-eslint/no-meaningless-void-operator
+        '@typescript-eslint/no-duplicate-type-constituents': 'warn',
+        '@typescript-eslint/no-for-in-array': 'error',
+        '@typescript-eslint/no-implied-eval': 'error',
+        '@typescript-eslint/no-meaningless-void-operator': ['warn', { checkNever: false }],
+        ...predicate(!options.disableExpensiveRules, {
+          '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
+          '@typescript-eslint/no-misused-promises': ['warn', { checksVoidReturn: { attributes: false } }],
+        }),
+        '@typescript-eslint/no-mixed-enums': 'error',
+        '@typescript-eslint/no-redundant-type-constituents': 'warn',
+        '@typescript-eslint/no-throw-literal': ['warn', { allowThrowingUnknown: false }],
+        '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+        '@typescript-eslint/no-unsafe-enum-comparison': 'warn',
+        '@typescript-eslint/no-unnecessary-condition': [
+          'warn',
+          {
+            allowConstantLoopConditions: false,
+            allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false,
+          },
+        ],
+        '@typescript-eslint/no-unnecessary-qualifier': 'error',
+        '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+        '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+        '@typescript-eslint/no-unsafe-unary-minus': 'error',
+        '@typescript-eslint/no-useless-template-literals': 'warn',
+        '@typescript-eslint/non-nullable-type-assertion-style': 'warn',
+        '@typescript-eslint/prefer-includes': 'warn',
+        '@typescript-eslint/prefer-optional-chain': 'warn',
+        '@typescript-eslint/prefer-reduce-type-parameter': 'warn',
+        '@typescript-eslint/prefer-nullish-coalescing': [
+          'warn',
+          {
+            ignoreConditionalTests: false,
+            ignoreTernaryTests: false,
+            ignoreMixedLogicalExpressions: false,
+            allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false,
+          },
+        ],
+        '@typescript-eslint/prefer-regexp-exec': 'warn',
+        '@typescript-eslint/prefer-promise-reject-errors': 'warn',
+        '@typescript-eslint/prefer-return-this-type': 'warn',
+        '@typescript-eslint/prefer-string-starts-ends-with': 'warn',
+        '@typescript-eslint/restrict-template-expressions': [
+          'warn',
+          { allowNumber: true, allowBoolean: false, allowAny: false, allowNullish: false, allowRegExp: false, allowNever: false },
+        ],
+        '@typescript-eslint/require-array-sort-compare': ['error', { ignoreStringArrays: true }],
+        '@typescript-eslint/require-await': 'error',
+        '@typescript-eslint/return-await': 'error',
+        '@typescript-eslint/switch-exhaustiveness-check': 'error',
+        '@typescript-eslint/unbound-method': ['error', { ignoreStatic: true }],
+
+        // collisions
+        'prefer-promise-reject-errors': 'off',
+        'consistent-return': 'off',
+      }),
+
+      // open issues
+      'react/jsx-no-useless-fragment': 'off', // Need useless-fragment for JSX return type
+
+      // Conflicts with @typescript-eslint
+      'import/named': 'off',
+      'import/namespace': 'off',
+      'import/default': 'off',
+      'import/no-named-as-default-member': 'off',
+      'key-spacing': 'off',
+      'camelcase': 'off',
+      'default-param-last': 'off',
+      'init-declarations': 'off',
+      'no-invalid-this': 'off',
+      'no-loop-func': 'off',
+      'no-redeclare': 'off',
+      'no-restricted-imports': 'off',
+      'no-shadow': 'off',
+      'no-unused-vars': 'off',
+      'no-use-before-define': 'off',
+      'no-useless-constructor': 'off',
+      'object-curly-spacing': 'off',
+      'padding-line-between-statements': 'off',
+      'space-before-blocks': 'off',
+      'dot-notation': 'off',
+      'no-throw-literal': 'off',
+      'require-await': 'off',
+    },
+  };
+}
+
+module.exports = typescript;

package/src/modules/vitest.js

@@ -0,0 +1,84 @@
+const plugin = require('eslint-plugin-vitest');
+const { globs } = require('../utils/globs');
+
+/**
+ * @return { import('eslint').Linter.FlatConfig }
+ */
+function vitest() {
+  return {
+    files: globs.test,
+    plugins: { vitest: plugin },
+    languageOptions: {
+      globals: {
+        suite: 'writable',
+        test: 'writable',
+        describe: 'writable',
+        it: 'writable',
+        expect: 'writable',
+        assert: 'writable',
+        vitest: 'writable',
+        vi: 'writable',
+        beforeAll: 'writable',
+        afterAll: 'writable',
+        beforeEach: 'writable',
+        afterEach: 'writable',
+      },
+    },
+    rules: {
+      'vitest/consistent-test-filename': 'off',
+      'vitest/consistent-test-it': 'warn',
+      'vitest/expect-expect': 'warn',
+      'vitest/max-expects': 'off',
+      'vitest/max-nested-describe': 'off',
+      'vitest/no-alias-methods': 'off',
+      'vitest/no-commented-out-tests': 'warn',
+      'vitest/no-conditional-expect': 'warn',
+      'vitest/no-conditional-in-test': 'off',
+      'vitest/no-conditional-tests': 'warn',
+      'vitest/no-disabled-tests': 'warn',
+      'vitest/no-done-callback': 'off',
+      'vitest/no-duplicate-hooks': 'error',
+      'vitest/no-focused-tests': 'warn',
+      'vitest/no-hooks': 'off',
+      'vitest/no-identical-title': 'error',
+      'vitest/no-import-node-test': 'error',
+      'vitest/no-interpolation-in-snapshots': 'warn',
+      'vitest/no-large-snapshots': 'warn',
+      'vitest/no-mocks-import': 'warn',
+      'vitest/no-restricted-matchers': 'warn',
+      'vitest/no-restricted-vi-methods': 'warn',
+      'vitest/no-standalone-expect': 'warn',
+      'vitest/no-test-prefixes': 'warn',
+      'vitest/no-test-return-statement': 'warn',
+      'vitest/prefer-called-with': 'warn',
+      'vitest/prefer-comparison-matcher': 'warn',
+      'vitest/prefer-each': 'warn',
+      'vitest/prefer-equality-matcher': 'warn',
+      'vitest/prefer-expect-assertions': 'off',
+      'vitest/prefer-expect-resolves': 'warn',
+      'vitest/prefer-hooks-in-order': 'warn',
+      'vitest/prefer-hooks-on-top': 'warn',
+      'vitest/prefer-lowercase-title': 'warn',
+      'vitest/prefer-mock-promise-shorthand': 'warn',
+      'vitest/prefer-snapshot-hint': 'warn',
+      'vitest/prefer-spy-on': 'warn',
+      'vitest/prefer-strict-equal': 'warn',
+      'vitest/prefer-to-be': 'warn',
+      'vitest/prefer-to-be-falsy': 'warn',
+      'vitest/prefer-to-be-object': 'warn',
+      'vitest/prefer-to-be-truthy': 'warn',
+      'vitest/prefer-to-contain': 'warn',
+      'vitest/prefer-to-have-length': 'warn',
+      'vitest/prefer-todo': 'warn',
+      'vitest/require-hook': 'warn',
+      'vitest/require-local-test-context-for-concurrent-snapshots': 'warn',
+      'vitest/require-to-throw-message': 'warn',
+      'vitest/require-top-level-describe': 'warn',
+      'vitest/valid-describe-callback': 'warn',
+      'vitest/valid-expect': 'warn',
+      'vitest/valid-title': 'warn',
+    },
+  };
+}
+
+module.exports = vitest;

package/src/utils/conditions.js

@@ -0,0 +1,20 @@
+/**
+ * @param {{strict?: boolean}} options
+ * @param {import('eslint').Linter.RuleEntry} config
+ * @returns {import('eslint').Linter.RuleEntry}
+ */
+const strictRule = (options, config) => {
+  return options.strict ? config : 'off';
+};
+
+/**
+ * @param {boolean} options
+ * @param {import('eslint').Linter.RulesRecord} config
+ * @returns {import('eslint').Linter.RulesRecord | undefined}
+ */
+const predicate = (condition, config) => {
+  return condition ? config : undefined;
+};
+
+module.exports.strict = strictRule;
+module.exports.predicate = predicate;

package/src/utils/globs.js

@@ -0,0 +1,40 @@
+const srcExt = '?([cm])[jt]s?(x)';
+
+const globs = {
+  src: `**/*.${srcExt}`,
+  js: '**/*.?([cm])js',
+  jsx: '**/*.?([cm])jsx',
+  ts: '**/*.?([cm])ts',
+  tsx: '**/*.?([cm])tsx',
+
+  style: '**/*.{css,less,scss}',
+  css: '**/*.css',
+  postcss: '**/*.postcss',
+  less: '**/*.less',
+  scss: '**/*.scss',
+
+  json: '**/*.json',
+  json5: '**/*.json5',
+  jsonc: '**/*.jsonc',
+  allJson: '**/*.json?([c5])',
+
+  md: '**/*.md',
+  svelte: '**/*.svelte',
+  vue: '**/*.vue',
+  yaml: '**/*.{yml,yaml}',
+  toml: '**/*.toml',
+  xml: '**/*.xml',
+  html: '**/*.html',
+  astro: '**/*.astro',
+  graphql: '**/*.{gql,graphql}',
+
+  storybook: ['**/*.stories.{js,jsx,ts,tsx}'],
+
+  test: [`**/__tests__/*.${srcExt}`, `**/*.spec.${srcExt}`, `**/*.test.${srcExt}`],
+  e2e: [`**/e2e/*.${srcExt}`],
+};
+
+const allSrc = [globs.src, globs.style, globs.allJson, globs.md, globs.svelte, globs.vue, globs.yaml, globs.xml, globs.html];
+
+module.exports.globs = globs;
+module.exports.allSrc = allSrc;