@pumpn/eslint-config 15.5.2 → 15.5.3

package/config.js

@@ -5,6 +5,10 @@ import globals from "globals";
 import plugins from "./plugins.js";
 import rules from "./rules.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
 const cssFilesRefreshRate = 5_000;
 
 const convertedGlobals = Object.fromEntries(
@@ -45,7 +49,15 @@ const rulesWithAutofixDisabled = Object.fromEntries(
 		])
 );
 
-const config = [
+/**
+ * ESLint configuration.
+ *
+ * This configuration includes settings for various file types, plugins, and rules.
+ * It also defines specific settings for different environments and file patterns.
+ *
+ * @satisfies {Linter.Config[]}
+ */
+const config = /** @type {const} */ ([
 	{
 		ignores: [
 			"_fresh/**",
@@ -215,6 +227,6 @@ const config = [
 		plugins,
 		rules: rulesWithAutofixDisabled
 	}
-];
+]);
 
 export default config;

package/deno.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pumpn/eslint-config",
-	"version": "15.5.2",
+	"version": "15.5.3",
 	"exports": "./config.js",
 	"tasks": {
 		"lint": "deno run -A npm:eslint",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pumpn/eslint-config",
-	"version": "15.5.2",
+	"version": "15.5.3",
 	"description": "standard eslint config for pumpn code projects",
 	"main": "config.js",
 	"author": "Nano Miratus <nanomiratus@gmail.com>",

package/plugins.js

@@ -1,5 +1,7 @@
+/* eslint-disable object-shorthand -- const types */
 /* eslint-disable import-x/no-rename-default -- bad export names */
 /* eslint-disable import-x/max-dependencies -- collection file */
+
 // import github from "eslint-plugin-github";
 // import jsxA11y from "eslint-plugin-jsx-a11y";
 // import noUnsanitized from "eslint-plugin-no-unsanitized";
@@ -21,19 +23,34 @@ import sonarjs from "eslint-plugin-sonarjs";
 import tailwindcss from "eslint-plugin-tailwindcss";
 import unicorn from "eslint-plugin-unicorn";
 
-const plugins = {
+/**
+ * @import { Linter, ESLint } from "eslint"
+ */
+
+const reactPlugins = /** @type {Record<string, ESLint.Plugin>} */ (
+	/** @type {unknown} */ (react.configs.all.plugins)
+);
+
+/**
+ * @satisfies { Linter.Config["plugins"] }
+ */
+const plugins = /** @type {const} */ ({
 	// github,
 	// "jsx-a11y": jsxA11y,
 	// "no-unsanitized": noUnsanitized,
 	"@eslint-community/eslint-comments": eslintComments,
-	"@stylistic": stylistic,
+	"@stylistic": /** @type {ESLint.Plugin} */ (stylistic),
 	depend,
 	"disable-autofix": disableAutofix,
 	"func-params-args": funcParamsArgs,
-	"import-x": importX,
+	"import-x": /** @type {ESLint.Plugin} */ (
+		/** @type {unknown} */ (importX)
+	),
 	jsdoc,
 	"no-secrets": noSecrets,
-	perfectionist,
+	perfectionist: /** @type {ESLint.Plugin} */ (
+		/** @type {unknown} */ (perfectionist)
+	),
 	promise,
 	redos,
 	regexp,
@@ -41,7 +58,7 @@ const plugins = {
 	sonarjs,
 	tailwindcss,
 	unicorn,
-	...react.configs.all.plugins
-};
+	...reactPlugins
+});
 
 export default plugins;

package/rules/depend.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const dependRules = {
 	"depend/ban-dependencies": "error"
 };

package/rules/eslint-comments.js

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

package/rules/func-params-args.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const funcParamsArgsRules = {
 	"func-params-args/func-args": [
 		"warn",

package/rules/github.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const githubRules = {
 	"github/a11y-aria-label-is-well-formatted": "error",
 	"github/a11y-no-title-attribute": "error",

package/rules/import-x.js

@@ -1,5 +1,12 @@
 import * as importRuleSets from "./import-x/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const importXRules = Object.values(importRuleSets)
 	.reduce(
 		(allRules, ruleSet) => ({

package/rules/jsdoc.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const jsdocRules = {
 	"jsdoc/check-access": "warn",
 	"jsdoc/check-alignment": "warn",

package/rules/jsx-a11y.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const jsxA11yRules = {
 	"jsx-a11y/alt-text": "error",
 	"jsx-a11y/anchor-ambiguous-text": [

package/rules/layout-and-formatting.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const layoutAndFormattingRules = {
 	"line-comment-position": "off",
 	"unicode-bom": ["error", "never"]

package/rules/no-secrets.js

@@ -1,5 +1,12 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
 const tolerance = 5;
 
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const noSecretsRules = {
 	"no-secrets/no-secrets": [
 		"error",

package/rules/no-unsanitized.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const noUnsanitizedRules = {
 	"no-unsanitized/method": "error",
 	"no-unsanitized/property": "error"

package/rules/perfectionist.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const perfectionistRules = {
 	"perfectionist/sort-array-includes": [
 		"error",

package/rules/possible-problems.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const possibleProblemsRules = {
 	"array-callback-return": "error",
 	"constructor-super": "error",

package/rules/promise.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const promiseRules = {
 	"promise/always-return": "error",
 	"promise/avoid-new": "off",

package/rules/react.js

@@ -1,5 +1,12 @@
 import * as reactRuleSets from "./react/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const reactRules = Object.values(reactRuleSets)
 	.reduce(
 		(allRules, ruleSet) => ({

package/rules/redos.js

@@ -1,5 +1,12 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
 const timeout = 10_000;
 
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const redosRules = {
 	"redos/no-vulnerable": [
 		"error",

package/rules/regexp.js

@@ -1,5 +1,12 @@
 import * as regexpRuleSets from "./regexp/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const regexpRules = Object.values(regexpRuleSets)
 	.reduce(
 		(allRules, ruleSet) => ({

package/rules/security.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const securityRules = {
 	"security/detect-bidi-characters": "warn",
 	"security/detect-buffer-noassert": "warn",

package/rules/sonarjs.js

@@ -1,5 +1,12 @@
 import * as sonarjsRuleSets from "./sonarjs/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const sonarjsRules = Object.values(sonarjsRuleSets)
 	.reduce(
 		(allRules, ruleSet) => ({

package/rules/stylistic.js

@@ -1,5 +1,12 @@
 import * as stylisticRuleSets from "./stylistic/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const stylisticRules = Object.values(stylisticRuleSets)
 	.reduce(
 		(allRules, ruleSet) => ({

package/rules/suggestions.js

@@ -1,3 +1,7 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
 const minIdentifierLength = 2;
 const maxIdentifierLength = 30;
 const maxClassesPerFile = 1;
@@ -8,6 +12,9 @@ const maxNestedCallbacks = 10;
 const maxParameters = 3;
 const maxStatements = 20;
 
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const suggestionsRules = {
 	"max-classes-per-file": ["error", maxClassesPerFile],
 	"max-depth": ["error", maxDepth],

package/rules/tailwindcss.js

@@ -1,3 +1,10 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const tailwindcssRules = {
 	"tailwindcss/classnames-order": "error",
 	"tailwindcss/enforces-negative-arbitrary-values": "error",

package/rules/unicorn.js

@@ -1,3 +1,7 @@
+/**
+ * @import { Linter } from "eslint"
+ */
+
 const hexadecimalGroupLength = 2;
 const binaryGroupLength = 4;
 const octalGroupLength = 4;
@@ -30,6 +34,9 @@ const patterns = {
 	"-->": "⟶"
 };
 
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const unicornRules = {
 	"unicorn/catch-error-name": "error",
 	"unicorn/consistent-destructuring": "error",

package/rules.js

@@ -1,8 +1,15 @@
 import * as ruleSets from "./rules/_exports.js";
 
+/**
+ * @import { Linter } from "eslint"
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
 const rules = Object.values(ruleSets)
 	.reduce(
-		(allRules, ruleSet) => ({
+		(allRules, ruleSet) => /** @type {const} */ ({
 			...allRules,
 			...ruleSet
 		}),