@rhyster/eslint-config 1.0.0

package/src/airbnb/variables.ts

@@ -0,0 +1,74 @@
+import confusingBrowserGlobals from 'confusing-browser-globals';
+
+import type { Linter } from 'eslint';
+
+export default {
+    name: '@rhyster/eslint-config/airbnb/variables',
+    rules: {
+        // enforce or disallow variable initializations at definition
+        // https://eslint.org/docs/rules/init-declarations
+        'init-declarations': 'off',
+
+        // disallow deletion of variables
+        // https://eslint.org/docs/rules/no-delete-var
+        'no-delete-var': 'error',
+
+        // disallow labels that share a name with a variable
+        // https://eslint.org/docs/rules/no-label-var
+        'no-label-var': 'error',
+
+        // disallow specific globals
+        // https://eslint.org/docs/rules/no-restricted-globals
+        'no-restricted-globals': [
+            'error',
+            {
+                name: 'isFinite',
+                message:
+                    'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+            },
+            {
+                name: 'isNaN',
+                message:
+                    'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+            },
+            ...confusingBrowserGlobals.map((g) => ({
+                name: g,
+                message: `Use window.${g} instead. https://github.com/facebook/create-react-app/blob/HEAD/packages/confusing-browser-globals/README.md`,
+            })),
+        ],
+
+        // disallow declaration of variables already declared in the outer scope
+        // https://eslint.org/docs/rules/no-shadow
+        'no-shadow': 'error',
+
+        // disallow shadowing of names such as arguments
+        // https://eslint.org/docs/rules/no-shadow-restricted-names
+        'no-shadow-restricted-names': 'error',
+
+        // disallow use of undeclared variables unless mentioned in a /*global */ block
+        // https://eslint.org/docs/rules/no-undef
+        'no-undef': 'error',
+
+        // disallow use of undefined when initializing variables
+        // https://eslint.org/docs/rules/no-undef-init
+        'no-undef-init': 'error',
+
+        // disallow use of undefined variable
+        // https://eslint.org/docs/rules/no-undefined
+        'no-undefined': 'off',
+
+        // disallow declaration of variables that are not used in the code
+        // https://eslint.org/docs/rules/no-unused-vars
+        'no-unused-vars': [
+            'error',
+            { vars: 'all', args: 'after-used', ignoreRestSiblings: true },
+        ],
+
+        // disallow use of variables before they are defined
+        // https://eslint.org/docs/rules/no-use-before-define
+        'no-use-before-define': [
+            'error',
+            { functions: true, classes: true, variables: true },
+        ],
+    },
+} satisfies Linter.Config;

package/src/index.ts

@@ -0,0 +1,111 @@
+import stylistic from '@stylistic/eslint-plugin';
+import importx from 'eslint-plugin-import-x';
+import nodePlugin from 'eslint-plugin-n';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+import bestPractices from './airbnb/best-practices.ts';
+import errors from './airbnb/errors.ts';
+import es6 from './airbnb/es6.ts';
+import imports from './airbnb/imports.ts';
+import nodeRules from './airbnb/node.ts';
+import strict from './airbnb/strict.ts';
+import style from './airbnb/style.ts';
+import variables from './airbnb/variables.ts';
+import typescript from './typescript.ts';
+
+import type { Linter } from 'eslint';
+
+type Config = Linter.Config;
+type Plugin = NonNullable<Config['plugins']>[string];
+type Parser = NonNullable<Config['languageOptions']>['parser'];
+
+const general = {
+    name: '@rhyster/eslint-config/airbnb/general',
+    plugins: {
+        '@typescript-eslint': tseslint.plugin as Plugin,
+        '@stylistic': stylistic as Plugin,
+        'import-x': importx as unknown as Plugin,
+    },
+    languageOptions: {
+        parser: tseslint.parser as Parser,
+        parserOptions: {
+            projectService: true,
+        },
+    },
+    settings: {
+        'import-x/parsers': {
+            espree: [
+                '.js',
+                '.mjs',
+            ],
+            '@typescript-eslint/parser': [
+                '.ts',
+                '.d.ts',
+            ],
+        },
+        'import-x/resolver': {
+            node: {
+                extensions: [
+                    '.mjs',
+                    '.js',
+                    '.json',
+                    '.ts',
+                    '.d.ts',
+                ],
+            },
+        },
+        'import-x/extensions': [
+            '.js',
+            '.mjs',
+            '.ts',
+            '.d.ts',
+        ],
+        'import-x/core-modules': [],
+        'import-x/ignore': [
+            'node_modules', '\\.(coffee|scss|css|less|hbs|svg|json)$',
+        ],
+        'import-x/external-module-folders': [
+            'node_modules',
+            'node_modules/@types',
+        ],
+    },
+} as const satisfies Config;
+
+export const core = [
+    {
+        name: '@rhyster/eslint-config/files-ts',
+        files: ['**/*.ts'],
+    },
+    general,
+    bestPractices,
+    errors,
+    style,
+    variables,
+    es6,
+    imports,
+    strict,
+    typescript,
+] as const satisfies Config[];
+
+export const node = [
+    ...core,
+    {
+        languageOptions: {
+            globals: globals.node,
+        },
+        plugins: {
+            n: nodePlugin,
+        },
+        ...nodeRules,
+    },
+] as const satisfies Config[];
+
+export const browser = [
+    ...core,
+    {
+        languageOptions: {
+            globals: globals.browser,
+        },
+    },
+] as const satisfies Config[];

package/src/typescript.ts

@@ -0,0 +1,90 @@
+import type { Linter } from 'eslint';
+
+export default {
+    name: '@rhyster/eslint-config/typescript',
+    rules: {
+        // https://typescript-eslint.io/rules/naming-convention
+        '@typescript-eslint/naming-convention': 'error',
+        camelcase: 'off',
+
+        // https://typescript-eslint.io/rules/default-param-last
+        '@typescript-eslint/default-param-last': 'error',
+        'default-param-last': 'off',
+
+        // https://typescript-eslint.io/rules/dot-notation
+        '@typescript-eslint/dot-notation': 'error',
+        'dot-notation': 'off',
+
+        // https://typescript-eslint.io/rules/no-array-constructor
+        '@typescript-eslint/no-array-constructor': 'error',
+        'no-array-constructor': 'off',
+
+        // https://typescript-eslint.io/rules/no-empty-function
+        '@typescript-eslint/no-empty-function': 'error',
+        'no-empty-function': 'off',
+
+        // https://typescript-eslint.io/rules/no-implied-eval
+        '@typescript-eslint/no-implied-eval': 'error',
+        'no-implied-eval': 'off',
+        'no-new-func': 'off',
+
+        // https://typescript-eslint.io/rules/no-loop-func
+        '@typescript-eslint/no-loop-func': 'error',
+        'no-loop-func': 'off',
+
+        // https://typescript-eslint.io/rules/no-magic-numbers
+        '@typescript-eslint/no-magic-numbers': 'off',
+        'no-magic-numbers': 'off',
+
+        // https://typescript-eslint.io/rules/no-shadow
+        '@typescript-eslint/no-shadow': 'error',
+        'no-shadow': 'off',
+
+        // https://typescript-eslint.io/rules/only-throw-error
+        '@typescript-eslint/only-throw-error': 'error',
+        'no-throw-literal': 'off',
+
+        // https://typescript-eslint.io/rules/no-unused-expressions
+        '@typescript-eslint/no-unused-expressions': 'error',
+        'no-unused-expressions': 'off',
+
+        // https://typescript-eslint.io/rules/no-unused-vars
+        '@typescript-eslint/no-unused-vars': 'error',
+        'no-unused-vars': 'off',
+
+        // https://typescript-eslint.io/rules/no-use-before-define
+        '@typescript-eslint/no-use-before-define': 'error',
+        'no-use-before-define': 'off',
+
+        // https://typescript-eslint.io/rules/no-useless-constructor
+        '@typescript-eslint/no-useless-constructor': 'error',
+        'no-useless-constructor': 'off',
+
+        // https://typescript-eslint.io/rules/prefer-promise-reject-errors
+        '@typescript-eslint/prefer-promise-reject-errors': 'error',
+        'prefer-promise-reject-errors': 'off',
+
+        // https://typescript-eslint.io/rules/require-await
+        '@typescript-eslint/require-await': 'off',
+        'require-await': 'off',
+
+        // https://typescript-eslint.io/rules/return-await
+        '@typescript-eslint/return-await': ['error', 'in-try-catch'],
+        'no-return-await': 'off',
+
+        // https://typescript-eslint.io/rules/no-dupe-class-members
+        // checked by the TypeScript compiler
+        'no-dupe-class-members': 'off',
+
+        // https://typescript-eslint.io/rules/no-redeclare
+        // checked by the TypeScript compiler
+        'no-redeclare': 'off',
+
+        // https://typescript-eslint.io/troubleshooting/typed-linting/performance/#eslint-plugin-import
+        'import-x/named': 'off',
+        'import-x/namespace': 'off',
+        'import-x/default': 'off',
+        'import-x/no-named-as-default-member': 'off',
+        'import-x/no-unresolved': 'off',
+    },
+} satisfies Linter.Config;