@pumpn/eslint-config 11.2.0 → 12.0.0

package/eslint.config.js

@@ -0,0 +1,13 @@
+import config from "./config.js";
+
+const eslintConfig = [
+	...config,
+	{
+		files: ["rules/unicorn.js"],
+		rules: {
+			"unicorn/string-content": "off"
+		}
+	}
+];
+
+export default eslintConfig;

package/import-map.json

@@ -0,0 +1,26 @@
+{
+	"imports": {
+		"@eslint-community/eslint-plugin-eslint-comments": "npm:@eslint-community/eslint-plugin-eslint-comments@^4.1.0",
+		"@jsenv/importmap-eslint-resolver": "npm:@jsenv/importmap-eslint-resolver@^5.2.5",
+		"@stylistic/eslint-plugin": "npm:@stylistic/eslint-plugin@^1.6.3",
+		"eslint-plugin-github": "npm:eslint-plugin-github@^4.10.2",
+		"eslint-plugin-import": "npm:eslint-plugin-import@^2.29.1",
+		"eslint-plugin-jsdoc": "npm:eslint-plugin-jsdoc@^48.2.1",
+		"eslint-plugin-jsx-a11y": "npm:eslint-plugin-jsx-a11y@^6.8.0",
+		"eslint-plugin-no-secrets": "npm:eslint-plugin-no-secrets@^0.8.9",
+		"eslint-plugin-no-unsanitized": "npm:eslint-plugin-no-unsanitized@^4.0.2",
+		"eslint-plugin-perfectionist": "npm:eslint-plugin-perfectionist@^2.6.0",
+		"eslint-plugin-promise": "npm:eslint-plugin-promise@^6.1.1",
+		"eslint-plugin-react": "npm:eslint-plugin-react@^7.34.0",
+		"eslint-plugin-redos": "npm:eslint-plugin-redos@^4.4.5",
+		"eslint-plugin-regexp": "npm:eslint-plugin-regexp@^2.2.0",
+		"eslint-plugin-security": "npm:eslint-plugin-security@^2.1.1",
+		"eslint-plugin-sonarjs": "npm:eslint-plugin-sonarjs@^0.24.0",
+		"eslint-plugin-tailwindcss": "npm:eslint-plugin-tailwindcss@^3.14.3",
+		"eslint-plugin-unicorn": "npm:eslint-plugin-unicorn@^51.0.1",
+		"globals": "https://esm.sh/globals@^14.0.0",
+		"preact": "https://esm.sh/*preact@10.19.3?dev",
+		"preact/jsx-runtime": "https://esm.sh/*preact@10.19.3/jsx-runtime?dev",
+		"radash": "npm:radash"
+	}
+}

package/jsdoc.json

@@ -0,0 +1,51 @@
+{
+	"plugins": [
+		"plugins/markdown",
+		"node_modules/funbridge-jsdoc-template/typescript",
+		"node_modules/funbridge-jsdoc-template/category",
+		"node_modules/funbridge-jsdoc-template/component",
+		"node_modules/funbridge-jsdoc-template/typedef-import",
+		"node_modules/jsdoc-mermaid"
+	],
+	"recurseDepth": 10,
+	"source": {
+		"include": [
+			"./"
+		],
+		"includePattern": ".(?:j|t)sx?$",
+		"excludePattern": "(node_modules/|documentation/)"
+	},
+	"sourceType": "module",
+	"tags": {
+		"allowUnknownTags": true,
+		"dictionaries": [
+			"jsdoc",
+			"closure"
+		]
+	},
+	"templates": {
+		"cleverLinks": false,
+		"monospaceLinks": false,
+		"search": true,
+		"default": {
+			"includeDate": false
+		}
+	},
+	"opts": {
+		"encoding": "utf8",
+		"destination": "./documentation/",
+		"template": "./node_modules/funbridge-jsdoc-template",
+		"recurse": true,
+		"verbose": false,
+		"theme_opts": {
+			"default_theme": "dark",
+			"seach": true,
+			"commonNav": true,
+			"typedefs": true
+		}
+	},
+	"markdown": {
+		"hardwrap": false,
+		"idInHeadings": true
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pumpn/eslint-config",
-	"version": "11.2.0",
+	"version": "12.0.0",
 	"description": "standard eslint config for pumpn code projects",
 	"main": "config.js",
 	"author": "Nano Miratus <nanomiratus@gmail.com>",
@@ -11,28 +11,35 @@
 	"scripts": {
 		"lint": "eslint .",
 		"prepublishOnly": "npm run lint",
-		"release": "np",
 		"test": "echo 'no tests yet'"
 	},
 	"devDependencies": {
-		"@pumpn/np-config": "^3.0.0",
-		"eslint": "^8.40.0",
-		"eslint-plugin-react": "*",
-		"np": "^7.7.0"
+		"eslint": "^8.57.0",
+		"funbridge-jsdoc-template": "github:52-entertainment/funbridge-react-jsdoc",
+		"jsdoc-mermaid": "1.0.0"
 	},
 	"dependencies": {
-		"@babel/eslint-parser": "^7.21.8",
-		"@babel/plugin-proposal-export-default-from": "^7.18.10",
-		"@babel/preset-react": "^7.18.6",
-		"@eslint/js": "^8.40.0",
+		"@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
 		"@jsenv/importmap-eslint-resolver": "^5.2.5",
-		"globals": "^13.20.0"
+		"@stylistic/eslint-plugin": "^1.6.3",
+		"eslint-plugin-github": "^4.10.2",
+		"eslint-plugin-import": "^2.29.1",
+		"eslint-plugin-jsdoc": "^48.2.1",
+		"eslint-plugin-jsx-a11y": "^6.8.0",
+		"eslint-plugin-no-secrets": "^0.8.9",
+		"eslint-plugin-no-unsanitized": "^4.0.2",
+		"eslint-plugin-perfectionist": "^2.6.0",
+		"eslint-plugin-promise": "^6.1.1",
+		"eslint-plugin-react": "^7.34.0",
+		"eslint-plugin-redos": "^4.4.5",
+		"eslint-plugin-regexp": "^2.2.0",
+		"eslint-plugin-security": "^2.1.1",
+		"eslint-plugin-sonarjs": "^0.24.0",
+		"eslint-plugin-tailwindcss": "^3.14.3",
+		"eslint-plugin-unicorn": "^51.0.1",
+		"globals": "^14.0.0"
 	},
 	"peerDependencies": {
-		"eslint": "^8.40.0",
-		"eslint-plugin-import": "^2.27.5",
-		"eslint-plugin-jsdoc": "^44.2.1",
-		"eslint-plugin-react": "^7.32.2",
-		"eslint-plugin-sort-keys-plus": "^1.3.1"
+		"eslint": "^8.57.0"
 	}
-}
+}

package/plugins.js

@@ -0,0 +1,40 @@
+/* eslint-disable import/max-dependencies -- collection file */
+import eslintComments from "@eslint-community/eslint-plugin-eslint-comments";
+import stylistic from "@stylistic/eslint-plugin";
+import github from "eslint-plugin-github";
+import eslintPluginImport from "eslint-plugin-import";
+import jsdoc from "eslint-plugin-jsdoc";
+import jsxA11y from "eslint-plugin-jsx-a11y";
+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";
+import sonarjs from "eslint-plugin-sonarjs";
+import tailwindcss from "eslint-plugin-tailwindcss";
+import unicorn from "eslint-plugin-unicorn";
+
+const plugins = {
+	"@eslint-community/eslint-comments": eslintComments,
+	"@stylistic": stylistic,
+	github,
+	import: eslintPluginImport,
+	jsdoc,
+	"jsx-a11y": jsxA11y,
+	"no-secrets": noSecrets,
+	"no-unsanitized": noUnsanitized,
+	perfectionist,
+	promise,
+	react,
+	redos,
+	regexp,
+	security,
+	sonarjs,
+	tailwindcss,
+	unicorn
+};
+
+export default plugins;

package/rules/_exports.js

@@ -0,0 +1,21 @@
+export { default as eslintCommentsRules } from "./eslint-comments.js";
+export { default as githubRules } from "./github.js";
+export { default as importRules } from "./import.js";
+export { default as jsdocRules } from "./jsdoc.js";
+export { default as jsxA11yRules } from "./jsx-a11y.js";
+export {
+	default as layoutAndFormattingRules
+} from "./layout-and-formatting.js";
+export { default as noSecretsRules } from "./no-secrets.js";
+export { default as noUnsanitizedRules } from "./no-unsanitized.js";
+export { default as perfectionistRules } from "./perfectionist.js";
+export { default as possibleProblemsRules } from "./possible-problems.js";
+export { default as reactRules } from "./react.js";
+export { default as redosRules } from "./redos.js";
+export { default as regexpRules } from "./regexp.js";
+export { default as securityRules } from "./security.js";
+export { default as sonarjsRules } from "./sonarjs.js";
+export { default as stylisticRules } from "./stylistic.js";
+export { default as suggestionsRules } from "./suggestions.js";
+export { default as tailwindcssRules } from "./tailwindcss.js";
+export { default as unicornRules } from "./unicorn.js";

package/rules/eslint-comments/_exports.js

@@ -0,0 +1,2 @@
+export { default as bestPracticesRules } from "./best-practices.js";
+export { default as stylisticIssuesRules } from "./stylistic-issues.js";

package/rules/eslint-comments/best-practices.js

@@ -0,0 +1,10 @@
+const bestPracticesRules = {
+	"@eslint-community/eslint-comments/disable-enable-pair": "off",
+	"@eslint-community/eslint-comments/no-aggregating-enable": "error",
+	"@eslint-community/eslint-comments/no-duplicate-disable": "error",
+	"@eslint-community/eslint-comments/no-unlimited-disable": "error",
+	"@eslint-community/eslint-comments/no-unused-disable": "error",
+	"@eslint-community/eslint-comments/no-unused-enable": "error"
+};
+
+export default bestPracticesRules;

package/rules/eslint-comments/stylistic-issues.js

@@ -0,0 +1,12 @@
+const stylisticIssuesRules = {
+	"@eslint-community/eslint-comments/no-restricted-disable": ["error"],
+	"@eslint-community/eslint-comments/no-use": [
+		"error",
+		{
+			allow: ["eslint-disable"]
+		}
+	],
+	"@eslint-community/eslint-comments/require-description": "error"
+};
+
+export default stylisticIssuesRules;

package/rules/eslint-comments.js

@@ -0,0 +1,12 @@
+import * as eslintCommentsRuleSets from "./eslint-comments/_exports.js";
+
+const eslintCommentsRules = Object.values(eslintCommentsRuleSets)
+	.reduce(
+		(allRules, ruleSet) => ({
+			...allRules,
+			...ruleSet
+		}),
+		{}
+	);
+
+export default eslintCommentsRules;

package/rules/github.js

@@ -0,0 +1,27 @@
+const githubRules = {
+	"github/a11y-aria-label-is-well-formatted": "error",
+	"github/a11y-no-title-attribute": "error",
+	"github/a11y-no-visually-hidden-interactive-element": "error",
+	"github/a11y-role-supports-aria-props": "error",
+	"github/a11y-svg-has-accessible-name": "error",
+	"github/array-foreach": "error",
+	"github/async-currenttarget": "error",
+	"github/async-preventdefault": "error",
+	"github/authenticity-token": "error",
+	"github/get-attribute": "error",
+	"github/js-class-name": "error",
+	"github/no-blur": "error",
+	"github/no-d-none": "error",
+	"github/no-dataset": "error",
+	"github/no-dynamic-script-tag": "error",
+	"github/no-implicit-buggy-globals": "error",
+	"github/no-inner-html": "error",
+	"github/no-innerText": "error",
+	"github/no-then": "error",
+	"github/no-useless-passive": "error",
+	"github/prefer-observers": "error",
+	"github/require-passive-events": "error",
+	"github/unescaped-html-literal": "error"
+};
+
+export default githubRules;

package/rules/import/_exports.js

@@ -0,0 +1,4 @@
+export { default as helpfulWarningsRules } from "./helpful-warnings.js";
+export { default as moduleSystemsRules } from "./module-systems.js";
+export { default as staticAnalysisRules } from "./static-analysis.js";
+export { default as styleGuideRules } from "./style-guide.js";

package/rules/import/helpful-warnings.js

@@ -0,0 +1,18 @@
+const helpfulWarningsRules = {
+	"import/export": "error",
+	"import/no-deprecated": "warn",
+	"import/no-empty-named-blocks": "error",
+	"import/no-extraneous-dependencies": "off",
+	"import/no-mutable-exports": "error",
+	"import/no-named-as-default": "error",
+	"import/no-named-as-default-member": "error",
+	"import/no-unused-modules": [
+		"error",
+		{
+			missingExports: true,
+			unusedExports: false
+		}
+	]
+};
+
+export default helpfulWarningsRules;

package/rules/import/module-systems.js

@@ -0,0 +1,9 @@
+const moduleSystemsRules = {
+	"import/no-amd": "error",
+	"import/no-commonjs": "error",
+	"import/no-import-module-exports": "error",
+	"import/no-nodejs-modules": "off",
+	"import/unambiguous": "error"
+};
+
+export default moduleSystemsRules;

package/rules/import/static-analysis.js

@@ -0,0 +1,71 @@
+const staticAnalysisRules = {
+	"import/default": "error",
+	"import/named": "error",
+	"import/namespace": "error",
+	"import/no-absolute-path": "error",
+	"import/no-cycle": [
+		"error",
+		{
+			maxDepth: Infinity
+		}
+	],
+	"import/no-dynamic-require": "error",
+	"import/no-internal-modules": [
+		"off",
+		{
+			allow: []
+		}
+	],
+	"import/no-relative-packages": "error",
+	"import/no-relative-parent-imports": "off",
+	"import/no-restricted-paths": [
+		"error",
+		{
+			zones: [
+				{
+					except: ["**/utilities/_exports.client.js"],
+					from: [
+						"plugins",
+						"routes",
+						"static",
+						"utilities"
+					]
+						.map((folderName) => `./${folderName}/**/*`),
+					message: "Please use the utilities/_exports.client.js file to import server utilities",
+					target: "./islands/**/*"
+				},
+				{
+					except: ["**/utilities/_exports.server.js"],
+					from: [
+						"plugins",
+						"routes",
+						"static",
+						"utilities"
+					]
+						.map((folderName) => `./${folderName}/**/*`),
+					message: "Please use the utilities/_exports.server.js file to import server utilities",
+					target: [
+						"./components/**/*",
+						"./logic/**/*",
+						"./patches/**/*",
+						"./plugins/**/*",
+						"./routes/**/*",
+						"./static/**/*"
+					]
+				}
+			]
+		}
+	],
+	"import/no-self-import": "error",
+	"import/no-unresolved": "error",
+	"import/no-useless-path-segments": [
+		"error",
+		{
+			commonjs: false,
+			noUselessIndex: false
+		}
+	],
+	"import/no-webpack-loader-syntax": "error"
+};
+
+export default staticAnalysisRules;

package/rules/import/style-guide.js

@@ -0,0 +1,86 @@
+const maxDependencies = 10;
+
+const styleGuideRules = {
+	"import/consistent-type-specifier-style": "error",
+	"import/dynamic-import-chunkname": "off",
+	"import/exports-last": "error",
+	"import/extensions": ["error", "ignorePackages"],
+	"import/first": "error",
+	"import/group-exports": "error",
+	"import/max-dependencies": [
+		"error",
+		{
+			max: maxDependencies
+		}
+	],
+	"import/newline-after-import": "error",
+	"import/no-anonymous-default-export": [
+		"error",
+		{
+			allowAnonymousClass: false,
+			allowAnonymousFunction: false,
+			allowArray: false,
+			allowArrowFunction: false,
+			allowCallExpression: false,
+			allowLiteral: false,
+			allowNew: false,
+			allowObject: false
+		}
+	],
+	"import/no-default-export": "off",
+	"import/no-duplicates": "error",
+	"import/no-named-default": "error",
+	"import/no-named-export": "off",
+	"import/no-namespace": [
+		"error",
+		{
+			ignore: ["{./**/,**/}_exports.?(*.)js"]
+		}
+	],
+	"import/no-unassigned-import": "error",
+	"import/order": [
+		"off",
+		{
+			alphabetize: {
+				caseInsensitive: false,
+				order: "asc"
+			},
+			groups: [
+				"type",
+				"object",
+				"builtin",
+				"external",
+				"internal",
+				"parent",
+				"sibling",
+				"index"
+			],
+			"newlines-between": "always",
+			pathGroups: [
+				...new Map([
+					["builtin", ["std"]],
+					[
+						"internal",
+						[
+							"@/utilities",
+							"@/plugins",
+							"@/logic",
+							"@/components",
+							"@/islands"
+						]
+					]
+				])
+			]
+				.flatMap(([group, patterns]) => patterns
+					.map((pattern) => ({
+						group,
+						pattern: `${pattern}/**`,
+						position: "after"
+					}))),
+			warnOnUnassignedImports: false
+		}
+	],
+	"import/prefer-default-export": ["error", { target: "single" }]
+};
+
+export default styleGuideRules;

package/rules/import.js

@@ -0,0 +1,12 @@
+import * as importRuleSets from "./import/_exports.js";
+
+const importRules = Object.values(importRuleSets)
+	.reduce(
+		(allRules, ruleSet) => ({
+			...allRules,
+			...ruleSet
+		}),
+		{}
+	);
+
+export default importRules;