@pumpn/eslint-config 13.2.0 → 14.0.0

package/import-map.json

@@ -1,13 +1,17 @@
 {
 	"imports": {
 		"@eslint-community/eslint-plugin-eslint-comments": "npm:@eslint-community/eslint-plugin-eslint-comments@^4.3.0",
+		"@eslint-react/eslint-plugin": "npm:@eslint-react/eslint-plugin@^1.5.28",
+		"@std/path": "jsr:@std/path",
 		"@stylistic/eslint-plugin": "npm:@stylistic/eslint-plugin@^2.3.0",
+		"@typescript-eslint/parser": "npm:@typescript-eslint/parser@^8.0.0-alpha.47",
+		"eslint-plugin-depend": "npm:eslint-plugin-depend@^0.9.0",
 		"eslint-plugin-import-x": "npm:eslint-plugin-import-x@^3.0.1",
-		"eslint-plugin-jsdoc": "npm:eslint-plugin-jsdoc@^48.7.0",
+		"eslint-plugin-jsdoc": "npm:eslint-plugin-jsdoc@^48.8.3",
 		"eslint-plugin-no-secrets": "npm:eslint-plugin-no-secrets@^1.0.2",
 		"eslint-plugin-perfectionist": "npm:eslint-plugin-perfectionist@^2.11.0",
-		"eslint-plugin-promise": "npm:eslint-plugin-promise@^6.4.0",
-		"eslint-plugin-react": "./patches/eslint-plugin-react/index.js",
+		"eslint-plugin-promise": "npm:eslint-plugin-promise@^6.5.1",
+		"eslint-plugin-react": "npm:eslint-plugin-react@^7.35.0",
 		"eslint-plugin-redos": "npm:eslint-plugin-redos@^4.4.5",
 		"eslint-plugin-regexp": "npm:eslint-plugin-regexp@^2.6.0",
 		"eslint-plugin-security": "npm:eslint-plugin-security@^3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pumpn/eslint-config",
-	"version": "13.2.0",
+	"version": "14.0.0",
 	"description": "standard eslint config for pumpn code projects",
 	"main": "config.js",
 	"author": "Nano Miratus <nanomiratus@gmail.com>",
@@ -17,19 +17,19 @@
 		"test": "echo 'no tests yet'"
 	},
 	"devDependencies": {
-		"eslint": "^9.7.0",
-		"funbridge-jsdoc-template": "github:52-entertainment/funbridge-react-jsdoc",
-		"jsdoc-mermaid": "1.0.0"
+		"eslint": "^9.7.0"
 	},
 	"dependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+		"@eslint-react/eslint-plugin": "^1.5.28",
 		"@stylistic/eslint-plugin": "^2.3.0",
+		"@typescript-eslint/parser": "^8.0.0-alpha.47",
+		"eslint-plugin-depend": "^0.9.0",
 		"eslint-plugin-import-x": "^3.0.1",
-		"eslint-plugin-jsdoc": "^48.7.0",
+		"eslint-plugin-jsdoc": "^48.8.3",
 		"eslint-plugin-no-secrets": "^1.0.2",
 		"eslint-plugin-perfectionist": "^2.11.0",
-		"eslint-plugin-promise": "^6.4.0",
-		"eslint-plugin-react": "github:jsx-eslint/eslint-plugin-react#pull/3759",
+		"eslint-plugin-promise": "^6.5.1",
 		"eslint-plugin-redos": "^4.4.5",
 		"eslint-plugin-regexp": "^2.6.0",
 		"eslint-plugin-security": "^3.0.1",
@@ -40,5 +40,9 @@
 	},
 	"peerDependencies": {
 		"eslint": "^9.4.0"
+	},
+	"overrides": {
+		"@typescript-eslint/type-utils": "^8.0.0-alpha.47",
+		"@typescript-eslint/utils": "^8.0.0-alpha.47"
 	}
 }

package/plugins.js

@@ -1,6 +1,8 @@
 /* eslint-disable import-x/max-dependencies -- collection file */
 import eslintComments from "@eslint-community/eslint-plugin-eslint-comments";
+import react from "@eslint-react/eslint-plugin";
 import stylistic from "@stylistic/eslint-plugin";
+import depend from "eslint-plugin-depend";
 // import github from "eslint-plugin-github";
 import importX from "eslint-plugin-import-x";
 import jsdoc from "eslint-plugin-jsdoc";
@@ -9,7 +11,6 @@ import noSecrets from "eslint-plugin-no-secrets";
 // import noUnsanitized from "eslint-plugin-no-unsanitized";
 import perfectionist from "eslint-plugin-perfectionist";
 import promise from "eslint-plugin-promise";
-import react from "eslint-plugin-react";
 import redos from "eslint-plugin-redos";
 import regexp from "eslint-plugin-regexp";
 import security from "eslint-plugin-security";
@@ -26,6 +27,7 @@ const plugins = {
 	// "jsx-a11y": jsxA11y,
 	"no-secrets": noSecrets,
 	// "no-unsanitized": noUnsanitized,
+	depend,
 	perfectionist,
 	promise,
 	react,

package/rules/_exports.js

@@ -1,3 +1,4 @@
+export { default as dependRules } from "./depend.js";
 export { default as eslintCommentsRules } from "./eslint-comments.js";
 // export { default as githubRules } from "./github.js";
 export { default as importXRules } from "./import-x.js";

package/rules/depend.js

@@ -0,0 +1,5 @@
+const dependRules = {
+	"depend/ban-dependencies": "error"
+};
+
+export default dependRules;

package/rules/import-x/style-guide.js

@@ -34,7 +34,7 @@ const styleGuideRules = {
 	"import-x/no-namespace": [
 		"error",
 		{
-			ignore: ["{./**/,**/}_exports.?(*.)js"]
+			ignore: ["{./**/,**/}_exports.?(*.)js", "@typescript-eslint/parser"]
 		}
 	],
 	"import-x/no-unassigned-import": "error",

package/rules/jsdoc.js

@@ -1,9 +1,14 @@
 const jsdocRules = {
 	"jsdoc/check-access": "warn",
 	"jsdoc/check-alignment": "warn",
-	// TODO [eslint-plugin-jsdoc@>=49]: enable when https://github.com/eslint/eslint/issues/14745 is fixed
+	// TODO [eslint-plugin-jsdoc@>=49]: enable when https://github.com/eslint/eslint/issues/14745 and https://github.com/gajus/eslint-plugin-jsdoc/issues/928 are closed
 	"jsdoc/check-examples": "off",
-	"jsdoc/check-indentation": "warn",
+	"jsdoc/check-indentation": [
+		"warn",
+		{
+			excludeTags: ["example", "typedef"]
+		}
+	],
 	"jsdoc/check-line-alignment": "off",
 	"jsdoc/check-param-names": "warn",
 	"jsdoc/check-property-names": "warn",
@@ -14,6 +19,7 @@ const jsdocRules = {
 			definedTags: ["category", "component"]
 		}
 	],
+	"jsdoc/check-template-names": "warn",
 	"jsdoc/check-types": "warn",
 	"jsdoc/check-values": "warn",
 	"jsdoc/convert-to-jsdoc-comments": [
@@ -137,8 +143,20 @@ const jsdocRules = {
 	"jsdoc/require-jsdoc": [
 		"warn",
 		{
+			contexts: [
+				`
+					:not(
+						:matches(
+							CallExpression > ObjectExpression > Property,
+							ArrayExpression:has(Literal ~ ArrowFunctionExpression),
+							CallExpression,
+							Property > AssignmentPattern
+						)
+					) > ArrowFunctionExpression
+				`.replaceAll(/\s/gu, "")
+			],
 			require: {
-				ArrowFunctionExpression: true,
+				ArrowFunctionExpression: false,
 				ClassDeclaration: true,
 				ClassExpression: true,
 				FunctionDeclaration: true,

package/rules/react/_exports.js

@@ -0,0 +1,5 @@
+export { default as coreRules } from "./core.js";
+export { default as debugRules } from "./debug.js";
+export { default as domRules } from "./dom.js";
+export { default as hooksExtraRules } from "./hooks-extra.js";
+export { default as namingConventionRules } from "./naming-convention.js";

package/rules/react/core.js

@@ -0,0 +1,45 @@
+const coreRules = {
+	"react/avoid-shorthand-boolean": "off",
+	"react/avoid-shorthand-fragment": "off",
+	"react/ensure-forward-ref-using-ref": "error",
+	"react/no-access-state-in-setstate": "error",
+	"react/no-array-index-key": "error",
+	"react/no-children-count": "error",
+	"react/no-children-for-each": "error",
+	"react/no-children-map": "error",
+	"react/no-children-only": "error",
+	"react/no-children-prop": "error",
+	"react/no-children-to-array": "error",
+	"react/no-class-component": "error",
+	"react/no-clone-element": "error",
+	"react/no-comment-textnodes": "error",
+	"react/no-component-will-mount": "error",
+	"react/no-component-will-receive-props": "error",
+	"react/no-component-will-update": "error",
+	"react/no-create-ref": "error",
+	"react/no-direct-mutation-state": "error",
+	"react/no-duplicate-key": "error",
+	"react/no-leaked-conditional-rendering": "error",
+	"react/no-missing-component-display-name": "error",
+	"react/no-missing-key": "error",
+	"react/no-nested-components": "error",
+	"react/no-redundant-should-component-update": "error",
+	"react/no-set-state-in-component-did-mount": "error",
+	"react/no-set-state-in-component-did-update": "error",
+	"react/no-set-state-in-component-will-update": "error",
+	"react/no-string-refs": "error",
+	"react/no-unsafe-component-will-mount": "error",
+	"react/no-unsafe-component-will-receive-props": "error",
+	"react/no-unsafe-component-will-update": "error",
+	"react/no-unstable-context-value": "error",
+	"react/no-unstable-default-props": "error",
+	"react/no-unused-class-component-members": "error",
+	"react/no-unused-state": "error",
+	"react/no-useless-fragment": "error",
+	"react/prefer-destructuring-assignment": "error",
+	"react/prefer-read-only-props": "error",
+	"react/prefer-shorthand-boolean": "error",
+	"react/prefer-shorthand-fragment": "error"
+};
+
+export default coreRules;

package/rules/react/debug.js

@@ -0,0 +1,7 @@
+const debugRules = {
+	"react/debug/class-component": "off",
+	"react/debug/function-component": "off",
+	"react/debug/react-hooks": "off"
+};
+
+export default debugRules;

package/rules/react/dom.js

@@ -0,0 +1,15 @@
+const domRules = {
+	"react/dom/no-children-in-void-dom-elements": "error",
+	"react/dom/no-dangerously-set-innerhtml": "error",
+	"react/dom/no-dangerously-set-innerhtml-with-children": "error",
+	"react/dom/no-find-dom-node": "error",
+	"react/dom/no-missing-button-type": "error",
+	"react/dom/no-missing-iframe-sandbox": "error",
+	"react/dom/no-namespace": "error",
+	"react/dom/no-render-return-value": "error",
+	"react/dom/no-script-url": "error",
+	"react/dom/no-unsafe-iframe-sandbox": "error",
+	"react/dom/no-unsafe-target-blank": "error"
+};
+
+export default domRules;

package/rules/react/hooks-extra.js

@@ -0,0 +1,10 @@
+const hooksExtraRules = {
+	"react/hooks-extra/ensure-custom-hooks-using-other-hooks": "error",
+	"react/hooks-extra/ensure-use-callback-has-non-empty-deps": "error",
+	"react/hooks-extra/ensure-use-memo-has-non-empty-deps": "error",
+	"react/hooks-extra/no-direct-set-state-in-use-effect": "error",
+	"react/hooks-extra/no-direct-set-state-in-use-layout-effect": "error",
+	"react/hooks-extra/prefer-use-state-lazy-initialization": "error"
+};
+
+export default hooksExtraRules;

package/rules/react/naming-convention.js

@@ -0,0 +1,20 @@
+const namingConventionRules = {
+	"react/naming-convention/component-name": [
+		"error",
+		{
+			excepts: [],
+			rule: "PascalCase"
+		}
+	],
+	"react/naming-convention/filename": ["error", { rule: "kebab-case" }],
+	"react/naming-convention/filename-extension": [
+		"error",
+		{
+			allow: "as-needed",
+			extensions: [".jsx", ".tsx"]
+		}
+	],
+	"react/naming-convention/use-state": "error"
+};
+
+export default namingConventionRules;

package/rules/react.js

@@ -1,107 +1,12 @@
-const maxDepth = 10;
+import * as reactRuleSets from "./react/_exports.js";
 
-const reactRules = {
-	"react/boolean-prop-naming": "error",
-	"react/button-has-type": "error",
-	"react/default-props-match-prop-types": "error",
-	"react/destructuring-assignment": "error",
-	"react/display-name": "error",
-	"react/forbid-component-props": "off",
-	"react/forbid-dom-props": "error",
-	"react/forbid-elements": "error",
-	"react/forbid-foreign-prop-types": "error",
-	"react/forbid-prop-types": "error",
-	"react/function-component-definition": [
-		"error",
-		{
-			namedComponents: "arrow-function",
-			unnamedComponents: "arrow-function"
-		}
-	],
-	"react/hook-use-state": ["error", { allowDestructuredState: true }],
-	"react/iframe-missing-sandbox": "error",
-	"react/jsx-boolean-value": "error",
-	"react/jsx-filename-extension": [
-		"error",
-		{
-			allow: "as-needed",
-			extensions: [".jsx"],
-			ignoreFilesWithoutCode: true
-		}
-	],
-	"react/jsx-fragments": ["error", "syntax"],
-	"react/jsx-handler-names": "error",
-	"react/jsx-key": "error",
-	"react/jsx-max-depth": ["error", { max: maxDepth }],
-	"react/jsx-no-bind": "error",
-	"react/jsx-no-comment-textnodes": "error",
-	"react/jsx-no-constructed-context-values": "error",
-	"react/jsx-no-duplicate-props": "error",
-	"react/jsx-no-leaked-render": "error",
-	"react/jsx-no-literals": "off",
-	"react/jsx-no-script-url": "error",
-	"react/jsx-no-target-blank": [
-		"error",
-		{
-			allowReferrer: false,
-			enforceDynamicLinks: "always",
-			forms: false,
-			links: true,
-			warnOnSpreadAttributes: true
-		}
-	],
-	"react/jsx-no-undef": "error",
-	"react/jsx-no-useless-fragment": "error",
-	"react/jsx-props-no-spreading": "off",
-	"react/jsx-uses-react": "error",
-	"react/jsx-uses-vars": "error",
-	"react/no-access-state-in-setstate": "error",
-	"react/no-adjacent-inline-elements": "error",
-	"react/no-array-index-key": "off",
-	"react/no-arrow-function-lifecycle": "off",
-	"react/no-children-prop": "error",
-	"react/no-danger": "error",
-	"react/no-danger-with-children": "error",
-	"react/no-deprecated": "error",
-	"react/no-did-mount-set-state": "error",
-	"react/no-did-update-set-state": "error",
-	"react/no-direct-mutation-state": "error",
-	"react/no-find-dom-node": "error",
-	"react/no-invalid-html-attribute": "error",
-	"react/no-is-mounted": "error",
-	"react/no-multi-comp": ["error", { ignoreStateless: false }],
-	"react/no-namespace": "error",
-	"react/no-object-type-as-default-prop": "error",
-	"react/no-redundant-should-component-update": "error",
-	"react/no-render-return-value": "error",
-	"react/no-set-state": "off",
-	"react/no-string-refs": "error",
-	"react/no-this-in-sfc": "error",
-	"react/no-typos": "error",
-	"react/no-unescaped-entities": "error",
-	"react/no-unknown-property": "error",
-	"react/no-unsafe": "error",
-	"react/no-unstable-nested-components": "error",
-	"react/no-unused-class-component-methods": "error",
-	"react/no-unused-prop-types": "error",
-	"react/no-unused-state": "error",
-	"react/no-will-update-set-state": "error",
-	"react/prefer-es6-class": ["error", "always"],
-	"react/prefer-exact-props": "error",
-	"react/prefer-read-only-props": "error",
-	"react/prefer-stateless-function": "error",
-	"react/prop-types": "off",
-	"react/react-in-jsx-scope": "off",
-	"react/require-default-props": "error",
-	"react/require-optimization": "error",
-	"react/require-render-return": "error",
-	"react/sort-comp": "off",
-	"react/sort-default-props": "off",
-	"react/sort-prop-types": "off",
-	"react/state-in-constructor": ["error", "never"],
-	"react/static-property-placement": "error",
-	"react/style-prop-object": "error",
-	"react/void-dom-elements-no-children": "error"
-};
+const reactRules = Object.values(reactRuleSets)
+	.reduce(
+		(allRules, ruleSet) => ({
+			...allRules,
+			...ruleSet
+		}),
+		{}
+	);
 
 export default reactRules;

package/rules/suggestions.js

@@ -4,7 +4,7 @@ const maxClassesPerFile = 1;
 const maxDepth = 8;
 const maxLinesPerFile = 500;
 const maxLinesPerFunction = 100;
-const maxNestedCallbacks = 4;
+const maxNestedCallbacks = 10;
 const maxParameters = 3;
 const maxStatements = 20;
 

package/scripts/update-import-map.js

@@ -0,0 +1,47 @@
+import { join } from "@std/path";
+
+const {
+	cwd,
+	readTextFile,
+	writeTextFile
+} = Deno;
+
+const packageJsonFilePath = join(cwd(), "package.json");
+const packageJsonFileContent = await readTextFile(packageJsonFilePath);
+const packageJson = JSON.parse(packageJsonFileContent);
+
+const importMapFilePath = join(cwd(), "import-map.json");
+const importMapFileContent = await readTextFile(importMapFilePath);
+const importMap = JSON.parse(importMapFileContent);
+
+const collator = new Intl.Collator("en", {
+	numeric: true
+});
+
+const updatedImportMap = {
+	...importMap,
+	imports: Object.fromEntries(
+
+		Object.entries({
+			...importMap.imports,
+			...Object.fromEntries(
+				Object.entries(
+					packageJson.dependencies
+				)
+					.map(([packageName, packageVersion]) => [packageName, `npm:${packageName}@${packageVersion}`])
+			)
+		})
+			.toSorted((
+				[packageNameA],
+				[packageNameB]
+			) => collator.compare(
+				packageNameA,
+				packageNameB
+			))
+	)
+};
+
+await writeTextFile(
+	importMapFilePath,
+	JSON.stringify(updatedImportMap, null, "\t")
+);

package/scripts/update-tsconfig.js

@@ -0,0 +1,46 @@
+import { join } from "@std/path";
+
+const {
+	cwd,
+	readTextFile,
+	writeTextFile
+} = Deno;
+
+const denoJsonFilePath = join(cwd(), "deno.json");
+const denoJsonFileContent = await readTextFile(denoJsonFilePath);
+const denoJson = JSON.parse(denoJsonFileContent);
+
+const tsconfigFilePath = join(cwd(), "tsconfig.json");
+const tsconfigFileContent = await readTextFile(tsconfigFilePath);
+const tsconfig = JSON.parse(tsconfigFileContent);
+
+const collator = new Intl.Collator("en", {
+	numeric: true
+});
+
+const updatedTsconfig = {
+	...tsconfig,
+	compilerOptions: Object.fromEntries(
+		Object.entries({
+			...tsconfig.compilerOptions,
+			...Object.fromEntries(
+				Object.entries(
+					denoJson.compilerOptions
+				)
+					.filter(([key]) => key !== "lib")
+			)
+		})
+			.toSorted((
+				[keyA],
+				[keyB]
+			) => collator.compare(
+				keyA,
+				keyB
+			))
+	)
+};
+
+await writeTextFile(
+	tsconfigFilePath,
+	JSON.stringify(updatedTsconfig, null, "\t")
+);

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+	"compilerOptions": {
+		"allowJs": true,
+		"allowUnreachableCode": false,
+		"allowUnusedLabels": false,
+		"alwaysStrict": true,
+		"checkJs": true,
+		"exactOptionalPropertyTypes": true,
+		"jsx": "react-jsx",
+		"jsxImportSource": "preact",
+		"noErrorTruncation": true,
+		"noFallthroughCasesInSwitch": false,
+		"noImplicitAny": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noPropertyAccessFromIndexSignature": false,
+		"noUncheckedIndexedAccess": false,
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"strict": true
+	}
+}