@snowyyd/eslint-config 1.2.1 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Matt Turnbull <matt@iamturns.com>
+Copyright (c) snowyyd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,85 +1,95 @@
 # eslint-config-x
 
-An [ESLint](https://eslint.org/) configuration I use in personal JavaScript/TypeScript projects.  
-Based on [Airbnb](https://github.com/airbnb/javascript), and [Airbnb TypeScript](https://github.com/claabs/eslint-config-airbnb-typescript-x).
+
+**eslint-config-x** is a modern, modular ESLint configuration inspired by the widely-used [Airbnb style guide](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base), rewritten entirely using [FlatConfig](https://eslint.org/docs/latest/use/configure/configuration-files) — the new configuration format introduced in ESLint v9.  
+This package offers optional TypeScript support, a handful of well curated extra configurations, as well as a personal config.
+
+
+## ✨ Why use this?
+- 📦 **FlatConfig ready** — designed for ESLint v9+
+- 🧼 **Airbnb base rules** — familiar, community-tested style
+- ✨ **Airbnb-style, modernized** — no more deprecated rules
+- 🧠 **Optional TypeScript support** — no assumptions about your stack
+- 🧩 **Use only what you need** — configurations are exported individually and can be composed freely
+- 🚧 **Includes my very personal config** — for advanced tinkering (not for public use)
+
 
 > [!IMPORTANT]
-> This configuration is not intended to be "stable" or for "public use", especially since my JavaScript standards are not widely used (e.g., brace style).  
-> There are still changes I need to make to properly migrate my [old config](https://github.com/snowyyd/eslint-config-n0bodysec) to ESLint v9.
+> #### Looking for a more faithful Airbnb FlatConfig conversion?
+> If you landed here expecting a closer 1:1 conversion of the original `eslint-config-airbnb-base` (including legacy or deprecated rules), this config may not be what you're looking for — it makes modernizing decisions and drops outdated patterns.
 >
-> If for some reason you came to this repository looking for an implementation more faithful to Airbnb standards, I recommend one of the following alternatives:
-> 1. https://github.com/claabs/eslint-config-airbnb-typescript-x
-> 2. https://github.com/Kenneth-Sills/eslint-config-airbnb-typescript
-
-## 🚀 Usage
+> Instead, check out these alternatives:
+>
+> - https://github.com/claabs/eslint-config-airbnb-typescript-x
+> - https://github.com/Kenneth-Sills/eslint-config-airbnb-typescript
+> - The `v1` branch of this repository is based on the @claabs's implementation (this repository was a fork).
 
-```shell
-npm install --save-dev typescript-eslint
-npm install --save-dev @snowyyd/eslint-config
-```
 
-## ⚙️ Example Config
+## 🚀 Quick Start
 
 > [!TIP]
-> Example TypeScript project: https://github.com/snowyyd/typescript-template
+> Please verify that your package manager correctly installs the “peerDependencies”.
 
-### 🥝 TypeScript only
-```ts
-// eslint.config.mjs
+1. First, install eslint if it's not yet installed (locally or globally).
+```bash
+npm install -save-dev eslint
+```
+
+2. Then, install the package as a development dependency.
+```bash
+npm install --save-dev @snowyyd/eslint-config
+```
 
-import configX from '@snowyyd/eslint-config/esm'; // or /base for CommonJS
+3. Create an ESLint config file `eslint.config.mjs` in the root folder of your project. You can use the following as an example:
+```js
+// @ts-check
+
+/* eslint-disable import-x/no-extraneous-dependencies */
+import { configs } from '@snowyyd/eslint-config';
 import tseslint from 'typescript-eslint';
 
 export default tseslint.config(
-	...configX,
-	...tseslint.configs.recommendedTypeChecked,
-	...tseslint.configs.stylisticTypeChecked,
+	configs.recommended,
+	configs.esm,
 	{
 		ignores: ['dist/**'],
 		languageOptions: {
 			parserOptions: {
-				projectService: {
-					// add other config files below (e.g.: tsup.config.ts)
-					allowDefaultProject: ['eslint.config.mjs'],
-				},
+				projectService: true,
 				tsconfigRootDir: import.meta.dirname,
 			},
 		},
 	},
 );
+```
 
+
+## 🍉 Exported presets
+Each preset is conveniently exported in a “configs” object, as well as part of the default export.
+```typescript
+import { configs } from '@snowyyd/eslint-config';
+import configX from '@snowyyd/eslint-config'; // access configs on configsX.configs
 ```
 
-### 🍉 Mixed (JS and TS)
-```ts
-// eslint.config.mjs
+The list of presets includes:
+- `recommended`: The main preset for this project. It includes all the Airbnb rules, as well as the recommended eslint, typescript-eslint, recommended typed linting and stylistic presets.
+- `esm`: Extra rules for ESM projects.
+- `airbnb`: Airbnb configuration exported for convenience, without any additions (only with updated rules).
+- `airbnbTs`: The Airbnb configuration with fully TypeScript support.
+- `personal`: My personal rules that I usually apply over the Airbnb ones.
+- `typescript`: The recommended typescript-eslint rules (with typed linting and stylistic type linting).
 
-import configX from '@snowyyd/eslint-config/esm';
-import tseslint from 'typescript-eslint';
+The `recommended` preset extends the rules in the following order: `airbnbTs > eslint-recommended > typescript > personal`.  
+TypeScript rules are only used in compatible files, so this configuration is perfectly safe for JavaScript projects.
+
+In the `recommended` preset my personal rules takes precedence over the recommended ones. Likewise, those rules take priority over the Airbnb ones. This means that Airbnb settings serve as a base, the recommended settings build on top of them, and finally my personal preferences are applied last.
+
+> [!NOTE]
+> Please note that some presets expect to be loaded after others.  
+> For example, `personal` expects that `airbnbTs` and `typescript` were loaded earlier.
+>
+> While the presets are independent, the rules themselves may not make sense separately.
 
-export default tseslint.config(
-	...configX,
-	{
-		ignores: ['dist/**'],
-		languageOptions: {
-			parserOptions: {
-				projectService: {
-					// add other config files below (e.g.: tsup.config.ts)
-					allowDefaultProject: ['eslint.config.mjs'],
-				},
-				tsconfigRootDir: import.meta.dirname,
-			},
-		},
-	},
-	{
-		files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
-		extends: [
-			...tseslint.configs.recommendedTypeChecked,
-			...tseslint.configs.stylisticTypeChecked,
-		],
-	},
-);
-```
 
 ## 📝 Changelog
 

package/dist/airbnb-base.d.ts

@@ -0,0 +1,3 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+declare const _default: (plugin: FlatConfig.Plugin, parser: FlatConfig.Parser) => FlatConfig.ConfigArray;
+export default _default;

package/dist/airbnb-base.js

@@ -0,0 +1,34 @@
+import stylistic from '@stylistic/eslint-plugin';
+import importX from 'eslint-plugin-import-x';
+import bestPractices from "./rules/airbnb-base/best-practices.js";
+import errors from "./rules/airbnb-base/errors.js";
+import es6 from "./rules/airbnb-base/es6.js";
+import imports from "./rules/airbnb-base/imports.js";
+import node from "./rules/airbnb-base/node.js";
+import strict from "./rules/airbnb-base/strict.js";
+import style from "./rules/airbnb-base/style.js";
+import variables from "./rules/airbnb-base/variables.js";
+// based on https://github.com/airbnb/javascript/commit/11f986fdc7d6b4c80e396437e9c45c939362bdee
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default (plugin, parser) => [
+    {
+        name: '@snowyyd/eslint-config-x/airbnb-base',
+        plugins: {
+            // '@typescript-eslint': plugin,
+            '@stylistic': stylistic,
+            'import-x': importX,
+        },
+        languageOptions: {
+            ecmaVersion: 2018,
+            sourceType: 'module',
+        },
+    },
+    bestPractices,
+    errors,
+    node,
+    style,
+    variables,
+    es6,
+    imports,
+    strict,
+];

package/dist/airbnb-ts.d.ts

@@ -0,0 +1,3 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+declare const _default: (plugin: FlatConfig.Plugin, parser: FlatConfig.Parser) => FlatConfig.ConfigArray;
+export default _default;

package/dist/airbnb-ts.js

@@ -0,0 +1,47 @@
+import airbnbBase from "./airbnb-base.js";
+import bestPractices from "./rules/airbnb-base/best-practices.js";
+import es6 from "./rules/airbnb-base/es6.js";
+import style from "./rules/airbnb-base/style.js";
+import variables from "./rules/airbnb-base/variables.js";
+function replaceRule(ruleName, baseConfig, newName) {
+    if (!baseConfig.rules || !(ruleName in (baseConfig.rules))) {
+        throw new Error('invalid rule data for ' + ruleName);
+    }
+    return {
+        [ruleName]: 'off',
+        [`@typescript-eslint/${newName ?? ruleName}`]: baseConfig.rules[ruleName],
+    };
+}
+export default (plugin, parser) => [
+    ...airbnbBase(plugin, parser),
+    {
+        name: '@snowyyd/eslint-config-x/airbnb-ts',
+        files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+        rules: {
+            ...replaceRule('class-methods-use-this', bestPractices),
+            ...replaceRule('consistent-return', bestPractices),
+            ...replaceRule('default-param-last', bestPractices),
+            ...replaceRule('dot-notation', bestPractices),
+            ...replaceRule('no-empty-function', bestPractices),
+            ...replaceRule('no-implied-eval', bestPractices),
+            // ...replaceRule('no-invalid-this', bestPractices),
+            ...replaceRule('no-loop-func', bestPractices),
+            // ...replaceRule('no-magic-numbers', bestPractices),
+            ...replaceRule('no-redeclare', bestPractices),
+            ...replaceRule('no-throw-literal', bestPractices, 'only-throw-error'),
+            ...replaceRule('no-unused-expressions', bestPractices),
+            ...replaceRule('prefer-promise-reject-errors', bestPractices),
+            // ...replaceRule('require-await', bestPractices),
+            // ...replaceRule('max-params', style),
+            ...replaceRule('no-array-constructor', style),
+            ...replaceRule('init-declarations', variables),
+            ...replaceRule('no-shadow', variables),
+            ...replaceRule('no-unused-vars', variables),
+            ...replaceRule('no-use-before-define', variables),
+            ...replaceRule('no-dupe-class-members', es6),
+            // ...replaceRule('no-restricted-imports', es6),
+            ...replaceRule('no-useless-constructor', es6),
+            ...replaceRule('prefer-destructuring', es6),
+        },
+    },
+];

package/dist/esm.d.ts

@@ -0,0 +1,3 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+declare const _default: (plugin: FlatConfig.Plugin, parser: FlatConfig.Parser) => FlatConfig.ConfigArray;
+export default _default;

package/dist/esm.js

@@ -0,0 +1,27 @@
+import importX from 'eslint-plugin-import-x';
+import shared from "./rules/personal/shared.js";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default (plugin, parser) => [
+    {
+        name: '@snowyyd/eslint-config-x/esm',
+        plugins: {
+            'import-x': importX,
+        },
+        rules: {
+            // extensions are mandatory in ESM
+            'import-x/extensions': ['error', 'ignorePackages'],
+            'no-restricted-globals': [
+                ...shared.rules['no-restricted-globals'],
+                // __dirname & __filename cannot be used in ESM
+                {
+                    name: '__dirname',
+                    message: 'Not available in ES modules. Use `import.meta.dirname` instead. https://nodejs.org/api/esm.html#no-__filename-or-__dirname',
+                },
+                {
+                    name: '__filename',
+                    message: 'Not available in ES modules. Use `import.meta.filename` instead. https://nodejs.org/api/esm.html#no-__filename-or-__dirname',
+                },
+            ],
+        },
+    },
+];

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export declare const configs: {
+    recommended: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    esm: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    airbnb: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    airbnbTs: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    personal: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    typescript: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+};
+declare const _default: {
+    configs: {
+        recommended: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        esm: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        airbnb: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        airbnbTs: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        personal: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        typescript: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    };
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,18 @@
+import tseslint from 'typescript-eslint';
+import airbnbBase from "./airbnb-base.js";
+import airbnbTs from "./airbnb-ts.js";
+import esm from "./esm.js";
+import personal from "./personal.js";
+import recommended from "./recommended.js";
+import typescript from "./typescript.js";
+export const configs = {
+    recommended: recommended(tseslint.plugin, tseslint.parser),
+    esm: esm(tseslint.plugin, tseslint.parser),
+    airbnb: airbnbBase(tseslint.plugin, tseslint.parser),
+    airbnbTs: airbnbTs(tseslint.plugin, tseslint.parser),
+    personal: personal(tseslint.plugin, tseslint.parser),
+    typescript: typescript(tseslint.plugin, tseslint.parser),
+};
+export default {
+    configs,
+};

package/dist/personal.d.ts

@@ -0,0 +1,3 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+declare const _default: (plugin: FlatConfig.Plugin, parser: FlatConfig.Parser) => FlatConfig.ConfigArray;
+export default _default;

package/dist/personal.js

@@ -0,0 +1,74 @@
+import stylistic from '@stylistic/eslint-plugin';
+import importX from 'eslint-plugin-import-x';
+import shared from "./rules/personal/shared.js";
+export default (plugin, parser) => [
+    {
+        name: '@snowyyd/eslint-config-x/personal',
+        languageOptions: {
+            parser,
+            parserOptions: {
+                projectService: true,
+                // tsconfigRootDir: import.meta.dirname,
+            },
+        },
+        plugins: {
+            '@typescript-eslint': plugin,
+            '@stylistic': stylistic,
+            'import-x': importX,
+        },
+        rules: {
+            /**
+             * imports
+             */
+            'import-x/no-dynamic-require': 'off',
+            'import-x/prefer-default-export': 'off',
+            /**
+             * best practices
+             */
+            // no longer needed: https://eslint.org/docs/latest/rules/no-return-await
+            // TODO: check https://typescript-eslint.io/rules/return-await/
+            'no-return-await': 'off',
+            'prefer-template': 'off',
+            'prefer-destructuring': 'off',
+            'prefer-arrow-callback': 'off',
+            'prefer-const': ['error', {
+                    destructuring: 'any',
+                    // this is needed as `no-use-before-define` is used in airbnb/variables and is overwritten in tseslint
+                    // https://github.com/typescript-eslint/typescript-eslint/blob/af94f163a1d6447a84c5571fff5e38e4c700edb9/packages/eslint-plugin/src/configs/eslint-recommended-raw.ts#L42
+                    ignoreReadBeforeAssign: true, // this is needed
+                }],
+            'no-console': 'off',
+            'no-param-reassign': 'off',
+            'no-plusplus': 'off',
+            'no-continue': 'off',
+            'no-restricted-globals': shared.rules['no-restricted-globals'],
+            'no-restricted-properties': 'off',
+            'no-restricted-syntax': [
+                'error',
+                {
+                    selector: 'ForInStatement',
+                    message: 'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
+                },
+            ],
+            /**
+             * styling & formatting
+             */
+            '@stylistic/object-curly-newline': ['error', {
+                    ObjectExpression: { minProperties: 4, multiline: true, consistent: true },
+                    ObjectPattern: { minProperties: 4, multiline: true, consistent: true },
+                    ImportDeclaration: 'never',
+                    ExportDeclaration: 'never',
+                }],
+            '@stylistic/brace-style': ['error', 'allman', { allowSingleLine: true }],
+            '@stylistic/indent': ['error', 'tab', { SwitchCase: 1 }],
+            '@stylistic/no-tabs': ['error', { allowIndentationTabs: true }],
+            '@stylistic/max-len': 'off',
+            '@stylistic/quotes': ['error', 'single', { avoidEscape: true }],
+            '@stylistic/comma-dangle': ['error', 'always-multiline'],
+            // TypeScript
+            '@stylistic/type-annotation-spacing': 'error',
+            '@stylistic/type-generic-spacing': 'error',
+            '@stylistic/member-delimiter-style': 'error',
+        },
+    },
+];

package/dist/recommended.d.ts

@@ -0,0 +1,3 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+declare const _default: (plugin: FlatConfig.Plugin, parser: FlatConfig.Parser) => FlatConfig.ConfigArray;
+export default _default;

package/dist/recommended.js

@@ -0,0 +1,16 @@
+import eslint from '@eslint/js';
+import airbnbTs from "./airbnb-ts.js";
+import personal from "./personal.js";
+import typescript from "./typescript.js";
+export default (plugin, parser) => [
+    ...airbnbTs(plugin, parser),
+    // recommended JavaScript
+    {
+        name: 'eslint/eslint-recommended',
+        ...eslint.configs.recommended,
+    },
+    // recommended TypeScript (might depend on eslint-recommended)
+    ...typescript(plugin, parser),
+    // personal configs
+    ...personal(plugin, parser),
+];

package/dist/rules/airbnb-base/best-practices.d.ts

@@ -0,0 +1,175 @@
+declare const _default: {
+    name: string;
+    rules: {
+        'accessor-pairs': "off";
+        'array-callback-return': ["error", {
+            allowImplicit: boolean;
+        }];
+        'block-scoped-var': "error";
+        complexity: ["off", number];
+        'class-methods-use-this': ["error", {
+            exceptMethods: never[];
+        }];
+        'consistent-return': "error";
+        curly: ["error", string];
+        'default-case': ["error", {
+            commentPattern: string;
+        }];
+        'default-case-last': "error";
+        'default-param-last': "error";
+        'dot-notation': ["error", {
+            allowKeywords: boolean;
+        }];
+        '@stylistic/dot-location': ["error", string];
+        eqeqeq: ["error", string, {
+            null: string;
+        }];
+        'grouped-accessor-pairs': "error";
+        'guard-for-in': "error";
+        'max-classes-per-file': ["error", number];
+        'no-alert': "warn";
+        'no-caller': "error";
+        'no-case-declarations': "error";
+        'no-constructor-return': "error";
+        'no-div-regex': "off";
+        'no-else-return': ["error", {
+            allowElseIf: boolean;
+        }];
+        'no-empty-function': ["error", {
+            allow: string[];
+        }];
+        'no-empty-pattern': "error";
+        'no-empty-static-block': "off";
+        'no-eq-null': "off";
+        'no-eval': "error";
+        'no-extend-native': "error";
+        'no-extra-bind': "error";
+        'no-extra-label': "error";
+        'no-fallthrough': "error";
+        '@stylistic/no-floating-decimal': "error";
+        'no-global-assign': ["error", {
+            exceptions: never[];
+        }];
+        'no-implicit-coercion': ["off", {
+            boolean: boolean;
+            number: boolean;
+            string: boolean;
+            allow: never[];
+        }];
+        'no-implicit-globals': "off";
+        'no-implied-eval': "error";
+        'no-invalid-this': "off";
+        'no-iterator': "error";
+        'no-labels': ["error", {
+            allowLoop: boolean;
+            allowSwitch: boolean;
+        }];
+        'no-lone-blocks': "error";
+        'no-loop-func': "error";
+        'no-magic-numbers': ["off", {
+            ignore: never[];
+            ignoreArrayIndexes: boolean;
+            enforceConst: boolean;
+            detectObjects: boolean;
+        }];
+        '@stylistic/no-multi-spaces': ["error", {
+            ignoreEOLComments: boolean;
+        }];
+        'no-multi-str': "error";
+        'no-new': "error";
+        'no-new-func': "error";
+        'no-new-wrappers': "error";
+        'no-nonoctal-decimal-escape': "error";
+        'no-object-constructor': "error";
+        'no-octal': "error";
+        'no-octal-escape': "error";
+        'no-param-reassign': ["error", {
+            props: boolean;
+            ignorePropertyModificationsFor: string[];
+        }];
+        'no-proto': "error";
+        'no-redeclare': "error";
+        'no-restricted-properties': ["error", {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }, {
+            property: string;
+            message: string;
+        }, {
+            property: string;
+            message: string;
+        }, {
+            object: string;
+            property: string;
+            message: string;
+        }];
+        'no-return-assign': ["error", string];
+        'no-script-url': "error";
+        'no-self-assign': ["error", {
+            props: boolean;
+        }];
+        'no-self-compare': "error";
+        'no-sequences': "error";
+        'no-throw-literal': "error";
+        'no-unmodified-loop-condition': "off";
+        'no-unused-expressions': ["error", {
+            allowShortCircuit: boolean;
+            allowTernary: boolean;
+            allowTaggedTemplates: boolean;
+        }];
+        'no-unused-labels': "error";
+        'no-useless-call': "off";
+        'no-useless-catch': "error";
+        'no-useless-concat': "error";
+        'no-useless-escape': "error";
+        'no-useless-return': "error";
+        'no-void': "error";
+        'no-warning-comments': ["off", {
+            terms: string[];
+            location: string;
+        }];
+        'no-with': "error";
+        'prefer-promise-reject-errors': ["error", {
+            allowEmptyReject: boolean;
+        }];
+        'prefer-named-capture-group': "off";
+        'prefer-object-has-own': "off";
+        'prefer-regex-literals': ["error", {
+            disallowRedundantWrapping: boolean;
+        }];
+        radix: "error";
+        'require-await': "off";
+        'require-unicode-regexp': "off";
+        'vars-on-top': "error";
+        '@stylistic/wrap-iife': ["error", string, {
+            functionPrototypeMethods: boolean;
+        }];
+        yoda: "error";
+    };
+};
+export default _default;