@tanstack/eslint-plugin-router 1.154.7 → 1.161.2

package/dist/cjs/index.cjs

@@ -11,7 +11,8 @@ Object.assign(plugin.configs, {
   recommended: {
     plugins: ["@tanstack/eslint-plugin-router"],
     rules: {
-      "@tanstack/router/create-route-property-order": "warn"
+      "@tanstack/router/create-route-property-order": "warn",
+      "@tanstack/router/route-param-names": "error"
     }
   },
   "flat/recommended": [
@@ -20,7 +21,8 @@ Object.assign(plugin.configs, {
         "@tanstack/router": plugin
       },
       rules: {
-        "@tanstack/router/create-route-property-order": "warn"
+        "@tanstack/router/create-route-property-order": "warn",
+        "@tanstack/router/route-param-names": "error"
       }
     }
   ]

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["import { rules } from './rules'\nimport type { ESLint, Linter } from 'eslint'\nimport type { RuleModule } from '@typescript-eslint/utils/ts-eslint'\n\ntype RuleKey = keyof typeof rules\n\ninterface Plugin extends Omit<ESLint.Plugin, 'rules'> {\n  rules: Record<RuleKey, RuleModule<any, any, any>>\n  configs: {\n    recommended: ESLint.ConfigData\n    'flat/recommended': Array<Linter.FlatConfig>\n  }\n}\n\nconst plugin: Plugin = {\n  meta: {\n    name: '@tanstack/eslint-plugin-router',\n  },\n  configs: {} as Plugin['configs'],\n  rules,\n}\n\n// Assign configs here so we can reference `plugin`\nObject.assign(plugin.configs, {\n  recommended: {\n    plugins: ['@tanstack/eslint-plugin-router'],\n    rules: {\n      '@tanstack/router/create-route-property-order': 'warn',\n    },\n  },\n  'flat/recommended': [\n    {\n      plugins: {\n        '@tanstack/router': plugin,\n      },\n      rules: {\n        '@tanstack/router/create-route-property-order': 'warn',\n      },\n    },\n  ],\n})\n\nexport default plugin\n"],"names":["rules"],"mappings":";;AAcA,MAAM,SAAiB;AAAA,EACrB,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,SAAS,CAAA;AAAA,EAAC,OACVA,MAAAA;AACF;AAGA,OAAO,OAAO,OAAO,SAAS;AAAA,EAC5B,aAAa;AAAA,IACX,SAAS,CAAC,gCAAgC;AAAA,IAC1C,OAAO;AAAA,MACL,gDAAgD;AAAA,IAAA;AAAA,EAClD;AAAA,EAEF,oBAAoB;AAAA,IAClB;AAAA,MACE,SAAS;AAAA,QACP,oBAAoB;AAAA,MAAA;AAAA,MAEtB,OAAO;AAAA,QACL,gDAAgD;AAAA,MAAA;AAAA,IAClD;AAAA,EACF;AAEJ,CAAC;;"}
+{"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["import { rules } from './rules'\nimport type { ESLint, Linter } from 'eslint'\nimport type { RuleModule } from '@typescript-eslint/utils/ts-eslint'\n\ntype RuleKey = keyof typeof rules\n\ninterface Plugin extends Omit<ESLint.Plugin, 'rules'> {\n  rules: Record<RuleKey, RuleModule<any, any, any>>\n  configs: {\n    recommended: ESLint.ConfigData\n    'flat/recommended': Array<Linter.FlatConfig>\n  }\n}\n\nconst plugin: Plugin = {\n  meta: {\n    name: '@tanstack/eslint-plugin-router',\n  },\n  configs: {} as Plugin['configs'],\n  rules,\n}\n\n// Assign configs here so we can reference `plugin`\nObject.assign(plugin.configs, {\n  recommended: {\n    plugins: ['@tanstack/eslint-plugin-router'],\n    rules: {\n      '@tanstack/router/create-route-property-order': 'warn',\n      '@tanstack/router/route-param-names': 'error',\n    },\n  },\n  'flat/recommended': [\n    {\n      plugins: {\n        '@tanstack/router': plugin,\n      },\n      rules: {\n        '@tanstack/router/create-route-property-order': 'warn',\n        '@tanstack/router/route-param-names': 'error',\n      },\n    },\n  ],\n})\n\nexport default plugin\n"],"names":["rules"],"mappings":";;AAcA,MAAM,SAAiB;AAAA,EACrB,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,SAAS,CAAA;AAAA,EAAC,OACVA,MAAAA;AACF;AAGA,OAAO,OAAO,OAAO,SAAS;AAAA,EAC5B,aAAa;AAAA,IACX,SAAS,CAAC,gCAAgC;AAAA,IAC1C,OAAO;AAAA,MACL,gDAAgD;AAAA,MAChD,sCAAsC;AAAA,IAAA;AAAA,EACxC;AAAA,EAEF,oBAAoB;AAAA,IAClB;AAAA,MACE,SAAS;AAAA,QACP,oBAAoB;AAAA,MAAA;AAAA,MAEtB,OAAO;AAAA,QACL,gDAAgD;AAAA,QAChD,sCAAsC;AAAA,MAAA;AAAA,IACxC;AAAA,EACF;AAEJ,CAAC;;"}

package/dist/cjs/rules/route-param-names/constants.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const pathAsFirstArgFunctions = [
+  "createFileRoute",
+  "createLazyFileRoute",
+  "createLazyRoute"
+];
+const pathAsPropertyFunctions = ["createRoute"];
+const VALID_PARAM_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
+exports.VALID_PARAM_NAME_REGEX = VALID_PARAM_NAME_REGEX;
+exports.pathAsFirstArgFunctions = pathAsFirstArgFunctions;
+exports.pathAsPropertyFunctions = pathAsPropertyFunctions;
+//# sourceMappingURL=constants.cjs.map

package/dist/cjs/rules/route-param-names/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sources":["../../../../src/rules/route-param-names/constants.ts"],"sourcesContent":["/**\n * Functions where the path is passed as the first argument (string literal)\n * e.g., createFileRoute('/path/$param')(...)\n */\nexport const pathAsFirstArgFunctions = [\n  'createFileRoute',\n  'createLazyFileRoute',\n  'createLazyRoute',\n] as const\n\nexport type PathAsFirstArgFunction = (typeof pathAsFirstArgFunctions)[number]\n\n/**\n * Functions where the path is a property in the options object\n * e.g., createRoute({ path: '/path/$param' })\n */\nexport const pathAsPropertyFunctions = ['createRoute'] as const\n\nexport type PathAsPropertyFunction = (typeof pathAsPropertyFunctions)[number]\n\n/**\n * All route functions that need param name validation\n */\nexport const allRouteFunctions = [\n  ...pathAsFirstArgFunctions,\n  ...pathAsPropertyFunctions,\n] as const\n\nexport type RouteFunction = (typeof allRouteFunctions)[number]\n\n/**\n * Regex for valid JavaScript identifier (param name)\n * Must start with letter, underscore, or dollar sign\n * Can contain letters, numbers, underscores, or dollar signs\n */\nexport const VALID_PARAM_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/\n"],"names":[],"mappings":";;AAIO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AACF;AAQO,MAAM,0BAA0B,CAAC,aAAa;AAmB9C,MAAM,yBAAyB;;;;"}

package/dist/cjs/rules/route-param-names/constants.d.cts

@@ -0,0 +1,23 @@
+/**
+ * Functions where the path is passed as the first argument (string literal)
+ * e.g., createFileRoute('/path/$param')(...)
+ */
+export declare const pathAsFirstArgFunctions: readonly ["createFileRoute", "createLazyFileRoute", "createLazyRoute"];
+export type PathAsFirstArgFunction = (typeof pathAsFirstArgFunctions)[number];
+/**
+ * Functions where the path is a property in the options object
+ * e.g., createRoute({ path: '/path/$param' })
+ */
+export declare const pathAsPropertyFunctions: readonly ["createRoute"];
+export type PathAsPropertyFunction = (typeof pathAsPropertyFunctions)[number];
+/**
+ * All route functions that need param name validation
+ */
+export declare const allRouteFunctions: readonly ["createFileRoute", "createLazyFileRoute", "createLazyRoute", "createRoute"];
+export type RouteFunction = (typeof allRouteFunctions)[number];
+/**
+ * Regex for valid JavaScript identifier (param name)
+ * Must start with letter, underscore, or dollar sign
+ * Can contain letters, numbers, underscores, or dollar signs
+ */
+export declare const VALID_PARAM_NAME_REGEX: RegExp;

package/dist/cjs/rules/route-param-names/route-param-names.rule.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const utils = require("@typescript-eslint/utils");
+const getDocsUrl = require("../../utils/get-docs-url.cjs");
+const detectRouterImports = require("../../utils/detect-router-imports.cjs");
+const routeParamNames_utils = require("./route-param-names.utils.cjs");
+const constants = require("./constants.cjs");
+const createRule = utils.ESLintUtils.RuleCreator(getDocsUrl.getDocsUrl);
+const pathAsFirstArgSet = new Set(constants.pathAsFirstArgFunctions);
+const pathAsPropertySet = new Set(constants.pathAsPropertyFunctions);
+const name = "route-param-names";
+const rule = createRule({
+  name,
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Ensure route param names are valid JavaScript identifiers",
+      recommended: "error"
+    },
+    messages: {
+      invalidParamName: 'Invalid param name "{{paramName}}" in route path. Param names must be valid JavaScript identifiers (match /[a-zA-Z_$][a-zA-Z0-9_$]*/).'
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create: detectRouterImports.detectTanstackRouterImports((context, _, helpers) => {
+    function reportInvalidParams(node, path) {
+      const invalidParams = routeParamNames_utils.getInvalidParams(path);
+      for (const param of invalidParams) {
+        context.report({
+          node,
+          messageId: "invalidParamName",
+          data: { paramName: param.paramName }
+        });
+      }
+    }
+    function getStringLiteralValue(node) {
+      if (node.type === utils.AST_NODE_TYPES.Literal && typeof node.value === "string") {
+        return node.value;
+      }
+      if (node.type === utils.AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1) {
+        const cooked = node.quasis[0]?.value.cooked;
+        if (cooked != null) {
+          return cooked;
+        }
+      }
+      return null;
+    }
+    return {
+      CallExpression(node) {
+        if (node.callee.type === utils.AST_NODE_TYPES.Identifier) {
+          const funcName = node.callee.name;
+          if (!helpers.isTanstackRouterImport(node.callee)) {
+            return;
+          }
+          if (pathAsPropertySet.has(funcName)) {
+            const arg = node.arguments[0];
+            if (arg?.type === utils.AST_NODE_TYPES.ObjectExpression) {
+              for (const prop of arg.properties) {
+                if (prop.type === utils.AST_NODE_TYPES.Property) {
+                  const isPathKey = prop.key.type === utils.AST_NODE_TYPES.Identifier && prop.key.name === "path" || prop.key.type === utils.AST_NODE_TYPES.Literal && prop.key.value === "path";
+                  if (isPathKey) {
+                    const pathValue = getStringLiteralValue(prop.value);
+                    if (pathValue) {
+                      reportInvalidParams(prop.value, pathValue);
+                    }
+                  }
+                }
+              }
+            }
+            return;
+          }
+        }
+        if (node.callee.type === utils.AST_NODE_TYPES.CallExpression) {
+          const innerCall = node.callee;
+          if (innerCall.callee.type === utils.AST_NODE_TYPES.Identifier) {
+            const funcName = innerCall.callee.name;
+            if (!helpers.isTanstackRouterImport(innerCall.callee)) {
+              return;
+            }
+            if (pathAsFirstArgSet.has(funcName)) {
+              const pathArg = innerCall.arguments[0];
+              if (pathArg) {
+                const pathValue = getStringLiteralValue(pathArg);
+                if (pathValue) {
+                  reportInvalidParams(pathArg, pathValue);
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+  })
+});
+exports.name = name;
+exports.rule = rule;
+//# sourceMappingURL=route-param-names.rule.cjs.map

package/dist/cjs/rules/route-param-names/route-param-names.rule.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-param-names.rule.cjs","sources":["../../../../src/rules/route-param-names/route-param-names.rule.ts"],"sourcesContent":["import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'\n\nimport { getDocsUrl } from '../../utils/get-docs-url'\nimport { detectTanstackRouterImports } from '../../utils/detect-router-imports'\nimport { getInvalidParams } from './route-param-names.utils'\nimport { pathAsFirstArgFunctions, pathAsPropertyFunctions } from './constants'\nimport type { TSESTree } from '@typescript-eslint/utils'\nimport type { ExtraRuleDocs } from '../../types'\n\nconst createRule = ESLintUtils.RuleCreator<ExtraRuleDocs>(getDocsUrl)\n\nconst pathAsFirstArgSet = new Set<string>(pathAsFirstArgFunctions)\nconst pathAsPropertySet = new Set<string>(pathAsPropertyFunctions)\n\nexport const name = 'route-param-names'\n\nexport const rule = createRule({\n  name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Ensure route param names are valid JavaScript identifiers',\n      recommended: 'error',\n    },\n    messages: {\n      invalidParamName:\n        'Invalid param name \"{{paramName}}\" in route path. Param names must be valid JavaScript identifiers (match /[a-zA-Z_$][a-zA-Z0-9_$]*/).',\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n\n  create: detectTanstackRouterImports((context, _, helpers) => {\n    function reportInvalidParams(node: TSESTree.Node, path: string) {\n      const invalidParams = getInvalidParams(path)\n\n      for (const param of invalidParams) {\n        context.report({\n          node,\n          messageId: 'invalidParamName',\n          data: { paramName: param.paramName },\n        })\n      }\n    }\n\n    function getStringLiteralValue(node: TSESTree.Node): string | null {\n      if (\n        node.type === AST_NODE_TYPES.Literal &&\n        typeof node.value === 'string'\n      ) {\n        return node.value\n      }\n      if (\n        node.type === AST_NODE_TYPES.TemplateLiteral &&\n        node.quasis.length === 1\n      ) {\n        const cooked = node.quasis[0]?.value.cooked\n        if (cooked != null) {\n          return cooked\n        }\n      }\n      return null\n    }\n\n    return {\n      CallExpression(node) {\n        // Handle direct function call: createRoute({ path: '...' })\n        if (node.callee.type === AST_NODE_TYPES.Identifier) {\n          const funcName = node.callee.name\n\n          // Skip if not imported from TanStack Router\n          if (!helpers.isTanstackRouterImport(node.callee)) {\n            return\n          }\n\n          // Case: createRoute({ path: '/path/$param' }) or createRoute({ 'path': '/path/$param' })\n          if (pathAsPropertySet.has(funcName)) {\n            const arg = node.arguments[0]\n            if (arg?.type === AST_NODE_TYPES.ObjectExpression) {\n              for (const prop of arg.properties) {\n                if (prop.type === AST_NODE_TYPES.Property) {\n                  const isPathKey =\n                    (prop.key.type === AST_NODE_TYPES.Identifier &&\n                      prop.key.name === 'path') ||\n                    (prop.key.type === AST_NODE_TYPES.Literal &&\n                      prop.key.value === 'path')\n                  if (isPathKey) {\n                    const pathValue = getStringLiteralValue(prop.value)\n                    if (pathValue) {\n                      reportInvalidParams(prop.value, pathValue)\n                    }\n                  }\n                }\n              }\n            }\n            return\n          }\n        }\n\n        // Handle curried function call: createFileRoute('/path')({ ... })\n        if (node.callee.type === AST_NODE_TYPES.CallExpression) {\n          const innerCall = node.callee\n\n          if (innerCall.callee.type === AST_NODE_TYPES.Identifier) {\n            const funcName = innerCall.callee.name\n\n            // Skip if not imported from TanStack Router\n            if (!helpers.isTanstackRouterImport(innerCall.callee)) {\n              return\n            }\n\n            // Case: createFileRoute('/path/$param')(...) or similar\n            if (pathAsFirstArgSet.has(funcName)) {\n              const pathArg = innerCall.arguments[0]\n              if (pathArg) {\n                const pathValue = getStringLiteralValue(pathArg)\n                if (pathValue) {\n                  reportInvalidParams(pathArg, pathValue)\n                }\n              }\n            }\n          }\n        }\n      },\n    }\n  }),\n})\n"],"names":["ESLintUtils","getDocsUrl","pathAsFirstArgFunctions","pathAsPropertyFunctions","detectTanstackRouterImports","getInvalidParams","AST_NODE_TYPES"],"mappings":";;;;;;;AASA,MAAM,aAAaA,MAAAA,YAAY,YAA2BC,qBAAU;AAEpE,MAAM,oBAAoB,IAAI,IAAYC,iCAAuB;AACjE,MAAM,oBAAoB,IAAI,IAAYC,iCAAuB;AAE1D,MAAM,OAAO;AAEb,MAAM,OAAO,WAAW;AAAA,EAC7B;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,aAAa;AAAA,MACb,aAAa;AAAA,IAAA;AAAA,IAEf,UAAU;AAAA,MACR,kBACE;AAAA,IAAA;AAAA,IAEJ,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEX,gBAAgB,CAAA;AAAA,EAEhB,QAAQC,oBAAAA,4BAA4B,CAAC,SAAS,GAAG,YAAY;AAC3D,aAAS,oBAAoB,MAAqB,MAAc;AAC9D,YAAM,gBAAgBC,sBAAAA,iBAAiB,IAAI;AAE3C,iBAAW,SAAS,eAAe;AACjC,gBAAQ,OAAO;AAAA,UACb;AAAA,UACA,WAAW;AAAA,UACX,MAAM,EAAE,WAAW,MAAM,UAAA;AAAA,QAAU,CACpC;AAAA,MACH;AAAA,IACF;AAEA,aAAS,sBAAsB,MAAoC;AACjE,UACE,KAAK,SAASC,MAAAA,eAAe,WAC7B,OAAO,KAAK,UAAU,UACtB;AACA,eAAO,KAAK;AAAA,MACd;AACA,UACE,KAAK,SAASA,qBAAe,mBAC7B,KAAK,OAAO,WAAW,GACvB;AACA,cAAM,SAAS,KAAK,OAAO,CAAC,GAAG,MAAM;AACrC,YAAI,UAAU,MAAM;AAClB,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,MACL,eAAe,MAAM;AAEnB,YAAI,KAAK,OAAO,SAASA,MAAAA,eAAe,YAAY;AAClD,gBAAM,WAAW,KAAK,OAAO;AAG7B,cAAI,CAAC,QAAQ,uBAAuB,KAAK,MAAM,GAAG;AAChD;AAAA,UACF;AAGA,cAAI,kBAAkB,IAAI,QAAQ,GAAG;AACnC,kBAAM,MAAM,KAAK,UAAU,CAAC;AAC5B,gBAAI,KAAK,SAASA,MAAAA,eAAe,kBAAkB;AACjD,yBAAW,QAAQ,IAAI,YAAY;AACjC,oBAAI,KAAK,SAASA,MAAAA,eAAe,UAAU;AACzC,wBAAM,YACH,KAAK,IAAI,SAASA,MAAAA,eAAe,cAChC,KAAK,IAAI,SAAS,UACnB,KAAK,IAAI,SAASA,MAAAA,eAAe,WAChC,KAAK,IAAI,UAAU;AACvB,sBAAI,WAAW;AACb,0BAAM,YAAY,sBAAsB,KAAK,KAAK;AAClD,wBAAI,WAAW;AACb,0CAAoB,KAAK,OAAO,SAAS;AAAA,oBAC3C;AAAA,kBACF;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AACA;AAAA,UACF;AAAA,QACF;AAGA,YAAI,KAAK,OAAO,SAASA,MAAAA,eAAe,gBAAgB;AACtD,gBAAM,YAAY,KAAK;AAEvB,cAAI,UAAU,OAAO,SAASA,MAAAA,eAAe,YAAY;AACvD,kBAAM,WAAW,UAAU,OAAO;AAGlC,gBAAI,CAAC,QAAQ,uBAAuB,UAAU,MAAM,GAAG;AACrD;AAAA,YACF;AAGA,gBAAI,kBAAkB,IAAI,QAAQ,GAAG;AACnC,oBAAM,UAAU,UAAU,UAAU,CAAC;AACrC,kBAAI,SAAS;AACX,sBAAM,YAAY,sBAAsB,OAAO;AAC/C,oBAAI,WAAW;AACb,sCAAoB,SAAS,SAAS;AAAA,gBACxC;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IAAA;AAAA,EAEJ,CAAC;AACH,CAAC;;;"}

package/dist/cjs/rules/route-param-names/route-param-names.rule.d.cts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { ExtraRuleDocs } from '../../types.cjs';
+export declare const name = "route-param-names";
+export declare const rule: ESLintUtils.RuleModule<string, readonly unknown[], ExtraRuleDocs, ESLintUtils.RuleListener>;

package/dist/cjs/rules/route-param-names/route-param-names.utils.cjs

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const constants = require("./constants.cjs");
+function extractParamsFromSegment(segment) {
+  const params = [];
+  if (!segment || !segment.includes("$")) {
+    return params;
+  }
+  if (segment === "$" || segment === "{$}") {
+    return params;
+  }
+  if (segment.startsWith("$") && !segment.includes("{")) {
+    const paramName = segment.slice(1);
+    if (paramName) {
+      params.push({
+        fullParam: segment,
+        paramName,
+        isOptional: false,
+        isValid: constants.VALID_PARAM_NAME_REGEX.test(paramName)
+      });
+    }
+    return params;
+  }
+  const bracePattern = /\{(-?\$)([^}]*)\}/g;
+  let match;
+  while ((match = bracePattern.exec(segment)) !== null) {
+    const prefix = match[1];
+    const paramName = match[2];
+    if (!paramName) {
+      continue;
+    }
+    const isOptional = prefix === "-$";
+    params.push({
+      fullParam: `${prefix}${paramName}`,
+      paramName,
+      isOptional,
+      isValid: constants.VALID_PARAM_NAME_REGEX.test(paramName)
+    });
+  }
+  return params;
+}
+function extractParamsFromPath(path) {
+  if (!path || !path.includes("$")) {
+    return [];
+  }
+  const segments = path.split("/");
+  const allParams = [];
+  for (const segment of segments) {
+    const params = extractParamsFromSegment(segment);
+    allParams.push(...params);
+  }
+  return allParams;
+}
+function getInvalidParams(path) {
+  const params = extractParamsFromPath(path);
+  return params.filter((p) => !p.isValid);
+}
+exports.extractParamsFromPath = extractParamsFromPath;
+exports.extractParamsFromSegment = extractParamsFromSegment;
+exports.getInvalidParams = getInvalidParams;
+//# sourceMappingURL=route-param-names.utils.cjs.map

package/dist/cjs/rules/route-param-names/route-param-names.utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-param-names.utils.cjs","sources":["../../../../src/rules/route-param-names/route-param-names.utils.ts"],"sourcesContent":["import { VALID_PARAM_NAME_REGEX } from './constants'\n\nexport interface ExtractedParam {\n  /** The full param string including $ prefix (e.g., \"$userId\", \"-$optional\") */\n  fullParam: string\n  /** The param name without $ prefix (e.g., \"userId\", \"optional\") */\n  paramName: string\n  /** Whether this is an optional param (prefixed with -$) */\n  isOptional: boolean\n  /** Whether this param name is valid */\n  isValid: boolean\n}\n\n/**\n * Extracts param names from a route path segment.\n *\n * Handles these patterns:\n * - $paramName                     -> extract \"paramName\"\n * - {$paramName}                   -> extract \"paramName\"\n * - prefix{$paramName}suffix       -> extract \"paramName\"\n * - {-$paramName}                  -> extract \"paramName\" (optional)\n * - prefix{-$paramName}suffix      -> extract \"paramName\" (optional)\n * - $ or {$}                       -> wildcard, skip validation\n */\nexport function extractParamsFromSegment(\n  segment: string,\n): Array<ExtractedParam> {\n  const params: Array<ExtractedParam> = []\n\n  // Skip empty segments\n  if (!segment || !segment.includes('$')) {\n    return params\n  }\n\n  // Check for wildcard ($ alone or {$})\n  if (segment === '$' || segment === '{$}') {\n    return params // Wildcard, no param name to validate\n  }\n\n  // Pattern 1: Simple $paramName (entire segment starts with $)\n  if (segment.startsWith('$') && !segment.includes('{')) {\n    const paramName = segment.slice(1)\n    if (paramName) {\n      params.push({\n        fullParam: segment,\n        paramName,\n        isOptional: false,\n        isValid: VALID_PARAM_NAME_REGEX.test(paramName),\n      })\n    }\n    return params\n  }\n\n  // Pattern 2: Braces pattern {$paramName} or {-$paramName} with optional prefix/suffix\n  // Match patterns like: prefix{$param}suffix, {$param}, {-$param}\n  const bracePattern = /\\{(-?\\$)([^}]*)\\}/g\n  let match\n\n  while ((match = bracePattern.exec(segment)) !== null) {\n    const prefix = match[1] // \"$\" or \"-$\"\n    const paramName = match[2] // The param name after $ or -$\n\n    if (!paramName) {\n      // This is a wildcard {$} or {-$}, skip\n      continue\n    }\n\n    const isOptional = prefix === '-$'\n\n    params.push({\n      fullParam: `${prefix}${paramName}`,\n      paramName,\n      isOptional,\n      isValid: VALID_PARAM_NAME_REGEX.test(paramName),\n    })\n  }\n\n  return params\n}\n\n/**\n * Extracts all params from a route path.\n *\n * @param path - The route path (e.g., \"/users/$userId/posts/$postId\")\n * @returns Array of extracted params with validation info\n */\nexport function extractParamsFromPath(path: string): Array<ExtractedParam> {\n  if (!path || !path.includes('$')) {\n    return []\n  }\n\n  const segments = path.split('/')\n  const allParams: Array<ExtractedParam> = []\n\n  for (const segment of segments) {\n    const params = extractParamsFromSegment(segment)\n    allParams.push(...params)\n  }\n\n  return allParams\n}\n\n/**\n * Validates a single param name.\n *\n * @param paramName - The param name to validate (without $ prefix)\n * @returns Whether the param name is valid\n */\nexport function isValidParamName(paramName: string): boolean {\n  return VALID_PARAM_NAME_REGEX.test(paramName)\n}\n\n/**\n * Gets all invalid params from a route path.\n *\n * @param path - The route path\n * @returns Array of invalid param info\n */\nexport function getInvalidParams(path: string): Array<ExtractedParam> {\n  const params = extractParamsFromPath(path)\n  return params.filter((p) => !p.isValid)\n}\n"],"names":["VALID_PARAM_NAME_REGEX"],"mappings":";;;AAwBO,SAAS,yBACd,SACuB;AACvB,QAAM,SAAgC,CAAA;AAGtC,MAAI,CAAC,WAAW,CAAC,QAAQ,SAAS,GAAG,GAAG;AACtC,WAAO;AAAA,EACT;AAGA,MAAI,YAAY,OAAO,YAAY,OAAO;AACxC,WAAO;AAAA,EACT;AAGA,MAAI,QAAQ,WAAW,GAAG,KAAK,CAAC,QAAQ,SAAS,GAAG,GAAG;AACrD,UAAM,YAAY,QAAQ,MAAM,CAAC;AACjC,QAAI,WAAW;AACb,aAAO,KAAK;AAAA,QACV,WAAW;AAAA,QACX;AAAA,QACA,YAAY;AAAA,QACZ,SAASA,UAAAA,uBAAuB,KAAK,SAAS;AAAA,MAAA,CAC/C;AAAA,IACH;AACA,WAAO;AAAA,EACT;AAIA,QAAM,eAAe;AACrB,MAAI;AAEJ,UAAQ,QAAQ,aAAa,KAAK,OAAO,OAAO,MAAM;AACpD,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,YAAY,MAAM,CAAC;AAEzB,QAAI,CAAC,WAAW;AAEd;AAAA,IACF;AAEA,UAAM,aAAa,WAAW;AAE9B,WAAO,KAAK;AAAA,MACV,WAAW,GAAG,MAAM,GAAG,SAAS;AAAA,MAChC;AAAA,MACA;AAAA,MACA,SAASA,UAAAA,uBAAuB,KAAK,SAAS;AAAA,IAAA,CAC/C;AAAA,EACH;AAEA,SAAO;AACT;AAQO,SAAS,sBAAsB,MAAqC;AACzE,MAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,GAAG,GAAG;AAChC,WAAO,CAAA;AAAA,EACT;AAEA,QAAM,WAAW,KAAK,MAAM,GAAG;AAC/B,QAAM,YAAmC,CAAA;AAEzC,aAAW,WAAW,UAAU;AAC9B,UAAM,SAAS,yBAAyB,OAAO;AAC/C,cAAU,KAAK,GAAG,MAAM;AAAA,EAC1B;AAEA,SAAO;AACT;AAkBO,SAAS,iBAAiB,MAAqC;AACpE,QAAM,SAAS,sBAAsB,IAAI;AACzC,SAAO,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO;AACxC;;;;"}

package/dist/cjs/rules/route-param-names/route-param-names.utils.d.cts

@@ -0,0 +1,43 @@
+export interface ExtractedParam {
+    /** The full param string including $ prefix (e.g., "$userId", "-$optional") */
+    fullParam: string;
+    /** The param name without $ prefix (e.g., "userId", "optional") */
+    paramName: string;
+    /** Whether this is an optional param (prefixed with -$) */
+    isOptional: boolean;
+    /** Whether this param name is valid */
+    isValid: boolean;
+}
+/**
+ * Extracts param names from a route path segment.
+ *
+ * Handles these patterns:
+ * - $paramName                     -> extract "paramName"
+ * - {$paramName}                   -> extract "paramName"
+ * - prefix{$paramName}suffix       -> extract "paramName"
+ * - {-$paramName}                  -> extract "paramName" (optional)
+ * - prefix{-$paramName}suffix      -> extract "paramName" (optional)
+ * - $ or {$}                       -> wildcard, skip validation
+ */
+export declare function extractParamsFromSegment(segment: string): Array<ExtractedParam>;
+/**
+ * Extracts all params from a route path.
+ *
+ * @param path - The route path (e.g., "/users/$userId/posts/$postId")
+ * @returns Array of extracted params with validation info
+ */
+export declare function extractParamsFromPath(path: string): Array<ExtractedParam>;
+/**
+ * Validates a single param name.
+ *
+ * @param paramName - The param name to validate (without $ prefix)
+ * @returns Whether the param name is valid
+ */
+export declare function isValidParamName(paramName: string): boolean;
+/**
+ * Gets all invalid params from a route path.
+ *
+ * @param path - The route path
+ * @returns Array of invalid param info
+ */
+export declare function getInvalidParams(path: string): Array<ExtractedParam>;

package/dist/cjs/rules.cjs

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const createRoutePropertyOrder_rule = require("./rules/create-route-property-order/create-route-property-order.rule.cjs");
+const routeParamNames_rule = require("./rules/route-param-names/route-param-names.rule.cjs");
 const rules = {
-  [createRoutePropertyOrder_rule.name]: createRoutePropertyOrder_rule.rule
+  [createRoutePropertyOrder_rule.name]: createRoutePropertyOrder_rule.rule,
+  [routeParamNames_rule.name]: routeParamNames_rule.rule
 };
 exports.rules = rules;
 //# sourceMappingURL=rules.cjs.map

package/dist/cjs/rules.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"rules.cjs","sources":["../../src/rules.ts"],"sourcesContent":["import * as createRoutePropertyOrder from './rules/create-route-property-order/create-route-property-order.rule'\nimport type { ESLintUtils } from '@typescript-eslint/utils'\nimport type { ExtraRuleDocs } from './types'\n\nexport const rules: Record<\n  string,\n  ESLintUtils.RuleModule<\n    string,\n    ReadonlyArray<unknown>,\n    ExtraRuleDocs,\n    ESLintUtils.RuleListener\n  >\n> = {\n  [createRoutePropertyOrder.name]: createRoutePropertyOrder.rule,\n}\n"],"names":["createRoutePropertyOrder.name","createRoutePropertyOrder.rule"],"mappings":";;;AAIO,MAAM,QAQT;AAAA,EACF,CAACA,kCAA6B,GAAGC,8BAAAA;AACnC;;"}
+{"version":3,"file":"rules.cjs","sources":["../../src/rules.ts"],"sourcesContent":["import * as createRoutePropertyOrder from './rules/create-route-property-order/create-route-property-order.rule'\nimport * as routeParamNames from './rules/route-param-names/route-param-names.rule'\nimport type { ESLintUtils } from '@typescript-eslint/utils'\nimport type { ExtraRuleDocs } from './types'\n\nexport const rules: Record<\n  string,\n  ESLintUtils.RuleModule<\n    string,\n    ReadonlyArray<unknown>,\n    ExtraRuleDocs,\n    ESLintUtils.RuleListener\n  >\n> = {\n  [createRoutePropertyOrder.name]: createRoutePropertyOrder.rule,\n  [routeParamNames.name]: routeParamNames.rule,\n}\n"],"names":["createRoutePropertyOrder.name","createRoutePropertyOrder.rule","routeParamNames.name","routeParamNames.rule"],"mappings":";;;;AAKO,MAAM,QAQT;AAAA,EACF,CAACA,8BAAAA,IAA6B,GAAGC,8BAAAA;AAAAA,EACjC,CAACC,yBAAoB,GAAGC,qBAAAA;AAC1B;;"}

package/dist/cjs/utils/detect-router-imports.cjs

@@ -24,7 +24,8 @@ function detectTanstackRouterImports(create) {
     };
     const detectionInstructions = {
       ImportDeclaration(node) {
-        if (node.specifiers.length > 0 && node.importKind === "value" && node.source.value.startsWith("@tanstack/") && node.source.value.endsWith("-router")) {
+        if (node.specifiers.length > 0 && // `importKind` is parser-dependent and can be undefined (eg. Espree)
+        node.importKind !== "type" && node.source.value.startsWith("@tanstack/") && node.source.value.endsWith("-router")) {
           tanstackRouterImportSpecifiers.push(...node.specifiers);
         }
       }

package/dist/cjs/utils/detect-router-imports.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"detect-router-imports.cjs","sources":["../../../src/utils/detect-router-imports.ts"],"sourcesContent":["import { TSESTree } from '@typescript-eslint/utils'\nimport type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'\n\ntype Create = Parameters<\n  ReturnType<typeof ESLintUtils.RuleCreator>\n>[0]['create']\n\ntype Context = Parameters<Create>[0]\ntype Options = Parameters<Create>[1]\ntype Helpers = {\n  isSpecificTanstackRouterImport: (\n    node: TSESTree.Identifier,\n    source: string,\n  ) => boolean\n  isTanstackRouterImport: (node: TSESTree.Identifier) => boolean\n}\n\ntype EnhancedCreate = (\n  context: Context,\n  options: Options,\n  helpers: Helpers,\n) => ReturnType<Create>\n\nexport function detectTanstackRouterImports(create: EnhancedCreate): Create {\n  return (context, optionsWithDefault) => {\n    const tanstackRouterImportSpecifiers: Array<TSESTree.ImportClause> = []\n\n    const helpers: Helpers = {\n      isSpecificTanstackRouterImport(node, source) {\n        return !!tanstackRouterImportSpecifiers.find((specifier) => {\n          if (\n            specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&\n            specifier.parent.type ===\n              TSESTree.AST_NODE_TYPES.ImportDeclaration &&\n            specifier.parent.source.value === source\n          ) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n      isTanstackRouterImport(node) {\n        return !!tanstackRouterImportSpecifiers.find((specifier) => {\n          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n    }\n\n    const detectionInstructions: TSESLint.RuleListener = {\n      ImportDeclaration(node) {\n        if (\n          node.specifiers.length > 0 &&\n          node.importKind === 'value' &&\n          node.source.value.startsWith('@tanstack/') &&\n          node.source.value.endsWith('-router')\n        ) {\n          tanstackRouterImportSpecifiers.push(...node.specifiers)\n        }\n      },\n    }\n\n    // Call original rule definition\n    const ruleInstructions = create(context, optionsWithDefault, helpers)\n    const enhancedRuleInstructions: TSESLint.RuleListener = {}\n\n    const allKeys = new Set(\n      Object.keys(detectionInstructions).concat(Object.keys(ruleInstructions)),\n    )\n\n    // Iterate over ALL instructions keys so we can override original rule instructions\n    // to prevent their execution if conditions to report errors are not met.\n    allKeys.forEach((instruction) => {\n      enhancedRuleInstructions[instruction] = (node) => {\n        if (instruction in detectionInstructions) {\n          detectionInstructions[instruction]?.(node)\n        }\n\n        const ruleFunction = ruleInstructions[instruction]\n        if (ruleFunction !== undefined) {\n          return ruleFunction(node)\n        }\n\n        return undefined\n      }\n    })\n\n    return enhancedRuleInstructions\n  }\n}\n"],"names":["TSESTree"],"mappings":";;;AAuBO,SAAS,4BAA4B,QAAgC;AAC1E,SAAO,CAAC,SAAS,uBAAuB;AACtC,UAAM,iCAA+D,CAAA;AAErE,UAAM,UAAmB;AAAA,MACvB,+BAA+B,MAAM,QAAQ;AAC3C,eAAO,CAAC,CAAC,+BAA+B,KAAK,CAAC,cAAc;AAC1D,cACE,UAAU,SAASA,MAAAA,SAAS,eAAe,mBAC3C,UAAU,OAAO,SACfA,MAAAA,SAAS,eAAe,qBAC1B,UAAU,OAAO,OAAO,UAAU,QAClC;AACA,mBAAO,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,MACA,uBAAuB,MAAM;AAC3B,eAAO,CAAC,CAAC,+BAA+B,KAAK,CAAC,cAAc;AAC1D,cAAI,UAAU,SAASA,eAAS,eAAe,iBAAiB;AAC9D,mBAAO,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,wBAA+C;AAAA,MACnD,kBAAkB,MAAM;AACtB,YACE,KAAK,WAAW,SAAS,KACzB,KAAK,eAAe,WACpB,KAAK,OAAO,MAAM,WAAW,YAAY,KACzC,KAAK,OAAO,MAAM,SAAS,SAAS,GACpC;AACA,yCAA+B,KAAK,GAAG,KAAK,UAAU;AAAA,QACxD;AAAA,MACF;AAAA,IAAA;AAIF,UAAM,mBAAmB,OAAO,SAAS,oBAAoB,OAAO;AACpE,UAAM,2BAAkD,CAAA;AAExD,UAAM,UAAU,IAAI;AAAA,MAClB,OAAO,KAAK,qBAAqB,EAAE,OAAO,OAAO,KAAK,gBAAgB,CAAC;AAAA,IAAA;AAKzE,YAAQ,QAAQ,CAAC,gBAAgB;AAC/B,+BAAyB,WAAW,IAAI,CAAC,SAAS;AAChD,YAAI,eAAe,uBAAuB;AACxC,gCAAsB,WAAW,IAAI,IAAI;AAAA,QAC3C;AAEA,cAAM,eAAe,iBAAiB,WAAW;AACjD,YAAI,iBAAiB,QAAW;AAC9B,iBAAO,aAAa,IAAI;AAAA,QAC1B;AAEA,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AACF;;"}
+{"version":3,"file":"detect-router-imports.cjs","sources":["../../../src/utils/detect-router-imports.ts"],"sourcesContent":["import { TSESTree } from '@typescript-eslint/utils'\nimport type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'\n\ntype Create = Parameters<\n  ReturnType<typeof ESLintUtils.RuleCreator>\n>[0]['create']\n\ntype Context = Parameters<Create>[0]\ntype Options = Parameters<Create>[1]\ntype Helpers = {\n  isSpecificTanstackRouterImport: (\n    node: TSESTree.Identifier,\n    source: string,\n  ) => boolean\n  isTanstackRouterImport: (node: TSESTree.Identifier) => boolean\n}\n\ntype EnhancedCreate = (\n  context: Context,\n  options: Options,\n  helpers: Helpers,\n) => ReturnType<Create>\n\nexport function detectTanstackRouterImports(create: EnhancedCreate): Create {\n  return (context, optionsWithDefault) => {\n    const tanstackRouterImportSpecifiers: Array<TSESTree.ImportClause> = []\n\n    const helpers: Helpers = {\n      isSpecificTanstackRouterImport(node, source) {\n        return !!tanstackRouterImportSpecifiers.find((specifier) => {\n          if (\n            specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&\n            specifier.parent.type ===\n              TSESTree.AST_NODE_TYPES.ImportDeclaration &&\n            specifier.parent.source.value === source\n          ) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n      isTanstackRouterImport(node) {\n        return !!tanstackRouterImportSpecifiers.find((specifier) => {\n          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n    }\n\n    const detectionInstructions: TSESLint.RuleListener = {\n      ImportDeclaration(node) {\n        if (\n          node.specifiers.length > 0 &&\n          // `importKind` is parser-dependent and can be undefined (eg. Espree)\n          node.importKind !== 'type' &&\n          node.source.value.startsWith('@tanstack/') &&\n          node.source.value.endsWith('-router')\n        ) {\n          tanstackRouterImportSpecifiers.push(...node.specifiers)\n        }\n      },\n    }\n\n    // Call original rule definition\n    const ruleInstructions = create(context, optionsWithDefault, helpers)\n    const enhancedRuleInstructions: TSESLint.RuleListener = {}\n\n    const allKeys = new Set(\n      Object.keys(detectionInstructions).concat(Object.keys(ruleInstructions)),\n    )\n\n    // Iterate over ALL instructions keys so we can override original rule instructions\n    // to prevent their execution if conditions to report errors are not met.\n    allKeys.forEach((instruction) => {\n      enhancedRuleInstructions[instruction] = (node) => {\n        if (instruction in detectionInstructions) {\n          detectionInstructions[instruction]?.(node)\n        }\n\n        const ruleFunction = ruleInstructions[instruction]\n        if (ruleFunction !== undefined) {\n          return ruleFunction(node)\n        }\n\n        return undefined\n      }\n    })\n\n    return enhancedRuleInstructions\n  }\n}\n"],"names":["TSESTree"],"mappings":";;;AAuBO,SAAS,4BAA4B,QAAgC;AAC1E,SAAO,CAAC,SAAS,uBAAuB;AACtC,UAAM,iCAA+D,CAAA;AAErE,UAAM,UAAmB;AAAA,MACvB,+BAA+B,MAAM,QAAQ;AAC3C,eAAO,CAAC,CAAC,+BAA+B,KAAK,CAAC,cAAc;AAC1D,cACE,UAAU,SAASA,MAAAA,SAAS,eAAe,mBAC3C,UAAU,OAAO,SACfA,MAAAA,SAAS,eAAe,qBAC1B,UAAU,OAAO,OAAO,UAAU,QAClC;AACA,mBAAO,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,MACA,uBAAuB,MAAM;AAC3B,eAAO,CAAC,CAAC,+BAA+B,KAAK,CAAC,cAAc;AAC1D,cAAI,UAAU,SAASA,eAAS,eAAe,iBAAiB;AAC9D,mBAAO,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,wBAA+C;AAAA,MACnD,kBAAkB,MAAM;AACtB,YACE,KAAK,WAAW,SAAS;AAAA,QAEzB,KAAK,eAAe,UACpB,KAAK,OAAO,MAAM,WAAW,YAAY,KACzC,KAAK,OAAO,MAAM,SAAS,SAAS,GACpC;AACA,yCAA+B,KAAK,GAAG,KAAK,UAAU;AAAA,QACxD;AAAA,MACF;AAAA,IAAA;AAIF,UAAM,mBAAmB,OAAO,SAAS,oBAAoB,OAAO;AACpE,UAAM,2BAAkD,CAAA;AAExD,UAAM,UAAU,IAAI;AAAA,MAClB,OAAO,KAAK,qBAAqB,EAAE,OAAO,OAAO,KAAK,gBAAgB,CAAC;AAAA,IAAA;AAKzE,YAAQ,QAAQ,CAAC,gBAAgB;AAC/B,+BAAyB,WAAW,IAAI,CAAC,SAAS;AAChD,YAAI,eAAe,uBAAuB;AACxC,gCAAsB,WAAW,IAAI,IAAI;AAAA,QAC3C;AAEA,cAAM,eAAe,iBAAiB,WAAW;AACjD,YAAI,iBAAiB,QAAW;AAC9B,iBAAO,aAAa,IAAI;AAAA,QAC1B;AAEA,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AACF;;"}

package/dist/esm/index.js

@@ -10,7 +10,8 @@ Object.assign(plugin.configs, {
   recommended: {
     plugins: ["@tanstack/eslint-plugin-router"],
     rules: {
-      "@tanstack/router/create-route-property-order": "warn"
+      "@tanstack/router/create-route-property-order": "warn",
+      "@tanstack/router/route-param-names": "error"
     }
   },
   "flat/recommended": [
@@ -19,7 +20,8 @@ Object.assign(plugin.configs, {
         "@tanstack/router": plugin
       },
       rules: {
-        "@tanstack/router/create-route-property-order": "warn"
+        "@tanstack/router/create-route-property-order": "warn",
+        "@tanstack/router/route-param-names": "error"
       }
     }
   ]

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import { rules } from './rules'\nimport type { ESLint, Linter } from 'eslint'\nimport type { RuleModule } from '@typescript-eslint/utils/ts-eslint'\n\ntype RuleKey = keyof typeof rules\n\ninterface Plugin extends Omit<ESLint.Plugin, 'rules'> {\n  rules: Record<RuleKey, RuleModule<any, any, any>>\n  configs: {\n    recommended: ESLint.ConfigData\n    'flat/recommended': Array<Linter.FlatConfig>\n  }\n}\n\nconst plugin: Plugin = {\n  meta: {\n    name: '@tanstack/eslint-plugin-router',\n  },\n  configs: {} as Plugin['configs'],\n  rules,\n}\n\n// Assign configs here so we can reference `plugin`\nObject.assign(plugin.configs, {\n  recommended: {\n    plugins: ['@tanstack/eslint-plugin-router'],\n    rules: {\n      '@tanstack/router/create-route-property-order': 'warn',\n    },\n  },\n  'flat/recommended': [\n    {\n      plugins: {\n        '@tanstack/router': plugin,\n      },\n      rules: {\n        '@tanstack/router/create-route-property-order': 'warn',\n      },\n    },\n  ],\n})\n\nexport default plugin\n"],"names":[],"mappings":";AAcA,MAAM,SAAiB;AAAA,EACrB,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,SAAS,CAAA;AAAA,EACT;AACF;AAGA,OAAO,OAAO,OAAO,SAAS;AAAA,EAC5B,aAAa;AAAA,IACX,SAAS,CAAC,gCAAgC;AAAA,IAC1C,OAAO;AAAA,MACL,gDAAgD;AAAA,IAAA;AAAA,EAClD;AAAA,EAEF,oBAAoB;AAAA,IAClB;AAAA,MACE,SAAS;AAAA,QACP,oBAAoB;AAAA,MAAA;AAAA,MAEtB,OAAO;AAAA,QACL,gDAAgD;AAAA,MAAA;AAAA,IAClD;AAAA,EACF;AAEJ,CAAC;"}
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import { rules } from './rules'\nimport type { ESLint, Linter } from 'eslint'\nimport type { RuleModule } from '@typescript-eslint/utils/ts-eslint'\n\ntype RuleKey = keyof typeof rules\n\ninterface Plugin extends Omit<ESLint.Plugin, 'rules'> {\n  rules: Record<RuleKey, RuleModule<any, any, any>>\n  configs: {\n    recommended: ESLint.ConfigData\n    'flat/recommended': Array<Linter.FlatConfig>\n  }\n}\n\nconst plugin: Plugin = {\n  meta: {\n    name: '@tanstack/eslint-plugin-router',\n  },\n  configs: {} as Plugin['configs'],\n  rules,\n}\n\n// Assign configs here so we can reference `plugin`\nObject.assign(plugin.configs, {\n  recommended: {\n    plugins: ['@tanstack/eslint-plugin-router'],\n    rules: {\n      '@tanstack/router/create-route-property-order': 'warn',\n      '@tanstack/router/route-param-names': 'error',\n    },\n  },\n  'flat/recommended': [\n    {\n      plugins: {\n        '@tanstack/router': plugin,\n      },\n      rules: {\n        '@tanstack/router/create-route-property-order': 'warn',\n        '@tanstack/router/route-param-names': 'error',\n      },\n    },\n  ],\n})\n\nexport default plugin\n"],"names":[],"mappings":";AAcA,MAAM,SAAiB;AAAA,EACrB,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,SAAS,CAAA;AAAA,EACT;AACF;AAGA,OAAO,OAAO,OAAO,SAAS;AAAA,EAC5B,aAAa;AAAA,IACX,SAAS,CAAC,gCAAgC;AAAA,IAC1C,OAAO;AAAA,MACL,gDAAgD;AAAA,MAChD,sCAAsC;AAAA,IAAA;AAAA,EACxC;AAAA,EAEF,oBAAoB;AAAA,IAClB;AAAA,MACE,SAAS;AAAA,QACP,oBAAoB;AAAA,MAAA;AAAA,MAEtB,OAAO;AAAA,QACL,gDAAgD;AAAA,QAChD,sCAAsC;AAAA,MAAA;AAAA,IACxC;AAAA,EACF;AAEJ,CAAC;"}

package/dist/esm/rules/route-param-names/constants.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Functions where the path is passed as the first argument (string literal)
+ * e.g., createFileRoute('/path/$param')(...)
+ */
+export declare const pathAsFirstArgFunctions: readonly ["createFileRoute", "createLazyFileRoute", "createLazyRoute"];
+export type PathAsFirstArgFunction = (typeof pathAsFirstArgFunctions)[number];
+/**
+ * Functions where the path is a property in the options object
+ * e.g., createRoute({ path: '/path/$param' })
+ */
+export declare const pathAsPropertyFunctions: readonly ["createRoute"];
+export type PathAsPropertyFunction = (typeof pathAsPropertyFunctions)[number];
+/**
+ * All route functions that need param name validation
+ */
+export declare const allRouteFunctions: readonly ["createFileRoute", "createLazyFileRoute", "createLazyRoute", "createRoute"];
+export type RouteFunction = (typeof allRouteFunctions)[number];
+/**
+ * Regex for valid JavaScript identifier (param name)
+ * Must start with letter, underscore, or dollar sign
+ * Can contain letters, numbers, underscores, or dollar signs
+ */
+export declare const VALID_PARAM_NAME_REGEX: RegExp;

package/dist/esm/rules/route-param-names/constants.js

@@ -0,0 +1,13 @@
+const pathAsFirstArgFunctions = [
+  "createFileRoute",
+  "createLazyFileRoute",
+  "createLazyRoute"
+];
+const pathAsPropertyFunctions = ["createRoute"];
+const VALID_PARAM_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
+export {
+  VALID_PARAM_NAME_REGEX,
+  pathAsFirstArgFunctions,
+  pathAsPropertyFunctions
+};
+//# sourceMappingURL=constants.js.map

package/dist/esm/rules/route-param-names/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../../../../src/rules/route-param-names/constants.ts"],"sourcesContent":["/**\n * Functions where the path is passed as the first argument (string literal)\n * e.g., createFileRoute('/path/$param')(...)\n */\nexport const pathAsFirstArgFunctions = [\n  'createFileRoute',\n  'createLazyFileRoute',\n  'createLazyRoute',\n] as const\n\nexport type PathAsFirstArgFunction = (typeof pathAsFirstArgFunctions)[number]\n\n/**\n * Functions where the path is a property in the options object\n * e.g., createRoute({ path: '/path/$param' })\n */\nexport const pathAsPropertyFunctions = ['createRoute'] as const\n\nexport type PathAsPropertyFunction = (typeof pathAsPropertyFunctions)[number]\n\n/**\n * All route functions that need param name validation\n */\nexport const allRouteFunctions = [\n  ...pathAsFirstArgFunctions,\n  ...pathAsPropertyFunctions,\n] as const\n\nexport type RouteFunction = (typeof allRouteFunctions)[number]\n\n/**\n * Regex for valid JavaScript identifier (param name)\n * Must start with letter, underscore, or dollar sign\n * Can contain letters, numbers, underscores, or dollar signs\n */\nexport const VALID_PARAM_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/\n"],"names":[],"mappings":"AAIO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AACF;AAQO,MAAM,0BAA0B,CAAC,aAAa;AAmB9C,MAAM,yBAAyB;"}

package/dist/esm/rules/route-param-names/route-param-names.rule.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { ExtraRuleDocs } from '../../types.js';
+export declare const name = "route-param-names";
+export declare const rule: ESLintUtils.RuleModule<string, readonly unknown[], ExtraRuleDocs, ESLintUtils.RuleListener>;

package/dist/esm/rules/route-param-names/route-param-names.rule.js

@@ -0,0 +1,98 @@
+import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { getDocsUrl } from "../../utils/get-docs-url.js";
+import { detectTanstackRouterImports } from "../../utils/detect-router-imports.js";
+import { getInvalidParams } from "./route-param-names.utils.js";
+import { pathAsFirstArgFunctions, pathAsPropertyFunctions } from "./constants.js";
+const createRule = ESLintUtils.RuleCreator(getDocsUrl);
+const pathAsFirstArgSet = new Set(pathAsFirstArgFunctions);
+const pathAsPropertySet = new Set(pathAsPropertyFunctions);
+const name = "route-param-names";
+const rule = createRule({
+  name,
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Ensure route param names are valid JavaScript identifiers",
+      recommended: "error"
+    },
+    messages: {
+      invalidParamName: 'Invalid param name "{{paramName}}" in route path. Param names must be valid JavaScript identifiers (match /[a-zA-Z_$][a-zA-Z0-9_$]*/).'
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create: detectTanstackRouterImports((context, _, helpers) => {
+    function reportInvalidParams(node, path) {
+      const invalidParams = getInvalidParams(path);
+      for (const param of invalidParams) {
+        context.report({
+          node,
+          messageId: "invalidParamName",
+          data: { paramName: param.paramName }
+        });
+      }
+    }
+    function getStringLiteralValue(node) {
+      if (node.type === AST_NODE_TYPES.Literal && typeof node.value === "string") {
+        return node.value;
+      }
+      if (node.type === AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1) {
+        const cooked = node.quasis[0]?.value.cooked;
+        if (cooked != null) {
+          return cooked;
+        }
+      }
+      return null;
+    }
+    return {
+      CallExpression(node) {
+        if (node.callee.type === AST_NODE_TYPES.Identifier) {
+          const funcName = node.callee.name;
+          if (!helpers.isTanstackRouterImport(node.callee)) {
+            return;
+          }
+          if (pathAsPropertySet.has(funcName)) {
+            const arg = node.arguments[0];
+            if (arg?.type === AST_NODE_TYPES.ObjectExpression) {
+              for (const prop of arg.properties) {
+                if (prop.type === AST_NODE_TYPES.Property) {
+                  const isPathKey = prop.key.type === AST_NODE_TYPES.Identifier && prop.key.name === "path" || prop.key.type === AST_NODE_TYPES.Literal && prop.key.value === "path";
+                  if (isPathKey) {
+                    const pathValue = getStringLiteralValue(prop.value);
+                    if (pathValue) {
+                      reportInvalidParams(prop.value, pathValue);
+                    }
+                  }
+                }
+              }
+            }
+            return;
+          }
+        }
+        if (node.callee.type === AST_NODE_TYPES.CallExpression) {
+          const innerCall = node.callee;
+          if (innerCall.callee.type === AST_NODE_TYPES.Identifier) {
+            const funcName = innerCall.callee.name;
+            if (!helpers.isTanstackRouterImport(innerCall.callee)) {
+              return;
+            }
+            if (pathAsFirstArgSet.has(funcName)) {
+              const pathArg = innerCall.arguments[0];
+              if (pathArg) {
+                const pathValue = getStringLiteralValue(pathArg);
+                if (pathValue) {
+                  reportInvalidParams(pathArg, pathValue);
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+  })
+});
+export {
+  name,
+  rule
+};
+//# sourceMappingURL=route-param-names.rule.js.map

package/dist/esm/rules/route-param-names/route-param-names.rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-param-names.rule.js","sources":["../../../../src/rules/route-param-names/route-param-names.rule.ts"],"sourcesContent":["import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'\n\nimport { getDocsUrl } from '../../utils/get-docs-url'\nimport { detectTanstackRouterImports } from '../../utils/detect-router-imports'\nimport { getInvalidParams } from './route-param-names.utils'\nimport { pathAsFirstArgFunctions, pathAsPropertyFunctions } from './constants'\nimport type { TSESTree } from '@typescript-eslint/utils'\nimport type { ExtraRuleDocs } from '../../types'\n\nconst createRule = ESLintUtils.RuleCreator<ExtraRuleDocs>(getDocsUrl)\n\nconst pathAsFirstArgSet = new Set<string>(pathAsFirstArgFunctions)\nconst pathAsPropertySet = new Set<string>(pathAsPropertyFunctions)\n\nexport const name = 'route-param-names'\n\nexport const rule = createRule({\n  name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Ensure route param names are valid JavaScript identifiers',\n      recommended: 'error',\n    },\n    messages: {\n      invalidParamName:\n        'Invalid param name \"{{paramName}}\" in route path. Param names must be valid JavaScript identifiers (match /[a-zA-Z_$][a-zA-Z0-9_$]*/).',\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n\n  create: detectTanstackRouterImports((context, _, helpers) => {\n    function reportInvalidParams(node: TSESTree.Node, path: string) {\n      const invalidParams = getInvalidParams(path)\n\n      for (const param of invalidParams) {\n        context.report({\n          node,\n          messageId: 'invalidParamName',\n          data: { paramName: param.paramName },\n        })\n      }\n    }\n\n    function getStringLiteralValue(node: TSESTree.Node): string | null {\n      if (\n        node.type === AST_NODE_TYPES.Literal &&\n        typeof node.value === 'string'\n      ) {\n        return node.value\n      }\n      if (\n        node.type === AST_NODE_TYPES.TemplateLiteral &&\n        node.quasis.length === 1\n      ) {\n        const cooked = node.quasis[0]?.value.cooked\n        if (cooked != null) {\n          return cooked\n        }\n      }\n      return null\n    }\n\n    return {\n      CallExpression(node) {\n        // Handle direct function call: createRoute({ path: '...' })\n        if (node.callee.type === AST_NODE_TYPES.Identifier) {\n          const funcName = node.callee.name\n\n          // Skip if not imported from TanStack Router\n          if (!helpers.isTanstackRouterImport(node.callee)) {\n            return\n          }\n\n          // Case: createRoute({ path: '/path/$param' }) or createRoute({ 'path': '/path/$param' })\n          if (pathAsPropertySet.has(funcName)) {\n            const arg = node.arguments[0]\n            if (arg?.type === AST_NODE_TYPES.ObjectExpression) {\n              for (const prop of arg.properties) {\n                if (prop.type === AST_NODE_TYPES.Property) {\n                  const isPathKey =\n                    (prop.key.type === AST_NODE_TYPES.Identifier &&\n                      prop.key.name === 'path') ||\n                    (prop.key.type === AST_NODE_TYPES.Literal &&\n                      prop.key.value === 'path')\n                  if (isPathKey) {\n                    const pathValue = getStringLiteralValue(prop.value)\n                    if (pathValue) {\n                      reportInvalidParams(prop.value, pathValue)\n                    }\n                  }\n                }\n              }\n            }\n            return\n          }\n        }\n\n        // Handle curried function call: createFileRoute('/path')({ ... })\n        if (node.callee.type === AST_NODE_TYPES.CallExpression) {\n          const innerCall = node.callee\n\n          if (innerCall.callee.type === AST_NODE_TYPES.Identifier) {\n            const funcName = innerCall.callee.name\n\n            // Skip if not imported from TanStack Router\n            if (!helpers.isTanstackRouterImport(innerCall.callee)) {\n              return\n            }\n\n            // Case: createFileRoute('/path/$param')(...) or similar\n            if (pathAsFirstArgSet.has(funcName)) {\n              const pathArg = innerCall.arguments[0]\n              if (pathArg) {\n                const pathValue = getStringLiteralValue(pathArg)\n                if (pathValue) {\n                  reportInvalidParams(pathArg, pathValue)\n                }\n              }\n            }\n          }\n        }\n      },\n    }\n  }),\n})\n"],"names":[],"mappings":";;;;;AASA,MAAM,aAAa,YAAY,YAA2B,UAAU;AAEpE,MAAM,oBAAoB,IAAI,IAAY,uBAAuB;AACjE,MAAM,oBAAoB,IAAI,IAAY,uBAAuB;AAE1D,MAAM,OAAO;AAEb,MAAM,OAAO,WAAW;AAAA,EAC7B;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,aAAa;AAAA,MACb,aAAa;AAAA,IAAA;AAAA,IAEf,UAAU;AAAA,MACR,kBACE;AAAA,IAAA;AAAA,IAEJ,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEX,gBAAgB,CAAA;AAAA,EAEhB,QAAQ,4BAA4B,CAAC,SAAS,GAAG,YAAY;AAC3D,aAAS,oBAAoB,MAAqB,MAAc;AAC9D,YAAM,gBAAgB,iBAAiB,IAAI;AAE3C,iBAAW,SAAS,eAAe;AACjC,gBAAQ,OAAO;AAAA,UACb;AAAA,UACA,WAAW;AAAA,UACX,MAAM,EAAE,WAAW,MAAM,UAAA;AAAA,QAAU,CACpC;AAAA,MACH;AAAA,IACF;AAEA,aAAS,sBAAsB,MAAoC;AACjE,UACE,KAAK,SAAS,eAAe,WAC7B,OAAO,KAAK,UAAU,UACtB;AACA,eAAO,KAAK;AAAA,MACd;AACA,UACE,KAAK,SAAS,eAAe,mBAC7B,KAAK,OAAO,WAAW,GACvB;AACA,cAAM,SAAS,KAAK,OAAO,CAAC,GAAG,MAAM;AACrC,YAAI,UAAU,MAAM;AAClB,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,MACL,eAAe,MAAM;AAEnB,YAAI,KAAK,OAAO,SAAS,eAAe,YAAY;AAClD,gBAAM,WAAW,KAAK,OAAO;AAG7B,cAAI,CAAC,QAAQ,uBAAuB,KAAK,MAAM,GAAG;AAChD;AAAA,UACF;AAGA,cAAI,kBAAkB,IAAI,QAAQ,GAAG;AACnC,kBAAM,MAAM,KAAK,UAAU,CAAC;AAC5B,gBAAI,KAAK,SAAS,eAAe,kBAAkB;AACjD,yBAAW,QAAQ,IAAI,YAAY;AACjC,oBAAI,KAAK,SAAS,eAAe,UAAU;AACzC,wBAAM,YACH,KAAK,IAAI,SAAS,eAAe,cAChC,KAAK,IAAI,SAAS,UACnB,KAAK,IAAI,SAAS,eAAe,WAChC,KAAK,IAAI,UAAU;AACvB,sBAAI,WAAW;AACb,0BAAM,YAAY,sBAAsB,KAAK,KAAK;AAClD,wBAAI,WAAW;AACb,0CAAoB,KAAK,OAAO,SAAS;AAAA,oBAC3C;AAAA,kBACF;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AACA;AAAA,UACF;AAAA,QACF;AAGA,YAAI,KAAK,OAAO,SAAS,eAAe,gBAAgB;AACtD,gBAAM,YAAY,KAAK;AAEvB,cAAI,UAAU,OAAO,SAAS,eAAe,YAAY;AACvD,kBAAM,WAAW,UAAU,OAAO;AAGlC,gBAAI,CAAC,QAAQ,uBAAuB,UAAU,MAAM,GAAG;AACrD;AAAA,YACF;AAGA,gBAAI,kBAAkB,IAAI,QAAQ,GAAG;AACnC,oBAAM,UAAU,UAAU,UAAU,CAAC;AACrC,kBAAI,SAAS;AACX,sBAAM,YAAY,sBAAsB,OAAO;AAC/C,oBAAI,WAAW;AACb,sCAAoB,SAAS,SAAS;AAAA,gBACxC;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IAAA;AAAA,EAEJ,CAAC;AACH,CAAC;"}

package/dist/esm/rules/route-param-names/route-param-names.utils.d.ts

@@ -0,0 +1,43 @@
+export interface ExtractedParam {
+    /** The full param string including $ prefix (e.g., "$userId", "-$optional") */
+    fullParam: string;
+    /** The param name without $ prefix (e.g., "userId", "optional") */
+    paramName: string;
+    /** Whether this is an optional param (prefixed with -$) */
+    isOptional: boolean;
+    /** Whether this param name is valid */
+    isValid: boolean;
+}
+/**
+ * Extracts param names from a route path segment.
+ *
+ * Handles these patterns:
+ * - $paramName                     -> extract "paramName"
+ * - {$paramName}                   -> extract "paramName"
+ * - prefix{$paramName}suffix       -> extract "paramName"
+ * - {-$paramName}                  -> extract "paramName" (optional)
+ * - prefix{-$paramName}suffix      -> extract "paramName" (optional)
+ * - $ or {$}                       -> wildcard, skip validation
+ */
+export declare function extractParamsFromSegment(segment: string): Array<ExtractedParam>;
+/**
+ * Extracts all params from a route path.
+ *
+ * @param path - The route path (e.g., "/users/$userId/posts/$postId")
+ * @returns Array of extracted params with validation info
+ */
+export declare function extractParamsFromPath(path: string): Array<ExtractedParam>;
+/**
+ * Validates a single param name.
+ *
+ * @param paramName - The param name to validate (without $ prefix)
+ * @returns Whether the param name is valid
+ */
+export declare function isValidParamName(paramName: string): boolean;
+/**
+ * Gets all invalid params from a route path.
+ *
+ * @param path - The route path
+ * @returns Array of invalid param info
+ */
+export declare function getInvalidParams(path: string): Array<ExtractedParam>;