@kitschpatrol/eslint-config 5.0.7 → 5.1.0

package/bin/cli.js

@@ -627,6 +627,7 @@ var source_default = chalk;
 
 // ../../src/command-builder.ts
 import { cosmiconfig } from "cosmiconfig";
+import { TypeScriptLoader as typeScriptLoader } from "cosmiconfig-typescript-loader";
 import { execa } from "execa";
 import fse2 from "fs-extra";
 import fs3 from "node:fs";
@@ -5551,7 +5552,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // ../../package.json
-var version = "5.0.7";
+var version = "5.1.0";
 
 // ../../src/execa-utilities.ts
 function isErrorExecaError(error) {
@@ -5853,11 +5854,11 @@ async function executeCliCommand(logStream, positionalArguments, optionFlags, co
       env: {
         // Use colorful output unless NO_COLOR is set
         // eslint-disable-next-line ts/naming-convention
-        ...process.env.NO_COLOR === void 0 ? { FORCE_COLOR: "true" } : {},
-        // Quiet node for when processing *.config.ts files in Node 22
+        ...process.env.NO_COLOR === void 0 ? { FORCE_COLOR: "true" } : {}
+        // Quiet Node when processing *.config.ts files in Node 22
         // Suppress experimental type stripping warning with --no-warnings
-        // eslint-disable-next-line ts/naming-convention
-        NODE_OPTIONS: "--experimental-strip-types --disable-warning=ExperimentalWarning"
+        // TODO what's the story here on Node 20?
+        // NODE_OPTIONS: '--experimental-strip-types --disable-warning=ExperimentalWarning',
       },
       preferLocal: true,
       reject: false,
@@ -6180,6 +6181,14 @@ function getCosmiconfigCommand(configName) {
 }
 async function getCosmiconfigResult(configName) {
   const explorer = cosmiconfig(configName, {
+    loaders: {
+      // Using the alternate typescript loader fixes ERR_MODULE_NOT_FOUND errors
+      // in configuration files that import modules via a path
+      // https://github.com/cosmiconfig/cosmiconfig/issues/345
+      // https://github.com/Codex-/cosmiconfig-typescript-loader
+      // Same approach taken in mdat's implementation...
+      ".ts": typeScriptLoader()
+    },
     searchStrategy: "project"
     // Alt approach?
     // searchStrategy: 'global',

package/dist/index.d.ts

@@ -3338,12 +3338,12 @@ interface RuleOptions {
 	 */
 	'react-hooks-extra/prefer-use-state-lazy-initialization'?: Linter.RuleEntry<[]>
 	/**
-	 * enforce component naming convention to 'PascalCase' or 'CONSTANT_CASE'
+	 * enforce naming convention for components
 	 * @see https://eslint-react.xyz/docs/rules/naming-convention-component-name
 	 */
 	'react-naming-convention/component-name'?: Linter.RuleEntry<ReactNamingConventionComponentName>
 	/**
-	 * enforce context name to end with `Context`.
+	 * enforce context name to be a valid component name with the suffix 'Context'
 	 * @see https://eslint-react.xyz/docs/rules/naming-convention-context-name
 	 */
 	'react-naming-convention/context-name'?: Linter.RuleEntry<[]>
@@ -3413,7 +3413,7 @@ interface RuleOptions {
 	 */
 	'react/no-access-state-in-setstate'?: Linter.RuleEntry<[]>
 	/**
-	 * disallow using Array index as 'key'
+	 * disallow using an item's index in the array as its key
 	 * @see https://eslint-react.xyz/docs/rules/no-array-index-key
 	 */
 	'react/no-array-index-key'?: Linter.RuleEntry<[]>
@@ -18271,6 +18271,8 @@ type TsExplicitModuleBoundaryTypes =
 
 				allowHigherOrderFunctions?: boolean
 
+				allowOverloadFunctions?: boolean
+
 				allowTypedFunctionExpressions?: boolean
 			},
 	  ]
@@ -21761,6 +21763,8 @@ type TsUnifiedSignatures =
 	| [
 			{
 				ignoreDifferentlyNamedParameters?: boolean
+
+				ignoreOverloadsWithDifferentJSDoc?: boolean
 			},
 	  ]
 // ----- unicode-bom -----
@@ -22835,12 +22839,12 @@ declare function toArray<T>(value: T | T[]): T[];
  * Generates a Perfectionist sort configuration object from an array of strings
  * @see https://perfectionist.dev/rules/sort-objects#useconfigurationif
  * @param strings - Array of strings to generate config from
- * @param options - Configuration options
- * @param options.matchTrailing - Whether to match end of object parameter name instead of start, useful to sort based on suffixes
+ * @param matchType - How to match the strings:
+ *   - 'exact': Match exact name (default)
+ *   - 'leading': Match start of name (prefix)
+ *   - 'trailing': Match end of name (suffix)
  */
-declare function generatePerfectionistSortConfig(strings: string[], options?: {
-    matchTrailing?: boolean;
-}): {
+declare function generatePerfectionistSortConfig(strings: string[], matchType?: 'exact' | 'leading' | 'trailing'): {
     customGroups: Record<string, string>;
     groups: string[];
     useConfigurationIf: {

package/dist/index.js

@@ -1351,6 +1351,8 @@ var reactRecommendedTypeCheckedRules = {
   "react-hooks-extra/no-direct-set-state-in-use-effect": "warn",
   "react-hooks-extra/no-useless-custom-hooks": "warn",
   "react-hooks-extra/prefer-use-state-lazy-initialization": "warn",
+  "react-naming-convention/context-name": "warn",
+  "react-naming-convention/use-state": "warn",
   "react-dom/no-unknown-property": "off",
   "react/no-leaked-conditional-rendering": "warn"
   // End expansion
@@ -2302,13 +2304,40 @@ function renameRules(rules, map) {
 function toArray(value) {
   return Array.isArray(value) ? value : [value];
 }
-function generatePerfectionistSortConfig(strings, options) {
+function generatePerfectionistSortConfig(strings, matchType = "exact") {
   const customGroups = {};
   for (const string of strings) {
-    customGroups[string] = options?.matchTrailing ? `^.*${string}$` : `^${string}$`;
+    switch (matchType) {
+      case "exact": {
+        customGroups[string] = `^${string}$`;
+        break;
+      }
+      case "leading": {
+        customGroups[string] = `^${string}.*$`;
+        break;
+      }
+      case "trailing": {
+        customGroups[string] = `^.*${string}$`;
+        break;
+      }
+    }
   }
   const exactMatch = strings.join("|");
-  const pattern = options?.matchTrailing ? `^.+(${strings.map((s) => s).join("|")})$` : `^${exactMatch}$`;
+  let pattern;
+  switch (matchType) {
+    case "exact": {
+      pattern = `^(${exactMatch})$`;
+      break;
+    }
+    case "leading": {
+      pattern = `^(${strings.join("|")}).*$`;
+      break;
+    }
+    case "trailing": {
+      pattern = `^.*(${strings.join("|")})$`;
+      break;
+    }
+  }
   return {
     customGroups,
     groups: strings,
@@ -2378,9 +2407,12 @@ var sharedScriptConfig = {
     "import/default": "off",
     // Cope with Astro virtual modules
     // https://github.com/hannoeru/vite-plugin-pages/issues/41#issuecomment-1371880072
-    "import/no-unresolved": ["error", { ignore: ["^astro:"] }],
+    "import/no-unresolved": ["error", { ignore: ["^astro:", "^@astrojs"] }],
     "import/order": "off",
     // Conflicts with perfectionist/sort-imports (but never enabled)
+    // Knip workaround to ignore unused exported class members:
+    // https://github.com/webpro-nl/knip/issues/158#issuecomment-1632648598
+    "jsdoc/check-tag-names": ["error", { definedTags: ["public"] }],
     "jsdoc/require-description": ["error", { descriptionStyle: "body" }],
     "jsdoc/require-jsdoc": [
       "error",
@@ -2414,19 +2446,28 @@ var sharedScriptConfig = {
     "perfectionist/sort-modules": "off",
     "perfectionist/sort-objects": [
       "error",
-      generatePerfectionistSortConfig(["X", "Y", "Z", "W"], { matchTrailing: true }),
-      generatePerfectionistSortConfig(["Min", "Max"], { matchTrailing: true }),
-      generatePerfectionistSortConfig(["Width", "Height"], { matchTrailing: true }),
       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(["min", "max"]),
+      generatePerfectionistSortConfig(["min", "max"], "leading"),
+      generatePerfectionistSortConfig(["Min", "Max"], "trailing"),
       generatePerfectionistSortConfig(["width", "height"]),
+      generatePerfectionistSortConfig(["width", "height"], "leading"),
+      generatePerfectionistSortConfig(["Width", "Height"], "trailing"),
       { newlinesBetween: "never", order: "asc", type: "natural" }
     ],
     "sort-imports": "off",
@@ -2488,6 +2529,31 @@ var sharedScriptConfig = {
       // },
     ],
     "ts/no-non-null-assertion": "off",
+    "ts/no-restricted-types": [
+      "error",
+      {
+        types: {
+          "[[[[[]]]]]": "Don't use `[[[[[]]]]]`. Use `SomeType[][][][][]` instead.",
+          "[[[[]]]]": "Don't use `[[[[]]]]`. Use `SomeType[][][][]` instead.",
+          "[[[]]]": "Don't use `[[[]]]`. Use `SomeType[][][]` instead.",
+          "[[]]": "Don't use `[[]]`. It only allows an array with a single element which is an empty array. Use `SomeType[][]` instead.",
+          "[]": "Don't use the empty array type `[]`. It only allows empty arrays. Use `SomeType[]` instead.",
+          // eslint-disable-next-line ts/naming-convention
+          Buffer: {
+            message: "Use Uint8Array instead. See: https://sindresorhus.com/blog/goodbye-nodejs-buffer",
+            suggest: ["Uint8Array"]
+          },
+          null: {
+            message: "Use `undefined` instead. See: https://github.com/sindresorhus/meta/issues/7",
+            suggest: ["undefined"]
+          },
+          object: {
+            message: "The `object` type is hard to use. Use `Record<string, unknown>` instead. See: https://github.com/typescript-eslint/typescript-eslint/pull/848",
+            suggest: ["Record<string, unknown>"]
+          }
+        }
+      }
+    ],
     "ts/no-unused-vars": [
       "error",
       {
@@ -3725,6 +3791,15 @@ async function svelte(options = {}) {
         // Error often imported from from '@sveltejs/kit in SvelteKit files
         "ts/no-throw-literal": "off"
       }
+    },
+    {
+      // SvelteKit and Vite project templates bootstrap with some deviant HTML
+      files: ["src/app.html"],
+      rules: {
+        "html/no-inline-styles": "off",
+        "html/no-non-scalable-viewport": "off",
+        "html/require-title": "off"
+      }
     }
   ];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/eslint-config",
-  "version": "5.0.7",
+  "version": "5.1.0",
   "description": "ESLint configuration for @kitschpatrol/shared-config.",
   "keywords": [
     "shared-config",
@@ -42,12 +42,12 @@
   ],
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
-    "@eslint-react/eslint-plugin": "^1.29.0",
+    "@eslint-react/eslint-plugin": "^1.30.0",
     "@html-eslint/eslint-plugin": "^0.35.0",
     "@html-eslint/parser": "^0.35.0",
     "@pinojs/json-colorizer": "^4.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.25.0",
-    "@typescript-eslint/parser": "^8.25.0",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
     "@vitest/eslint-plugin": "^1.1.36",
     "astro-eslint-parser": "^1.2.1",
     "eslint": "^9.21.0",
@@ -77,8 +77,8 @@
     "fs-extra": "^11.3.0",
     "globals": "^16.0.0",
     "jsonc-eslint-parser": "^2.4.0",
-    "local-pkg": "^1.1.0",
-    "prettier": "^3.5.2",
+    "local-pkg": "^1.1.1",
+    "prettier": "^3.5.3",
     "sort-package-json": "^2.15.1",
     "svelte-eslint-parser": "^1.0.0",
     "toml-eslint-parser": "^0.10.0",
@@ -92,7 +92,7 @@
     "eslint-config-xo-typescript": "^7.0.0",
     "eslint-typegen": "^2.0.0",
     "globby": "^14.1.0",
-    "svelte": "^5.20.5",
+    "svelte": "^5.21.0",
     "tsup": "^8.4.0"
   },
   "engines": {