@kitschpatrol/eslint-config 5.7.2 → 5.7.3

package/bin/cli.js

@@ -5138,7 +5138,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // ../../package.json
-var version = "5.7.2";
+var version = "5.7.3";
 
 // ../../src/execa-utilities.ts
 function isErrorExecaError(error) {

package/dist/index.d.ts

@@ -1451,6 +1451,26 @@ interface RuleOptions {
 	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header
 	 */
 	'jsdoc/text-escaping'?: Linter.RuleEntry<JsdocTextEscaping>
+	/**
+	 * Prefers either function properties or method signatures
+	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-method-signature-style.md#repos-sticky-header
+	 */
+	'jsdoc/ts-method-signature-style'?: Linter.RuleEntry<JsdocTsMethodSignatureStyle>
+	/**
+	 * Warns against use of the empty object type
+	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-empty-object-type.md#repos-sticky-header
+	 */
+	'jsdoc/ts-no-empty-object-type'?: Linter.RuleEntry<[]>
+	/**
+	 * Catches unnecessary template expressions such as string expressions within a template literal.
+	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-unnecessary-template-expression.md#repos-sticky-header
+	 */
+	'jsdoc/ts-no-unnecessary-template-expression'?: Linter.RuleEntry<JsdocTsNoUnnecessaryTemplateExpression>
+	/**
+	 * Prefers function types over call signatures when there are no other properties.
+	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-prefer-function-type.md#repos-sticky-header
+	 */
+	'jsdoc/ts-prefer-function-type'?: Linter.RuleEntry<JsdocTsPreferFunctionType>
 	/**
 	 * Formats JSDoc type values.
 	 * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/type-formatting.md#repos-sticky-header
@@ -4912,7 +4932,7 @@ interface RuleOptions {
 	 */
 	'template-tag-spacing'?: Linter.RuleEntry<TemplateTagSpacing>
 	/**
-	 * require .spec test file pattern
+	 * require test file pattern
 	 * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
 	 */
 	'test/consistent-test-filename'?: Linter.RuleEntry<TestConsistentTestFilename>
@@ -9414,6 +9434,32 @@ type JsdocTextEscaping =
 				escapeMarkdown?: boolean
 			},
 	  ]
+// ----- jsdoc/ts-method-signature-style -----
+type JsdocTsMethodSignatureStyle =
+	| []
+	| ['method' | 'property']
+	| [
+			'method' | 'property',
+			{
+				enableFixer?: boolean
+			},
+	  ]
+// ----- jsdoc/ts-no-unnecessary-template-expression -----
+type JsdocTsNoUnnecessaryTemplateExpression =
+	| []
+	| [
+			{
+				enableFixer?: boolean
+			},
+	  ]
+// ----- jsdoc/ts-prefer-function-type -----
+type JsdocTsPreferFunctionType =
+	| []
+	| [
+			{
+				enableFixer?: boolean
+			},
+	  ]
 // ----- jsdoc/type-formatting -----
 type JsdocTypeFormatting =
 	| []
@@ -9421,10 +9467,36 @@ type JsdocTypeFormatting =
 			{
 				arrayBrackets?: 'angle' | 'square'
 
+				arrowFunctionPostReturnMarkerSpacing?: string
+
+				arrowFunctionPreReturnMarkerSpacing?: string
+
 				enableFixer?: boolean
 
+				functionOrClassParameterSpacing?: string
+
+				functionOrClassPostGenericSpacing?: string
+
+				functionOrClassPostReturnMarkerSpacing?: string
+
+				functionOrClassPreReturnMarkerSpacing?: string
+
+				functionOrClassTypeParameterSpacing?: string
+
+				genericAndTupleElementSpacing?: string
+
 				genericDot?: boolean
 
+				keyValuePostColonSpacing?: string
+
+				keyValuePostKeySpacing?: string
+
+				keyValuePostOptionalSpacing?: string
+
+				keyValuePostVariadicSpacing?: string
+
+				methodQuotes?: 'double' | 'single'
+
 				objectFieldIndent?: string
 
 				objectFieldQuote?: 'double' | 'single' | null
@@ -9440,6 +9512,12 @@ type JsdocTypeFormatting =
 
 				objectFieldSeparatorTrailingPunctuation?: boolean
 
+				parameterDefaultValueSpacing?: string
+
+				postMethodNameSpacing?: string
+
+				postNewSpacing?: string
+
 				separatorForSingleObjectField?: boolean
 
 				stringQuotes?: 'double' | 'single'
@@ -19411,7 +19489,6 @@ type ReactNoForbiddenProps =
 							prop: string
 					  }
 				)[]
-				[k: string]: unknown | undefined
 			},
 	  ]
 // ----- react/no-useless-fragment -----

package/dist/index.js

@@ -602,6 +602,10 @@ var jsdocCommentsRecommendedTypescriptFlavorRules = {
   "jsdoc/sort-tags": "off",
   "jsdoc/tag-lines": "warn",
   "jsdoc/text-escaping": "off",
+  "jsdoc/ts-method-signature-style": "off",
+  "jsdoc/ts-no-empty-object-type": "warn",
+  "jsdoc/ts-no-unnecessary-template-expression": "off",
+  "jsdoc/ts-prefer-function-type": "off",
   "jsdoc/type-formatting": "off",
   "jsdoc/valid-types": "warn"
   // End expansion
@@ -676,6 +680,10 @@ var jsdocCommentsRecommendedTypescriptRules = {
   "jsdoc/sort-tags": "off",
   "jsdoc/tag-lines": "warn",
   "jsdoc/text-escaping": "off",
+  "jsdoc/ts-method-signature-style": "off",
+  "jsdoc/ts-no-empty-object-type": "warn",
+  "jsdoc/ts-no-unnecessary-template-expression": "off",
+  "jsdoc/ts-prefer-function-type": "off",
   "jsdoc/type-formatting": "off",
   "jsdoc/valid-types": "warn"
   // End expansion
@@ -1371,10 +1379,6 @@ var reactRecommendedTypeCheckedRules = {
   // Begin expansion '@eslint-react/eslint-plugin' 'recommended-type-checked'
   "react/jsx-no-comment-textnodes": "warn",
   "react/jsx-no-duplicate-props": "off",
-  "react/jsx-no-iife": "off",
-  "react/jsx-no-undef": "off",
-  "react/jsx-shorthand-boolean": "off",
-  "react/jsx-shorthand-fragment": "off",
   "react/jsx-uses-react": "off",
   "react/jsx-uses-vars": "off",
   "react/no-access-state-in-setstate": "error",
@@ -1383,9 +1387,7 @@ var reactRecommendedTypeCheckedRules = {
   "react/no-children-for-each": "warn",
   "react/no-children-map": "warn",
   "react/no-children-only": "warn",
-  "react/no-children-prop": "off",
   "react/no-children-to-array": "warn",
-  "react/no-class-component": "off",
   "react/no-clone-element": "warn",
   "react/no-component-will-mount": "error",
   "react/no-component-will-receive-props": "error",
@@ -1395,14 +1397,9 @@ var reactRecommendedTypeCheckedRules = {
   "react/no-default-props": "error",
   "react/no-direct-mutation-state": "error",
   "react/no-duplicate-key": "error",
-  "react/no-forbidden-props": "off",
   "react/no-forward-ref": "warn",
   "react/no-implicit-key": "warn",
-  "react/no-leaked-conditional-rendering": "warn",
-  "react/no-missing-component-display-name": "off",
-  "react/no-missing-context-display-name": "off",
   "react/no-missing-key": "error",
-  "react/no-misused-capture-owner-stack": "off",
   "react/no-nested-component-definitions": "error",
   "react/no-nested-lazy-component-declarations": "error",
   "react/no-prop-types": "error",
@@ -1411,38 +1408,24 @@ var reactRecommendedTypeCheckedRules = {
   "react/no-set-state-in-component-did-update": "warn",
   "react/no-set-state-in-component-will-update": "warn",
   "react/no-string-refs": "error",
-  "react/no-unnecessary-key": "off",
-  "react/no-unnecessary-use-callback": "off",
-  "react/no-unnecessary-use-memo": "off",
   "react/no-unnecessary-use-prefix": "warn",
   "react/no-unsafe-component-will-mount": "warn",
   "react/no-unsafe-component-will-receive-props": "warn",
   "react/no-unsafe-component-will-update": "warn",
-  "react/no-unstable-context-value": "warn",
-  "react/no-unstable-default-props": "warn",
   "react/no-unused-class-component-members": "warn",
-  "react/no-unused-props": "warn",
-  "react/no-unused-state": "warn",
   "react/no-use-context": "warn",
   "react/no-useless-forward-ref": "warn",
-  "react/no-useless-fragment": "off",
-  "react/prefer-destructuring-assignment": "off",
-  "react/prefer-namespace-import": "off",
-  "react/prefer-read-only-props": "off",
   "react/prefer-use-state-lazy-initialization": "warn",
   "react-dom/no-dangerously-set-innerhtml": "warn",
   "react-dom/no-dangerously-set-innerhtml-with-children": "error",
   "react-dom/no-find-dom-node": "error",
   "react-dom/no-flush-sync": "error",
   "react-dom/no-hydrate": "error",
-  "react-dom/no-missing-button-type": "warn",
-  "react-dom/no-missing-iframe-sandbox": "warn",
   "react-dom/no-namespace": "error",
   "react-dom/no-render": "error",
   "react-dom/no-render-return-value": "error",
   "react-dom/no-script-url": "warn",
   "react-dom/no-unsafe-iframe-sandbox": "warn",
-  "react-dom/no-unsafe-target-blank": "warn",
   "react-dom/no-use-form-state": "error",
   "react-dom/no-void-elements-with-children": "error",
   "react-web-api/no-leaked-event-listener": "warn",
@@ -1453,7 +1436,9 @@ var reactRecommendedTypeCheckedRules = {
   "react-naming-convention/context-name": "warn",
   "react-naming-convention/use-state": "warn",
   "react-dom/no-string-style-prop": "off",
-  "react-dom/no-unknown-property": "off"
+  "react-dom/no-unknown-property": "off",
+  "react/jsx-no-undef": "off",
+  "react/no-leaked-conditional-rendering": "error"
   // End expansion
 };
 var reactDisableTypeCheckedRules = {
@@ -2488,6 +2473,46 @@ var kpSharedDisableTypeCheckedRules = {
   "jsdoc/check-tag-names": ["error", { typed: false }],
   "jsdoc/no-types": "off"
 };
+var kpPerfectionistSortConfig = [
+  // Note precedence sensitivity...
+  // This has to come before the `min` rules to sort
+  // strings like `{ minImageWidth: 1, minImageHeight: 1 }` correctly
+  generatePerfectionistSortConfig(["width", "height"]),
+  generatePerfectionistSortConfig(["width", "height"], "leading"),
+  generatePerfectionistSortConfig(["Width", "Height"], "trailing"),
+  generatePerfectionistSortConfig(["r", "g", "b"]),
+  generatePerfectionistSortConfig(["R", "G", "B"], "trailing"),
+  generatePerfectionistSortConfig(["red", "green", "blue"]),
+  generatePerfectionistSortConfig(["Red", "Green", "Blue"], "trailing"),
+  generatePerfectionistSortConfig(["h", "s", "l"]),
+  generatePerfectionistSortConfig(["hue", "saturation", "lightness"]),
+  generatePerfectionistSortConfig(["h", "s", "l", "a"]),
+  generatePerfectionistSortConfig(["hue", "saturation", "lightness", "alpha"]),
+  generatePerfectionistSortConfig(["h", "s", "v"]),
+  generatePerfectionistSortConfig(["a", "b"]),
+  // For partial matches...
+  generatePerfectionistSortConfig(["r", "g", "b", "a"]),
+  generatePerfectionistSortConfig(["red", "green", "blue", "alpha"]),
+  generatePerfectionistSortConfig(["Red", "Green", "Blue", "Alpha"], "trailing"),
+  generatePerfectionistSortConfig(["x", "y", "z", "w"]),
+  generatePerfectionistSortConfig(["x", "y", "z", "w"], "leading"),
+  generatePerfectionistSortConfig(["X", "Y", "Z", "W"], "trailing"),
+  generatePerfectionistSortConfig(["x1", "y1", "x2", "y2"]),
+  generatePerfectionistSortConfig(["x1", "y1", "x2", "y2"], "leading"),
+  generatePerfectionistSortConfig(["X1", "Y1", "X2", "Y2"], "trailing"),
+  generatePerfectionistSortConfig(["x1", "y1", "x2", "y2", "z1", "z2"]),
+  generatePerfectionistSortConfig(["x1", "y1", "x2", "y2", "z1", "z2"], "leading"),
+  generatePerfectionistSortConfig(["X1", "Y1", "X2", "Y2", "Z1", "Z2"], "trailing"),
+  generatePerfectionistSortConfig(["open", "close"]),
+  generatePerfectionistSortConfig(["open", "close"], "leading"),
+  generatePerfectionistSortConfig(["Open", "Close"], "trailing"),
+  generatePerfectionistSortConfig(["start", "end"]),
+  generatePerfectionistSortConfig(["start", "end"], "leading"),
+  generatePerfectionistSortConfig(["Start", "End"], "trailing"),
+  generatePerfectionistSortConfig(["min", "max"]),
+  generatePerfectionistSortConfig(["min", "max"], "leading"),
+  generatePerfectionistSortConfig(["Min", "Max"], "trailing")
+];
 var sharedScriptConfig = {
   plugins: {
     depend: pluginDepend,
@@ -2587,39 +2612,14 @@ var sharedScriptConfig = {
     ],
     // Too chaotic... but should revisit
     "perfectionist/sort-modules": "off",
+    "perfectionist/sort-object-types": [
+      "error",
+      ...kpPerfectionistSortConfig,
+      { newlinesBetween: "never", order: "asc", type: "natural" }
+    ],
     "perfectionist/sort-objects": [
       "error",
-      // Note precedence sensitivity...
-      // This has to come before the `min` rules to sort
-      // strings like `{ minImageWidth: 1, minImageHeight: 1 }` correctly
-      generatePerfectionistSortConfig(["width", "height"]),
-      generatePerfectionistSortConfig(["width", "height"], "leading"),
-      generatePerfectionistSortConfig(["Width", "Height"], "trailing"),
-      generatePerfectionistSortConfig(["r", "g", "b"]),
-      generatePerfectionistSortConfig(["R", "G", "B"], "trailing"),
-      generatePerfectionistSortConfig(["red", "green", "blue"]),
-      generatePerfectionistSortConfig(["Red", "Green", "Blue"], "trailing"),
-      generatePerfectionistSortConfig(["h", "s", "l"]),
-      generatePerfectionistSortConfig(["hue", "saturation", "lightness"]),
-      generatePerfectionistSortConfig(["h", "s", "l", "a"]),
-      generatePerfectionistSortConfig(["hue", "saturation", "lightness", "alpha"]),
-      generatePerfectionistSortConfig(["h", "s", "v"]),
-      generatePerfectionistSortConfig(["a", "b"]),
-      // For partial matches...
-      generatePerfectionistSortConfig(["r", "g", "b", "a"]),
-      generatePerfectionistSortConfig(["red", "green", "blue", "alpha"]),
-      generatePerfectionistSortConfig(["Red", "Green", "Blue", "Alpha"], "trailing"),
-      generatePerfectionistSortConfig(["x", "y", "z", "w"]),
-      generatePerfectionistSortConfig(["X", "Y", "Z", "W"], "trailing"),
-      generatePerfectionistSortConfig(["open", "close"]),
-      generatePerfectionistSortConfig(["open", "close"], "leading"),
-      generatePerfectionistSortConfig(["Open", "Close"], "trailing"),
-      generatePerfectionistSortConfig(["start", "end"]),
-      generatePerfectionistSortConfig(["start", "end"], "leading"),
-      generatePerfectionistSortConfig(["Start", "End"], "trailing"),
-      generatePerfectionistSortConfig(["min", "max"]),
-      generatePerfectionistSortConfig(["min", "max"], "leading"),
-      generatePerfectionistSortConfig(["Min", "Max"], "trailing"),
+      ...kpPerfectionistSortConfig,
       { newlinesBetween: "never", order: "asc", type: "natural" }
     ],
     "sort-imports": "off",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/eslint-config",
-  "version": "5.7.2",
+  "version": "5.7.3",
   "description": "ESLint configuration for @kitschpatrol/shared-config.",
   "keywords": [
     "shared-config",
@@ -43,13 +43,13 @@
   ],
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
-    "@eslint-react/eslint-plugin": "^2.0.6",
+    "@eslint-react/eslint-plugin": "2.1.1",
     "@html-eslint/eslint-plugin": "^0.47.0",
     "@html-eslint/parser": "^0.47.0",
     "@pinojs/json-colorizer": "^4.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.46.0",
-    "@typescript-eslint/parser": "^8.46.0",
-    "@vitest/eslint-plugin": "^1.3.16",
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
+    "@vitest/eslint-plugin": "^1.3.20",
     "astro-eslint-parser": "^1.2.2",
     "eslint": "^9.37.0",
     "eslint-config-flat-gitignore": "^2.1.0",
@@ -60,13 +60,13 @@
     "eslint-plugin-depend": "^1.3.1",
     "eslint-plugin-html": "^8.1.3",
     "eslint-plugin-import-x": "^4.16.1",
-    "eslint-plugin-jsdoc": "^60.8.3",
+    "eslint-plugin-jsdoc": "^61.1.3",
     "eslint-plugin-jsonc": "^2.21.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-mdx": "^3.6.2",
     "eslint-plugin-n": "^17.23.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-package-json": "^0.56.3",
+    "eslint-plugin-package-json": "^0.56.4",
     "eslint-plugin-perfectionist": "^4.15.1",
     "eslint-plugin-regexp": "^2.10.0",
     "eslint-plugin-svelte": "^3.12.4",
@@ -93,7 +93,8 @@
     "eslint-config-xo-typescript": "^9.0.0",
     "eslint-typegen": "^2.3.0",
     "globby": "^15.0.0",
-    "svelte": "^5.39.9",
+    "svelte": "^5.40.0",
+    "to-valid-identifier": "^0.1.1",
     "tsup": "^8.5.0"
   },
   "engines": {

package/readme.md

@@ -40,14 +40,14 @@ To use just this ESLint config in isolation:
 1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
 
    ```sh
-   pnpm dlx @kitschpatrol/repo-config init
+   pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init
    ```
 
 2. Install and initialize the required TypeScript `tsconfig.json` configuration in your project root:
 
    ```sh
    pnpm add -D @kitschpatrol/typescript-config
-   pnpm dlx @kitschpatrol/typescript-config init
+   pnpm --package=@kitschpatrol/typescript-config dlx ksc-typescript init
    ```
 
 3. Add the package: