@kembec/eslint-config 1.1.2 → 2.0.0

package/presets/js.js

@@ -0,0 +1,41 @@
+import js from "@eslint/js";
+import prettierConfig from "eslint-config-prettier";
+import importXPlugin from "eslint-plugin-import-x";
+import globals from "globals";
+
+import bestPractices from "../rules/best-practices.js";
+import errors from "../rules/errors.js";
+import { importXRules, pluginInstances, pluginRules } from "../rules/plugins.js";
+import style from "../rules/style.js";
+
+export function buildJsPreset() {
+	return [
+		js.configs.recommended,
+		prettierConfig,
+		{
+			files: ["**/*.{js,jsx,mjs,cjs}"],
+			languageOptions: {
+				ecmaVersion: "latest",
+				sourceType: "module",
+				globals: {
+					...globals.browser,
+					...globals.es2022,
+					...globals.node,
+				},
+			},
+			plugins: {
+				...pluginInstances,
+				"import-x": importXPlugin,
+			},
+			rules: {
+				...bestPractices.rules,
+				...errors.rules,
+				...style.rules,
+				...pluginRules,
+				...importXRules,
+			},
+		},
+	];
+}
+
+export default buildJsPreset();

package/presets/react.js

@@ -0,0 +1,53 @@
+import prettierConfig from "eslint-config-prettier";
+import importXPlugin from "eslint-plugin-import-x";
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+import bestPractices from "../rules/best-practices.js";
+import errors from "../rules/errors.js";
+import { importXRules, pluginInstances, pluginRules } from "../rules/plugins.js";
+import style from "../rules/style.js";
+import typescriptRules from "../rules/typescript.js";
+
+export function buildReactPreset(tsconfigPath = "./tsconfig.json") {
+	return tseslint.config(prettierConfig, ...tseslint.configs.recommendedTypeChecked, {
+		files: ["**/*.{ts,tsx}"],
+		languageOptions: {
+			ecmaVersion: "latest",
+			sourceType: "module",
+			globals: {
+				...globals.browser,
+				...globals.es2022,
+			},
+			parserOptions: {
+				project: tsconfigPath,
+				ecmaFeatures: { jsx: true },
+			},
+		},
+		plugins: {
+			...pluginInstances,
+			"import-x": importXPlugin,
+			react: reactPlugin,
+			"react-hooks": reactHooksPlugin,
+		},
+		settings: {
+			react: { version: "detect" },
+		},
+		rules: {
+			...bestPractices.rules,
+			...errors.rules,
+			...style.rules,
+			...pluginRules,
+			...typescriptRules.rules,
+			...reactPlugin.configs.recommended.rules,
+			...reactHooksPlugin.configs.recommended.rules,
+			"react/react-in-jsx-scope": "off",
+			"react/prop-types": "off",
+			...importXRules,
+		},
+	});
+}
+
+export default buildReactPreset();

package/presets/ts.js

@@ -0,0 +1,43 @@
+import prettierConfig from "eslint-config-prettier";
+import importXPlugin from "eslint-plugin-import-x";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+import bestPractices from "../rules/best-practices.js";
+import errors from "../rules/errors.js";
+import { importXRules, pluginInstances, pluginRules } from "../rules/plugins.js";
+import style from "../rules/style.js";
+import typescriptRules from "../rules/typescript.js";
+
+export function buildTsPreset(tsconfigPath = "./tsconfig.json") {
+	return tseslint.config(prettierConfig, ...tseslint.configs.recommendedTypeChecked, {
+		files: ["**/*.{ts,tsx}"],
+		languageOptions: {
+			ecmaVersion: "latest",
+			sourceType: "module",
+			globals: {
+				...globals.browser,
+				...globals.es2022,
+				...globals.node,
+			},
+			parserOptions: {
+				project: tsconfigPath,
+				ecmaFeatures: { jsx: true },
+			},
+		},
+		plugins: {
+			...pluginInstances,
+			"import-x": importXPlugin,
+		},
+		rules: {
+			...bestPractices.rules,
+			...errors.rules,
+			...style.rules,
+			...pluginRules,
+			...typescriptRules.rules,
+			...importXRules,
+		},
+	});
+}
+
+export default buildTsPreset();

package/presets/vitest.js

@@ -0,0 +1,13 @@
+import vitestPlugin from "@vitest/eslint-plugin";
+
+export default [
+	{
+		files: ["**/*.test.{js,ts,jsx,tsx}", "**/*.spec.{js,ts,jsx,tsx}", "**/__tests__/**/*.{js,ts,jsx,tsx}"],
+		plugins: {
+			vitest: vitestPlugin,
+		},
+		rules: {
+			...vitestPlugin.configs.recommended.rules,
+		},
+	},
+];

package/rules/best-practices.js

@@ -1,9 +1,10 @@
-module.exports = {
+export default {
 	rules: {
 		camelcase: ["error", { properties: "never" }],
-		eqeqeq: "error",
+		eqeqeq: ["error", "always", { null: "ignore" }],
 		"new-cap": ["error", { capIsNew: false }],
 		"no-array-constructor": "error",
+		"no-var": "error",
 		"no-console": ["error", { allow: ["error"] }],
 		"no-else-return": ["error", { allowElseIf: false }],
 		"no-extend-native": "error",

package/rules/errors.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
 	rules: {
 		"array-callback-return": ["error", { checkForEach: true }],
 		"no-await-in-loop": "error",
@@ -6,9 +6,11 @@ module.exports = {
 		"no-constructor-return": "error",
 		"no-promise-executor-return": "error",
 		"no-self-compare": "error",
+		"no-shadow-restricted-names": ["error", { reportGlobalThis: true }],
 		"no-template-curly-in-string": "error",
 		"no-unmodified-loop-condition": "error",
 		"no-unreachable-loop": "error",
+		"no-unused-expressions": ["error", { ignoreDirectives: true }],
 		"no-unused-private-class-members": "error",
 		"no-use-before-define": [
 			"error",

package/rules/plugins.js

@@ -1,47 +1,57 @@
-module.exports = {
-	plugins: ["simple-import-sort", "import", "unused-imports"],
-	rules: {
-		"import/first": "error",
-		"import/newline-after-import": "error",
-		"import/no-duplicates": "error",
-		"import/no-unresolved": "error",
-		"import/no-webpack-loader-syntax": "error",
-		"prettier/prettier": [
-			"error",
-			{
-				arrowParens: "always",
-				bracketSameLine: false,
-				bracketSpacing: true,
-				semi: true,
-				experimentalTernaries: false,
-				singleQuote: false,
-				jsxSingleQuote: false,
-				quoteProps: "as-needed",
-				trailingComma: "es5",
-				singleAttributePerLine: true,
-				htmlWhitespaceSensitivity: "css",
-				vueIndentScriptAndStyle: true,
-				proseWrap: "preserve",
-				insertPragma: false,
-				printWidth: 120,
-				requirePragma: false,
-				tabWidth: 4,
-				useTabs: true,
-				embeddedLanguageFormatting: "auto",
-				endOfLine: "lf",
-			},
-		],
-		"simple-import-sort/exports": "error",
-		"simple-import-sort/imports": "error",
-		"unused-imports/no-unused-imports": "error",
-		"unused-imports/no-unused-vars": [
-			"warn",
-			{
-				vars: "all",
-				varsIgnorePattern: "^_",
-				args: "after-used",
-				argsIgnorePattern: "^_",
-			},
-		],
-	},
+import prettierPlugin from "eslint-plugin-prettier";
+import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
+import unusedImportsPlugin from "eslint-plugin-unused-imports";
+
+export const pluginInstances = {
+	prettier: prettierPlugin,
+	"simple-import-sort": simpleImportSortPlugin,
+	"unused-imports": unusedImportsPlugin,
+};
+
+export const pluginRules = {
+	"prettier/prettier": [
+		"error",
+		{
+			arrowParens: "always",
+			bracketSameLine: false,
+			bracketSpacing: true,
+			semi: true,
+			experimentalTernaries: false,
+			singleQuote: false,
+			jsxSingleQuote: false,
+			quoteProps: "as-needed",
+			trailingComma: "es5",
+			singleAttributePerLine: true,
+			htmlWhitespaceSensitivity: "css",
+			vueIndentScriptAndStyle: true,
+			proseWrap: "preserve",
+			insertPragma: false,
+			printWidth: 120,
+			requirePragma: false,
+			tabWidth: 4,
+			useTabs: true,
+			embeddedLanguageFormatting: "auto",
+			endOfLine: "lf",
+		},
+	],
+	"simple-import-sort/exports": "error",
+	"simple-import-sort/imports": "error",
+	"unused-imports/no-unused-imports": "error",
+	"no-unused-vars": "off",
+	"unused-imports/no-unused-vars": [
+		"warn",
+		{
+			vars: "all",
+			varsIgnorePattern: "^_",
+			args: "after-used",
+			argsIgnorePattern: "^_",
+		},
+	],
+};
+
+export const importXRules = {
+	"import-x/first": "error",
+	"import-x/newline-after-import": "error",
+	"import-x/no-duplicates": "error",
+	"import-x/no-webpack-loader-syntax": "error",
 };

package/rules/style.js

@@ -1,10 +1,7 @@
-module.exports = {
+export default {
 	rules: {
 		curly: "error",
 		"lines-between-class-members": ["error", "always", { exceptAfterSingleLine: true }],
-		"padding-line-between-statements": [
-			"error",
-			{ blankLine: "always", prev: "*", next: "return" },
-		],
+		"padding-line-between-statements": ["error", { blankLine: "always", prev: "*", next: "return" }],
 	},
 };

package/rules/typescript.js

@@ -1,12 +1,10 @@
-module.exports = {
-	plugins: ["@typescript-eslint"],
+export default {
 	rules: {
 		"@typescript-eslint/member-ordering": [
 			"error",
 			{
 				default: [
 					"signature",
-
 					"private-decorated-field",
 					"private-instance-field",
 					"private-static-field",
@@ -18,11 +16,9 @@ module.exports = {
 					"public-decorated-field",
 					"public-instance-field",
 					"public-static-field",
-
 					"private-constructor",
 					"protected-constructor",
 					"public-constructor",
-
 					"private-decorated-method",
 					"private-instance-method",
 					"private-static-method",
@@ -37,24 +33,24 @@ module.exports = {
 				],
 			},
 		],
-		"@typescript-eslint/no-confusing-non-null-assertion": ["error"],
+		"@typescript-eslint/no-confusing-non-null-assertion": "error",
 		"@typescript-eslint/no-confusing-void-expression": ["error", { ignoreArrowShorthand: true }],
-		"@typescript-eslint/no-explicit-any": ["warn"],
-		"@typescript-eslint/no-extra-non-null-assertion": ["error"],
-		"@typescript-eslint/no-floating-promises": ["error"],
-		"@typescript-eslint/no-non-null-asserted-optional-chain": ["error"],
-		"@typescript-eslint/no-non-null-assertion": ["error"],
-		"@typescript-eslint/no-require-imports": ["error"],
-		"@typescript-eslint/no-unnecessary-boolean-literal-compare": ["error"],
-		"@typescript-eslint/no-unnecessary-condition": ["error"],
+		"@typescript-eslint/no-explicit-any": "warn",
+		"@typescript-eslint/no-extra-non-null-assertion": "error",
+		"@typescript-eslint/no-floating-promises": "error",
+		"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+		"@typescript-eslint/no-non-null-assertion": "error",
+		"@typescript-eslint/no-require-imports": "error",
+		"@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
+		"@typescript-eslint/no-unnecessary-condition": "error",
 		"@typescript-eslint/no-unused-vars": "off",
-		"@typescript-eslint/no-useless-constructor": ["error"],
-		"@typescript-eslint/prefer-for-of": ["error"],
-		"@typescript-eslint/prefer-nullish-coalescing": ["error"],
-		"@typescript-eslint/prefer-readonly": ["error"],
+		"@typescript-eslint/no-useless-constructor": "error",
+		"@typescript-eslint/prefer-for-of": "error",
+		"@typescript-eslint/prefer-nullish-coalescing": "error",
+		"@typescript-eslint/prefer-readonly": "error",
 		"@typescript-eslint/promise-function-async": ["error", { checkArrowFunctions: false }],
-		"@typescript-eslint/require-await": ["warn"],
-		"@typescript-eslint/switch-exhaustiveness-check": ["error"],
+		"@typescript-eslint/require-await": "warn",
+		"@typescript-eslint/switch-exhaustiveness-check": "error",
 		"@typescript-eslint/explicit-member-accessibility": [
 			"error",
 			{
@@ -64,5 +60,6 @@ module.exports = {
 				},
 			},
 		],
+		"@typescript-eslint/explicit-module-boundary-types": "error",
 	},
 };

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": ["./index.js"]
-}

package/.github/workflows/npm-publish.yaml

@@ -1,22 +0,0 @@
-name: 'Publish in NPM'
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  npm-publish:
-    runs-on: ubuntu-latest
-    environment: NPM
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '16' 
-          registry-url: 'https://registry.npmjs.org/' 
-      - run: npm install
-      - run: npm run build --if-present 
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.TOKEN_NPM }}

package/Readme.md

@@ -1,76 +0,0 @@
-# Streamlined ESLint Configuration for JS/TS Projects
-
-This document outlines the steps to integrate my ESLint setup into your JavaScript or TypeScript projects. It's a personal collection of configurations and plugins aimed at fostering a consistent coding style and catching common errors.
-
-## Quick Start Guide
-
-### Step 1: Installation
-
-Add the configuration package to your development dependencies:
-
-```bash
-npm install -D @kembec/eslint-config
-```
-
-### Step 2: Configure ESLint
-
-Modify your ESLint configuration file to use this package. The setup varies slightly depending on whether you're working with plain JavaScript or TypeScript.
-
-- **For JavaScript Projects**: In your `.eslintrc` (which could be a `.json`, `.js`, or `.ts` file), include the following:
-
-```json
-{
-  "extends": ["@kembec/eslint-config"]
-  // Include Jest
-  "extends": ["@kembec/eslint-config/jest"]
-}
-```
-
-- **For TypeScript Projects**: To incorporate TypeScript-specific rules and configure the parser options, use this setup:
-
-```json
-{
-  "extends": ["@kembec/eslint-config/typescript"],
-    // Include Jest
-  "extends": ["@kembec/eslint-config/typescript/jest"]
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx"],
-      "parserOptions": {
-        "project": ["./tsconfig.json"]
-      }
-    }
-  ]
-}
-```
-
-## Included Plugins
-
-The configuration incorporates a carefully selected set of ESLint plugins to assist with various code quality and style concerns:
-
-- `eslint-plugin-import`: Manages and validates import statements.
-- `eslint-plugin-jest`: Provides linting rules for Jest tests.
-- `eslint-plugin-prettier`: Integrates Prettier formatting into ESLint.
-- `eslint-plugin-simple-import-sort`: Automatically sorts import statements.
-- `eslint-plugin-unused-imports`: Helps in removing unused imports.
-- `@typescript-eslint/eslint-plugin`: Adds TypeScript-specific linting rules.
-- `@typescript-eslint/parser`: Allows ESLint to parse TypeScript code.
-
-These plugins are intended to help maintain a clean codebase and promote coding best practices.
-
-## Usage
-
-Integrate linting into your workflow with these npm scripts:
-
-```json
-"scripts": {
-  "lint": "eslint .",
-  "lint:fix": "eslint --fix ."
-}
-```
-
-Use `npm run lint` to identify issues or `npm run lint:fix` to fix many issues automatically.
-
-## License
-
-This project is licensed under the [AGPL-3.0](https://opensource.org/licenses/AGPL-3.0). Its use, modification, and distribution are allowed under the terms of this license.

package/jest/index.js

@@ -1,11 +0,0 @@
-module.exports = {
-	extends: ["../index.js"],
-	overrides: [
-		{
-			files: ["*.test.js"],
-			plugins: ["jest"],
-			extends: ["plugin:jest/recommended"],
-			rules: {},
-		},
-	],
-};

package/rules/variables.js

@@ -1,7 +0,0 @@
-module.exports = {
-	rules: {
-		"no-var": "error",
-		"no-unused-vars": ["error", { vars: "all", args: "after-used", ignoreRestSiblings: true }],
-		"no-use-before-define": ["error", { functions: true, classes: true, variables: true }],
-	},
-};

package/typescript/index.js

@@ -1,28 +0,0 @@
-module.exports = {
-	parser: "@typescript-eslint/parser",
-	parserOptions: {
-		ecmaFeatures: {
-			jsx: true,
-		},
-		ecmaVersion: 12,
-		sourceType: "module",
-	},
-	extends: ["../index.js"],
-	overrides: [
-		{
-			files: ["*.ts", "*.tsx"],
-			extends: [
-				"plugin:@typescript-eslint/recommended",
-				"plugin:@typescript-eslint/recommended-requiring-type-checking",
-				"plugin:import/typescript",
-				...["../rules/typescript"].map(require.resolve),
-			],
-		},
-		{
-			files: ["*.ts"],
-			rules: {
-				"@typescript-eslint/explicit-module-boundary-types": ["error"],
-			},
-		},
-	],
-};

package/typescript/jest/index.js

@@ -1,11 +0,0 @@
-module.exports = {
-	extends: ["../index.js"],
-	overrides: [
-		{
-			files: ["*.test.ts"],
-			plugins: ["jest"],
-			extends: ["plugin:jest/recommended"],
-			rules: {},
-		},
-	],
-};