@snowyyd/eslint-config 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Matt Turnbull <matt@iamturns.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# 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).
+
+> [!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/n0bodysec/eslint-config-n0bodysec) to ESLint v9.
+>
+> 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
+
+```shell
+npm install --save-dev typescript-eslint
+npm install --save-dev @snowyyd/eslint-config
+```
+
+## ⚙️ Example Config
+
+### 🥝 TypeScript only
+```ts
+// eslint.config.mjs
+
+import configX from '@snowyyd/eslint-config/base';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+	...configX,
+	...tseslint.configs.recommendedTypeChecked,
+	...tseslint.configs.stylisticTypeChecked,
+	{
+		ignores: ['node_modules', 'dist'],
+		languageOptions: {
+			parserOptions: {
+				projectService: true,
+				tsconfigRootDir: import.meta.dirname,
+			},
+		},
+	},
+);
+```
+
+### 🍉 Mixed (JS and TS)
+```ts
+// eslint.config.mjs
+
+import configX from '@snowyyd/eslint-config-x/base';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+	...configX,
+	{
+		ignores: ['node_modules', 'dist'],
+		languageOptions: {
+			parserOptions: {
+				projectService: true,
+				tsconfigRootDir: import.meta.dirname,
+			},
+		},
+	},
+	{
+		files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+		extends: [
+			...tseslint.configs.recommendedTypeChecked,
+			...tseslint.configs.stylisticTypeChecked,
+		],
+	},
+);
+```
+
+## 📝 Changelog
+
+Read the [commits](../../commits) for a comprehensive list of changes.
+
+## 👍 Acknowledgements
+
+- [Airbnb](https://github.com/airbnb) - Base [config](https://github.com/airbnb/javascript).
+- [Matt Turnbull](https://github.com/iamturns) - Base [Airbnb TS](https://github.com/iamturns/eslint-config-airbnb-typescript).
+- [Charlie Laabs](https://github.com/claabs) - Airbnb TS [fork](https://github.com/claabs/eslint-config-airbnb-typescript-x).
+
+## 📜 License
+
+Licensed under [MIT License](LICENSE).

package/base.d.ts

@@ -0,0 +1,3 @@
+import config from 'index.d.ts';
+
+export = config;

package/base.js

@@ -0,0 +1,10 @@
+const { FlatCompat } = require('@eslint/eslintrc');
+const shared = require('./lib/shared');
+const personal = require('./lib/personal');
+const { convertConfigs } = require('./lib/convert-configs');
+
+const compat = new FlatCompat();
+
+const config = convertConfigs([...compat.extends('eslint-config-airbnb-base'), ...shared, ...personal]);
+
+module.exports = config;

package/index.d.ts

@@ -0,0 +1,5 @@
+import type { Linter } from 'eslint';
+
+declare const config: Linter.FlatConfig[];
+
+export = config;

package/index.js

@@ -0,0 +1,21 @@
+const { FlatCompat } = require('@eslint/eslintrc');
+const shared = require('./lib/shared');
+const personal = require('./lib/personal');
+const { convertConfigs } = require('./lib/convert-configs');
+
+const compat = new FlatCompat();
+
+const config = convertConfigs([
+	...compat.extends('eslint-config-airbnb'),
+	...shared,
+	...personal,
+	{
+		rules: {
+			// Append 'tsx' to Airbnb 'react/jsx-filename-extension' rule
+			// Original: ['.jsx']
+			'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
+		},
+	},
+]);
+
+module.exports = config;

package/lib/convert-configs.js

@@ -0,0 +1,47 @@
+const pluginImport = require('eslint-plugin-import-x');
+const stylistic = require('@stylistic/eslint-plugin');
+
+const deprecatedFormattingRules = Object.keys(stylistic.configs['disable-legacy']);
+
+const replacePluginName = (obj) => Object.fromEntries(
+	Object.entries(obj).map(([key, value]) =>
+	{
+		let newKey = key;
+		// Replace deprecated formatting rules with stylistic.
+		if (deprecatedFormattingRules.includes(key))
+		{
+			const ruleName = key.split('/').at(-1);
+			newKey = `@stylistic/${ruleName}`;
+		}
+		// Replace import rules with import-x
+		newKey = newKey.replace('import/', 'import-x/');
+		return [newKey, value];
+	}),
+);
+
+const importXPlugin = pluginImport.flatConfigs.recommended.plugins['import-x'];
+
+const convertConfigs = (configs) =>
+{
+	const newConfigs = configs.map((config) =>
+	{
+		let newConfig = config;
+		if ('plugins' in config && 'import' in config.plugins)
+		{
+			newConfig = Object.assign(newConfig, { plugins: { 'import-x': importXPlugin } });
+			delete newConfig.plugins.import;
+		}
+		if ('settings' in config)
+		{
+			newConfig = Object.assign(newConfig, { settings: replacePluginName(config.settings) });
+		}
+		if ('rules' in config)
+		{
+			newConfig = Object.assign(newConfig, { rules: replacePluginName(config.rules) });
+		}
+		return config;
+	});
+	return newConfigs;
+};
+
+module.exports = { convertConfigs };

package/lib/personal.js

@@ -0,0 +1,83 @@
+const { rules: baseBestPracticesRules } = require('eslint-config-airbnb-base/rules/best-practices');
+
+const baseRules = {
+	'object-curly-newline': ['error', {
+		ObjectExpression: { minProperties: 4, multiline: true, consistent: true },
+		ObjectPattern: { minProperties: 4, multiline: true, consistent: true },
+		ImportDeclaration: 'never',
+		ExportDeclaration: 'never',
+	}],
+	'brace-style': ['error', 'allman', { allowSingleLine: true }],
+	indent: ['error', 'tab', { SwitchCase: 1 }],
+	'no-tabs': ['error', { allowIndentationTabs: true }],
+	'max-len': 'off',
+};
+
+module.exports = [
+	{
+		rules: {
+			'import/no-dynamic-require': 'off',
+			'import/prefer-default-export': 'off',
+
+			'prefer-template': 'off',
+			'prefer-destructuring': 'off',
+			'prefer-arrow-callback': 'off',
+
+			'no-console': 'off',
+			'no-param-reassign': 'off',
+			'no-plusplus': 'off',
+			'no-continue': '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.',
+				},
+				/* {
+					selector: 'ForOfStatement',
+					message: 'iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.',
+				}, */
+				{
+					selector: 'LabeledStatement',
+					message: 'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
+				},
+				{
+					selector: 'WithStatement',
+					message: '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',
+				},
+			],
+
+			// style
+			'object-curly-newline': 'off',
+			'@stylistic/object-curly-newline': baseRules['object-curly-newline'],
+
+			'brace-style': 'off',
+			'@stylistic/brace-style': baseRules['brace-style'],
+
+			indent: 'off',
+			'@stylistic/indent': baseRules.indent,
+
+			'no-tabs': 'off',
+			'@stylistic/no-tabs': baseRules['no-tabs'],
+
+			'max-len': 'off',
+			'@stylistic/max-len': baseRules['max-len'],
+		},
+	},
+	{
+		files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+		rules: {
+			'@typescript-eslint/consistent-type-imports': 'error',
+
+			// https://github.com/iamturns/eslint-config-airbnb-typescript/issues/344
+			'class-methods-use-this': 'off',
+			'@typescript-eslint/class-methods-use-this': [
+				baseBestPracticesRules['class-methods-use-this'][0],
+				{
+					...baseBestPracticesRules['class-methods-use-this'][1],
+				},
+			],
+		},
+	},
+];

package/lib/shared.js

@@ -0,0 +1,219 @@
+const { rules: baseBestPracticesRules } = require('eslint-config-airbnb-base/rules/best-practices');
+const { rules: baseErrorsRules } = require('eslint-config-airbnb-base/rules/errors');
+const { rules: baseES6Rules } = require('eslint-config-airbnb-base/rules/es6');
+const { rules: baseImportsRules } = require('eslint-config-airbnb-base/rules/imports');
+const { rules: baseStyleRules } = require('eslint-config-airbnb-base/rules/style');
+const { rules: baseVariablesRules } = require('eslint-config-airbnb-base/rules/variables');
+const tsEslintPlugin = require('@typescript-eslint/eslint-plugin');
+const parserBase = require('@typescript-eslint/parser');
+const stylistic = require('@stylistic/eslint-plugin');
+const eslintPluginImportX = require('eslint-plugin-import-x');
+
+module.exports = [
+	{
+		languageOptions: {
+			parser: {
+				// ? TODO: This must be only used on TS files
+				meta: parserBase.meta,
+				parseForESLint: parserBase.parseForESLint,
+			},
+			sourceType: 'module',
+		},
+		plugins: {
+			'@typescript-eslint': tsEslintPlugin, // TODO: This must be only used on TS files
+			'@stylistic': stylistic,
+		},
+		settings: {
+			...eslintPluginImportX.flatConfigs.typescript.settings,
+		},
+		rules: {
+			'brace-style': 'off',
+			'@stylistic/brace-style': baseStyleRules['brace-style'],
+
+			// The TypeScript version also adds 3 new options, all of which should be
+			// set to the same value as the base config
+			'comma-dangle': 'off',
+			'@stylistic/comma-dangle': [
+				baseStyleRules['comma-dangle'][0],
+				{
+					...baseStyleRules['comma-dangle'][1],
+					enums: baseStyleRules['comma-dangle'][1].arrays,
+					generics: baseStyleRules['comma-dangle'][1].arrays,
+					tuples: baseStyleRules['comma-dangle'][1].arrays,
+				},
+			],
+
+			'comma-spacing': 'off',
+			'@stylistic/comma-spacing': baseStyleRules['comma-spacing'],
+
+			'func-call-spacing': 'off',
+			'@stylistic/func-call-spacing': baseStyleRules['func-call-spacing'],
+
+			indent: 'off',
+			'@stylistic/indent': baseStyleRules.indent,
+
+			'keyword-spacing': 'off',
+			'@stylistic/keyword-spacing': baseStyleRules['keyword-spacing'],
+
+			'lines-between-class-members': 'off',
+			'@stylistic/lines-between-class-members': baseStyleRules['lines-between-class-members'],
+
+			'no-extra-parens': 'off',
+			'@stylistic/no-extra-parens': baseErrorsRules['no-extra-parens'],
+
+			'no-extra-semi': 'off',
+			'@stylistic/no-extra-semi': baseErrorsRules['no-extra-semi'],
+
+			'space-before-blocks': 'off',
+			'@stylistic/space-before-blocks': baseStyleRules['space-before-blocks'],
+
+			quotes: 'off',
+			'@stylistic/quotes': baseStyleRules.quotes,
+
+			semi: 'off',
+			'@stylistic/semi': baseStyleRules.semi,
+
+			'space-before-function-paren': 'off',
+			'@stylistic/space-before-function-paren': baseStyleRules['space-before-function-paren'],
+
+			'space-infix-ops': 'off',
+			'@stylistic/space-infix-ops': baseStyleRules['space-infix-ops'],
+
+			'object-curly-spacing': 'off',
+			'@stylistic/object-curly-spacing': baseStyleRules['object-curly-spacing'],
+
+			// Append all JS/TS extensions to Airbnb 'import/extensions' rule
+			// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
+			'import/extensions': [
+				baseImportsRules['import/extensions'][0],
+				baseImportsRules['import/extensions'][1],
+				{
+					...baseImportsRules['import/extensions'][2],
+					cjs: 'never',
+					ts: 'never',
+					tsx: 'never',
+					mts: 'never',
+					cts: 'never',
+				},
+			],
+
+			// Append all JS/TS extensions to Airbnb 'import/no-extraneous-dependencies' rule
+			// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+			'import/no-extraneous-dependencies': [
+				baseImportsRules['import/no-extraneous-dependencies'][0],
+				{
+					...baseImportsRules['import/no-extraneous-dependencies'][1],
+					devDependencies: [
+						...baseImportsRules['import/no-extraneous-dependencies'][1].devDependencies.map(
+							(devDep) =>
+							{
+								let newDevDep = devDep;
+								newDevDep = newDevDep.replace(/\.(js$|{js,jsx}$)/g, '.{js,jsx,mjs,cjs,ts,mts,cts}');
+								newDevDep = newDevDep.replace(/{,\.js}$/g, '{,.js,.jsx,.mjs,.cjs,.ts,.mts,.cts}');
+								return newDevDep;
+							},
+							[],
+						),
+						// Add new eslint config file
+						'**/eslint.config.{js,jsx,mjs,cjs,ts,mts,cts}',
+					],
+				},
+			],
+		},
+	},
+	{
+		files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+		rules: {
+			// Rules
+			camelcase: 'off',
+			// The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings. However, the existing `no-underscore-dangle` rule already takes care of this.
+			'@typescript-eslint/naming-convention': [
+				'error',
+				// Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables (23.10)
+				{
+					selector: 'variable',
+					format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+				},
+				// Allow camelCase functions (23.2), and PascalCase functions (23.8)
+				{
+					selector: 'function',
+					format: ['camelCase', 'PascalCase'],
+				},
+				// Airbnb recommends PascalCase for classes (23.3), and although Airbnb does not make TypeScript recommendations, we are assuming this rule would similarly apply to anything "type like", including interfaces, type aliases, and enums
+				{
+					selector: 'typeLike',
+					format: ['PascalCase'],
+				},
+			],
+
+			'default-param-last': 'off',
+			'@typescript-eslint/default-param-last': baseBestPracticesRules['default-param-last'],
+
+			'dot-notation': 'off',
+			'@typescript-eslint/dot-notation': baseBestPracticesRules['dot-notation'],
+
+			'no-array-constructor': 'off',
+			'@typescript-eslint/no-array-constructor': baseStyleRules['no-array-constructor'],
+
+			'no-dupe-class-members': 'off',
+			'@typescript-eslint/no-dupe-class-members': baseES6Rules['no-dupe-class-members'],
+
+			'no-empty-function': 'off',
+			'@typescript-eslint/no-empty-function': baseBestPracticesRules['no-empty-function'],
+
+			'no-implied-eval': 'off',
+			// 'no-new-func': 'off',
+			'@typescript-eslint/no-implied-eval': baseBestPracticesRules['no-implied-eval'],
+
+			'no-loop-func': 'off',
+			'@typescript-eslint/no-loop-func': baseBestPracticesRules['no-loop-func'],
+
+			'no-magic-numbers': 'off',
+			'@typescript-eslint/no-magic-numbers': baseBestPracticesRules['no-magic-numbers'],
+
+			'no-redeclare': 'off',
+			'@typescript-eslint/no-redeclare': baseBestPracticesRules['no-redeclare'],
+
+			'no-shadow': 'off',
+			'@typescript-eslint/no-shadow': baseVariablesRules['no-shadow'],
+
+			'no-throw-literal': 'off',
+			'@typescript-eslint/only-throw-error': baseBestPracticesRules['no-throw-literal'],
+
+			'no-unused-expressions': 'off',
+			'@typescript-eslint/no-unused-expressions': baseBestPracticesRules['no-unused-expressions'],
+
+			'no-unused-vars': 'off',
+			'@typescript-eslint/no-unused-vars': baseVariablesRules['no-unused-vars'],
+
+			'no-use-before-define': 'off',
+			'@typescript-eslint/no-use-before-define': baseVariablesRules['no-use-before-define'],
+
+			'no-useless-constructor': 'off',
+			'@typescript-eslint/no-useless-constructor': baseES6Rules['no-useless-constructor'],
+
+			'require-await': 'off',
+			'@typescript-eslint/require-await': baseBestPracticesRules['require-await'],
+
+			'no-return-await': 'off',
+			'@typescript-eslint/return-await': [
+				baseBestPracticesRules['no-return-await'],
+				'in-try-catch',
+			],
+
+			// The following rules are enabled in Airbnb config, but are already checked (more thoroughly) by the TypeScript compiler
+			// Some of the rules also fail in TypeScript files, for example: https://github.com/typescript-eslint/typescript-eslint/issues/662#issuecomment-507081586
+			// Rules are inspired by: https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended.ts
+			...tsEslintPlugin.configs['eslint-recommended'].overrides.rules,
+
+			// The following rules are enabled in Airbnb config, but are recommended to be disabled within TypeScript projects
+			// See: https://typescript-eslint.io/troubleshooting/typed-linting/performance/#eslint-plugin-import
+			'import/named': 'off',
+			'import/namespace': 'off',
+			'import/default': 'off',
+			'import/no-named-as-default-member': 'off',
+			// Disable `import/no-unresolved`, see README.md for details
+			'import/no-unresolved': 'off',
+		},
+	},
+];

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@snowyyd/eslint-config",
+	"description": "Airbnb's ESLint config with TypeScript support + my personal configs",
+	"version": "1.1.0",
+	"homepage": "https://github.com/snowyyd/eslint-config-x#readme",
+	"repository": "https://github.com/snowyyd/eslint-config-x.git",
+	"bugs": "https://github.com/snowyyd/eslint-config-x/issues",
+	"author": "Snowy <snowyyd0@proton.me>",
+	"license": "MIT",
+	"type": "commonjs",
+	"main": "./index.js",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"default": "./index.js"
+		},
+		"./base": {
+			"types": "./index.d.ts",
+			"default": "./base.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint ."
+	},
+	"devDependencies": {
+		"@types/eslint": "^9.6.1",
+		"@types/node": "^22.7.2",
+		"typescript": "^5.6.2",
+		"typescript-eslint": "^8.7.0"
+	},
+	"dependencies": {
+		"@eslint/eslintrc": "^3.1.0"
+	},
+	"peerDependencies": {
+		"@stylistic/eslint-plugin": "^2.8.0",
+		"@typescript-eslint/eslint-plugin": "^8.7.0",
+		"@typescript-eslint/parser": "^8.7.0",
+		"eslint": "^9.11.1",
+		"eslint-config-airbnb": "^19.0.4",
+		"eslint-config-airbnb-base": "^15.0.0",
+		"eslint-import-resolver-typescript": "^3.6.3",
+		"eslint-plugin-import-x": "^4.3.0"
+	},
+	"peerDependenciesMeta": {
+		"eslint-config-airbnb": {
+			"optional": true
+		}
+	}
+}