@thermarthae/eslint-config 1.0.0 → 3.0.0

package/README.md

@@ -1,44 +1,44 @@
-# @thermarthae/eslint-config
-
-Just a personalized [Airbnb](https://www.npmjs.com/package/eslint-config-airbnb) Eslint config.
-
-## ✨ Setup
-
-### 1) Install
-
-This step assumes that you have already installed Eslint and Typescript.
-
-```bash
-yarn add -D @thermarthae/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks
-```
-
-If you don't need React support:
-
-```bash
-yarn add -D @thermarthae/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import
-```
-
-### 2) Configure ESLint
-
-Add `"extends": "@thermarthae/eslint-config"` to your ESLint config file.
-
-An example `.eslintrc.js`:
-
-```js
-module.exports = {
-	// If you don't need React support:
-	// extends: ['@thermarthae/eslint-config/base'],
-	extends: ['@thermarthae/eslint-config'],
-};
-```
-
-**Note**: If your `tsconfig.json` is not in the same directory as `package.json`, you will have to set the path yourself:
-
-```diff
-	module.exports = {
-		extends: ['@thermarthae/eslint-config'],
-+		parserOptions: {
-+			project: './foo/bar/tsconfig.json',
-+		},
-	};
-```
+# @thermarthae/eslint-config
+
+Just an Eslint config.
+
+## ✨ Setup
+
+### 1) Install
+
+This step assumes that you have already installed Eslint and Typescript.
+
+```bash
+yarn add -D @thermarthae/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-simple-import-sort @stylistic/eslint-plugin
+```
+
+If you don't need React support:
+
+```bash
+yarn add -D @thermarthae/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import eslint-plugin-simple-import-sort @stylistic/eslint-plugin
+```
+
+### 2) Configure ESLint
+
+Add `"extends": "@thermarthae/eslint-config"` to your ESLint config file.
+
+An example `.eslintrc.cjs`:
+
+```js
+module.exports = {
+	// If you don't need React support:
+	// extends: ['@thermarthae/eslint-config/base.cjs'],
+	extends: ['@thermarthae/eslint-config'],
+};
+```
+
+**Note**: If your `tsconfig.json` is not in the same directory as `package.json`, you will have to set the path yourself:
+
+```diff
+	module.exports = {
+		extends: ['@thermarthae/eslint-config'],
++		parserOptions: {
++			project: './foo/bar/tsconfig.json',
++		},
+	};
+```

package/base.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+	extends: [
+		'./shared.cjs',
+	],
+};

package/index.cjs

@@ -0,0 +1,55 @@
+module.exports = {
+	extends: [
+		'./shared.cjs',
+		'plugin:react/recommended',
+		'plugin:react/jsx-runtime',
+		'plugin:react-hooks/recommended',
+		'plugin:jsx-a11y/recommended',
+	],
+	plugins: ['jsx-a11y'],
+	settings: {
+		react: {
+			version: 'detect',
+		},
+	},
+	rules: {
+		'react/no-unknown-property': 0,
+		'react/no-children-prop': 0,
+		'react/prop-types': 0,
+		'react/jsx-boolean-value': ['error', 'never', { always: [] }],
+		'react/jsx-closing-bracket-location': ['error', 'line-aligned'],
+		'react/jsx-closing-tag-location': 'error',
+		'react/jsx-curly-spacing': ['error', 'never', { allowMultiline: true }],
+		'react/jsx-max-props-per-line': ['error', { maximum: 1, when: 'multiline' }],
+		'react/self-closing-comp': 'error',
+		'react/jsx-wrap-multilines': ['error', {
+			declaration: 'parens-new-line',
+			assignment: 'parens-new-line',
+			return: 'parens-new-line',
+			arrow: 'parens-new-line',
+			condition: 'parens-new-line',
+			logical: 'parens-new-line',
+			prop: 'parens-new-line',
+		}],
+		'react/jsx-first-prop-new-line': 'error',
+		'react/jsx-tag-spacing': ['error', {
+			closingSlash: 'never',
+			beforeSelfClosing: 'always',
+			afterOpening: 'never',
+			beforeClosing: 'never',
+		}],
+		'react/void-dom-elements-no-children': 'error',
+		'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never', propElementValues: 'always' }],
+		'react/jsx-one-expression-per-line': ['error', { allow: 'single-child' }],
+		'react/button-has-type': ['error', {
+			button: true,
+			submit: true,
+			reset: false,
+		}],
+		'react/jsx-props-no-multi-spaces': 'error',
+		'react/jsx-curly-newline': 'error',
+		'react/jsx-no-useless-fragment': 'error',
+		'react/jsx-no-constructed-context-values': 'error',
+		'react/no-unstable-nested-components': 'error',
+	},
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thermarthae/eslint-config",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "3.0.0",
+  "main": "index.cjs",
   "description": "Just a personal eslint config",
   "license": "MIT",
   "author": "thermarthae <thermarthae@protonmail.com>",
@@ -10,38 +10,42 @@
     "url": "git+https://github.com/thermarthae/eslint-config.git"
   },
   "files": [
-    "base.js",
-    "index.js",
-    "shared.js"
+    "base.cjs",
+    "index.cjs",
+    "shared.cjs"
   ],
-  "packageManager": "yarn@3.0.2",
+  "packageManager": "yarn@4.1.0+sha256.81a00df816059803e6b5148acf03ce313cad36b7f6e5af6efa040a15981a6ffb",
   "scripts": {
-    "update": "yarn set version latest",
     "pnpify": "yarn dlx @yarnpkg/sdks vscode"
   },
-  "dependencies": {
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-airbnb-typescript": "^14.0.0"
+  "resolutions": {
+    "@stylistic/eslint-plugin-plus/@typescript-eslint/utils": "^7.1.0",
+    "@stylistic/eslint-plugin-ts/@typescript-eslint/utils": "^7.1.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.30.0",
-    "@typescript-eslint/parser": "^4.30.0",
-    "eslint": "^7.32.0",
-    "eslint-plugin-import": "^2.24.2",
-    "typescript": "^4.4.2"
+    "@stylistic/eslint-plugin": "^1.6.2",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "typescript": "^5.3.3"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.30.0",
-    "@typescript-eslint/parser": "^4.30.0",
-    "eslint": "^7.32.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-react": "^7.25.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "typescript": "^4.4.2"
+    "@stylistic/eslint-plugin": "^1.6.2",
+    "@typescript-eslint/parser": "^6.20.0 || ^7.1.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "typescript": "^5.3.3"
   },
   "peerDependenciesMeta": {
+    "eslint-config-prettier": {
+      "optional": true
+    },
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },

package/shared.cjs

@@ -0,0 +1,118 @@
+const stylistic = require('@stylistic/eslint-plugin');
+
+const customized = stylistic.configs.customize({
+	indent: 'tab',
+	semi: true,
+	jsx: false,
+	braceStyle: '1tbs',
+	quoteProps: 'as-needed',
+});
+
+module.exports = {
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended-type-checked',
+		'plugin:@typescript-eslint/stylistic-type-checked',
+		'plugin:@stylistic/disable-legacy',
+	],
+	plugins: [
+		'@typescript-eslint',
+		'import',
+		'simple-import-sort',
+		'@stylistic',
+	],
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: true,
+		sourceType: 'module',
+	},
+	overrides: [
+		{
+			files: ['*.cjs'],
+			env: {
+				node: true,
+			},
+		},
+		{
+			files: ['*.cjs', '*.js'],
+			rules: {
+				'@typescript-eslint/ban-ts-comment': 0,
+				'@typescript-eslint/no-unsafe-assignment': 0,
+				'@typescript-eslint/no-unsafe-call': 0,
+				'@typescript-eslint/no-unsafe-member-access': 0,
+				'@typescript-eslint/no-var-requires': 0,
+			},
+		},
+	],
+	rules: {
+		...customized.rules,
+		'@stylistic/arrow-parens': ['error', 'as-needed', {
+			requireForBlockBody: true,
+		}],
+		'@stylistic/linebreak-style': ['error', 'windows'],
+		'@stylistic/max-len': ['error', { code: 120 }],
+		'@stylistic/no-multiple-empty-lines': ['error', {
+			max: 3,
+			maxBOF: 0,
+			maxEOF: 1,
+		}],
+		'@stylistic/max-statements-per-line': 0,
+		'@stylistic/indent-binary-ops': 0,
+		//
+		'@typescript-eslint/array-type': ['error', {
+			default: 'array-simple',
+		}],
+		'@typescript-eslint/consistent-type-assertions': ['error', {
+			assertionStyle: 'as',
+			objectLiteralTypeAssertions: 'allow-as-parameter',
+		}],
+		'@typescript-eslint/consistent-type-definitions': 0,
+		'@typescript-eslint/no-unused-vars': 0,
+		'@typescript-eslint/no-empty-function': 0,
+		'@typescript-eslint/no-misused-promises': ['error', {
+			checksVoidReturn: false,
+		}],
+		'@typescript-eslint/no-unnecessary-type-arguments': 'warn',
+		'@typescript-eslint/no-shadow': 'error',
+		'@typescript-eslint/promise-function-async': 'error',
+		//
+		'simple-import-sort/imports': ['warn', {
+			groups: [
+				// Side effect imports.
+				['^\\u0000'],
+				[
+					'^node:',
+					'react',
+					// Things that start with a letter (or digit or underscore), or `@` followed by a letter.
+					'^@?\\w',
+				],
+				// Absolute imports and other imports such as Vue-style `@/foo`.
+				['^'],
+				[
+					// ../whatever/
+					'^\\.\\./(?=.*/)',
+					// ../
+					'^\\.\\./',
+				],
+				[
+					// ./whatever/
+					'^\\./(?=.*/)',
+					// ./
+					'^\\./',
+				],
+			],
+		}],
+		//
+		'no-param-reassign': ['error', {
+			ignorePropertyModificationsFor: [
+				'request',
+				'reply',
+				'session',
+				'state',
+			],
+			props: true,
+		}],
+		'no-void': ['error', { allowAsStatement: true }],
+		yoda: ['error', 'never', { exceptRange: true }],
+	},
+};

package/base.js

@@ -1,7 +0,0 @@
-module.exports = {
-	extends: [
-		'airbnb-base',
-		'airbnb-typescript/base',
-		'./shared.js',
-	],
-};

package/index.js

@@ -1,28 +0,0 @@
-module.exports = {
-	extends: [
-		'airbnb',
-		'airbnb-typescript',
-		'airbnb/hooks',
-		'./shared.js',
-	],
-	overrides: [
-		{
-			files: '*.tsx',
-			rules: {
-				'@typescript-eslint/member-ordering': 0, // `react/sort-comp` is handling this out
-				'consistent-return': 0, // annoys inside react hooks
-			},
-		},
-	],
-	rules: {
-		'react/destructuring-assignment': 0,
-		'react/jsx-indent': ['error', 'tab'],
-		'react/jsx-indent-props': ['error', 'tab'],
-		'react/jsx-props-no-spreading': 0,
-		'react/no-children-prop': 0,
-		'react/prop-types': 0,
-		'react/require-default-props': 0,
-		'react/state-in-constructor': ['error', 'never'],
-		'react/static-property-placement': ['error', 'static public field'],
-	},
-};

package/shared.js

@@ -1,87 +0,0 @@
-module.exports = {
-	extends: [
-		'plugin:@typescript-eslint/recommended',
-		'plugin:@typescript-eslint/recommended-requiring-type-checking',
-	],
-	parserOptions: {
-		ecmaVersion: 2021,
-		project: 'tsconfig.json',
-		warnOnUnsupportedTypeScriptVersion: false,
-	},
-	overrides: [
-		{
-			files: '*.js',
-			rules: {
-				'@typescript-eslint/ban-ts-comment': 0,
-				'@typescript-eslint/no-unsafe-assignment': 0,
-				'@typescript-eslint/no-unsafe-call': 0,
-				'@typescript-eslint/no-unsafe-member-access': 0,
-				'@typescript-eslint/no-var-requires': 0,
-			},
-		},
-		{
-			files: '*.d.ts',
-			rules: {
-				'import/prefer-default-export': 0,
-			},
-		},
-	],
-	rules: {
-		'@typescript-eslint/array-type': ['error', {
-			default: 'array-simple',
-		}],
-		'@typescript-eslint/consistent-type-assertions': ['error', {
-			assertionStyle: 'as',
-			objectLiteralTypeAssertions: 'allow-as-parameter',
-		}],
-		'@typescript-eslint/explicit-module-boundary-types': 0,
-		'@typescript-eslint/indent': ['error', 'tab'],
-		'@typescript-eslint/member-delimiter-style': ['error', {
-			multiline: {
-				delimiter: 'semi',
-				requireLast: true,
-			},
-			singleline: {
-				delimiter: 'semi',
-				requireLast: false,
-			},
-		}],
-		'@typescript-eslint/member-ordering': 'error',
-		'@typescript-eslint/no-explicit-any': 0,
-		'@typescript-eslint/no-misused-promises': ['error', {
-			checksVoidReturn: false,
-		}],
-		'@typescript-eslint/no-non-null-assertion': 0,
-		'@typescript-eslint/no-unnecessary-type-arguments': 'error',
-		'@typescript-eslint/no-unsafe-assignment': 0, // its not very performant
-		'@typescript-eslint/prefer-optional-chain': 'error',
-		'@typescript-eslint/promise-function-async': 'error',
-		'arrow-parens': ['error', 'as-needed', {
-			requireForBlockBody: true,
-		}],
-		'import/no-cycle': 0,
-		'import/no-named-as-default': 0, // its not very performant
-		'max-len': ['error', { code: 120 }],
-		'no-console': 0,
-		'no-multiple-empty-lines': ['error', {
-			max: 3,
-			maxBOF: 0,
-			maxEOF: 1,
-		}],
-		'no-param-reassign': ['error', {
-			ignorePropertyModificationsFor: [
-				'request',
-				'reply',
-				'session',
-			],
-			props: true,
-		}],
-		'no-tabs': 0,
-		'no-void': ['error', {
-			allowAsStatement: true,
-		}],
-		yoda: ['error', 'never', {
-			exceptRange: true,
-		}],
-	},
-};