@thermarthae/eslint-config 0.0.0-experimental.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 thermarthae
+
+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,44 @@
+# @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@npm:eslint-plugin-i@latest 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@npm:eslint-plugin-i@latest 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.js

@@ -0,0 +1,6 @@
+import shared from './shared.js';
+
+/** @type {typeof import('typescript-eslint').configs.all} */
+export default [
+	...shared,
+];

package/index.js

@@ -0,0 +1,89 @@
+import react from 'eslint-plugin-react';
+// @ts-expect-error no types :/
+import reactHooks from 'eslint-plugin-react-hooks';
+import stylistic from '@stylistic/eslint-plugin';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+
+import shared from './shared.js';
+
+const stylisticCustomizedWithJSX = stylistic.configs.customize({
+	flat: true,
+	indent: 'tab',
+	semi: true,
+	jsx: true,
+	braceStyle: '1tbs',
+	quoteProps: 'as-needed',
+});
+
+const jsxStylisticRules = Object.fromEntries(Object.entries(stylisticCustomizedWithJSX.rules ?? {})
+	.filter(r => r[0].startsWith('@stylistic/jsx')));
+
+/** @type {typeof import('typescript-eslint').configs.all} */
+const main = [
+	...shared,
+	//
+	// react
+	//
+	// react.configs.flat.recommended,
+	// react.configs.flat['jsx-runtime'],
+	// TODO: wait for a types fix
+	/** @type {typeof import('typescript-eslint').configs.base} */ (react.configs.flat.recommended),
+	/** @type {typeof import('typescript-eslint').configs.base} */ (react.configs.flat['jsx-runtime']),
+	{
+		settings: {
+			react: {
+				version: 'detect',
+			},
+		},
+		rules: {
+			'react/react-in-jsx-scope': 0,
+			'react/no-unknown-property': 0,
+			'react/no-children-prop': 0,
+			'react/prop-types': 0,
+			'react/jsx-boolean-value': ['error', 'never', { always: [] }],
+			'react/void-dom-elements-no-children': 'error',
+			'react/button-has-type': ['error', {
+				button: true,
+				submit: true,
+				reset: false,
+			}],
+			'react/jsx-no-useless-fragment': 'error',
+			'react/jsx-no-constructed-context-values': 'error',
+			'react/no-unstable-nested-components': 'error',
+		},
+	},
+	//
+	// react-hooks
+	//
+	// TODO: wait for a native flat support
+	{
+		files: ['**/**/*.{js,ts,jsx,tsx}'],
+		plugins: {
+			'react-hooks': reactHooks,
+		},
+		rules: reactHooks.configs.recommended.rules,
+	},
+	//
+	// jsx-a11y
+	//
+	jsxA11y.flatConfigs.recommended,
+	//
+	// stylistic
+	//
+	{
+		rules: {
+			...jsxStylisticRules,
+			'@stylistic/jsx-closing-bracket-location': ['error', 'line-aligned'],
+			'@stylistic/jsx-curly-brace-presence': ['error', {
+				props: 'never',
+				children: 'never',
+				propElementValues: 'always',
+			}],
+			'@stylistic/jsx-curly-spacing': ['error', 'never', { allowMultiline: true }],
+			'@stylistic/jsx-self-closing-comp': 'error',
+			'@stylistic/jsx-props-no-multi-spaces': 'error',
+		},
+	},
+];
+
+export default main;

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@thermarthae/eslint-config",
+  "version": "0.0.0-experimental.1",
+  "main": "index.js",
+  "description": "Just a personal eslint config",
+  "type": "module",
+  "license": "MIT",
+  "author": "thermarthae <thermarthae@protonmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thermarthae/eslint-config.git"
+  },
+  "files": [
+    "base.js",
+    "index.js",
+    "shared.js"
+  ],
+  "packageManager": "yarn@4.5.1+sha512.341db9396b6e289fecc30cd7ab3af65060e05ebff4b3b47547b278b9e67b08f485ecd8c79006b405446262142c7a38154445ef7f17c1d5d1de7d90bf9ce7054d",
+  "scripts": {
+    "pnpify": "yarn dlx @yarnpkg/sdks vscode"
+  },
+  "dependencies": {
+    "@stylistic/eslint-plugin": "^2.9.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "typescript-eslint": "^8.11.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.13.0",
+    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.7.8",
+    "eslint": "^9.13.0",
+    "eslint-plugin-jsx-a11y": "^6.10.1",
+    "eslint-plugin-react": "^7.37.1",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "eslint": "^9.13.0",
+    "eslint-plugin-jsx-a11y": "^6.10.1",
+    "eslint-plugin-react": "^7.37.1",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "typescript": "^5.6.3"
+  },
+  "peerDependenciesMeta": {
+    "eslint-plugin-jsx-a11y": {
+      "optional": true
+    },
+    "eslint-plugin-react": {
+      "optional": true
+    },
+    "eslint-plugin-react-hooks": {
+      "optional": true
+    }
+  }
+}

package/shared.js

@@ -0,0 +1,134 @@
+import eslint from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import tsEslint from 'typescript-eslint';
+
+const stylisticCustomized = stylistic.configs.customize({
+	flat: true,
+	indent: 'tab',
+	semi: true,
+	jsx: false,
+	braceStyle: '1tbs',
+	quoteProps: 'as-needed',
+});
+
+/** @type {typeof import('typescript-eslint').configs.all} */
+const shared = [
+	//
+	// eslint
+	//
+	eslint.configs.recommended,
+	{
+		rules: {
+			'object-shorthand': ['error', 'always', { avoidQuotes: true }],
+			'no-param-reassign': ['error', {
+				ignorePropertyModificationsFor: [
+					'request',
+					'reply',
+					'session',
+					'state',
+				],
+				props: true,
+			}],
+			'no-void': ['error', { allowAsStatement: true }],
+			yoda: ['error', 'never', { exceptRange: true }],
+		},
+	},
+	//
+	// typescript-eslint
+	//
+	...tsEslint.configs.recommendedTypeChecked,
+	...tsEslint.configs.stylisticTypeChecked,
+	{
+		...tsEslint.configs.disableTypeChecked,
+		files: ['*.cjs', '*.js'],
+	},
+	{
+		languageOptions: {
+			parserOptions: {
+				projectService: true,
+				ecmaVersion: 'latest',
+			},
+		},
+		rules: {
+			'@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',
+		},
+	},
+	//
+	// stylistic
+	//
+	stylistic.configs['disable-legacy'],
+	// TODO: why rules are overwritten
+	// stylisticCustomized
+	{
+		...stylisticCustomized,
+		rules: {
+			...stylisticCustomized.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,
+		},
+	},
+	//
+	// simple-import-sort
+	//
+	{
+		plugins: {
+			'simple-import-sort': simpleImportSort,
+		},
+		rules: {
+			'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/
+						'^\\./(?=.*/)',
+						// ./
+						'^\\./',
+					],
+				],
+			}],
+		},
+	},
+];
+
+export default shared;