@tanstack/eslint-plugin-router 1.20.3-alpha.1

package/src/utils/detect-router-imports.ts

@@ -0,0 +1,94 @@
+import { TSESTree } from '@typescript-eslint/utils'
+import type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'
+
+type Create = Parameters<
+  ReturnType<typeof ESLintUtils.RuleCreator>
+>[0]['create']
+
+type Context = Parameters<Create>[0]
+type Options = Parameters<Create>[1]
+type Helpers = {
+  isSpecificTanstackRouterImport: (
+    node: TSESTree.Identifier,
+    source: string,
+  ) => boolean
+  isTanstackRouterImport: (node: TSESTree.Identifier) => boolean
+}
+
+type EnhancedCreate = (
+  context: Context,
+  options: Options,
+  helpers: Helpers,
+) => ReturnType<Create>
+
+export function detectTanstackRouterImports(create: EnhancedCreate): Create {
+  return (context, optionsWithDefault) => {
+    const tanstackRouterImportSpecifiers: Array<TSESTree.ImportClause> = []
+
+    const helpers: Helpers = {
+      isSpecificTanstackRouterImport(node, source) {
+        return !!tanstackRouterImportSpecifiers.find((specifier) => {
+          if (
+            specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&
+            specifier.parent.type ===
+              TSESTree.AST_NODE_TYPES.ImportDeclaration &&
+            specifier.parent.source.value === source
+          ) {
+            return node.name === specifier.local.name
+          }
+
+          return false
+        })
+      },
+      isTanstackRouterImport(node) {
+        return !!tanstackRouterImportSpecifiers.find((specifier) => {
+          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {
+            return node.name === specifier.local.name
+          }
+
+          return false
+        })
+      },
+    }
+
+    const detectionInstructions: TSESLint.RuleListener = {
+      ImportDeclaration(node) {
+        if (
+          node.specifiers.length > 0 &&
+          node.importKind === 'value' &&
+          node.source.value.startsWith('@tanstack/') &&
+          node.source.value.endsWith('-router')
+        ) {
+          tanstackRouterImportSpecifiers.push(...node.specifiers)
+        }
+      },
+    }
+
+    // Call original rule definition
+    const ruleInstructions = create(context, optionsWithDefault, helpers)
+    const enhancedRuleInstructions: TSESLint.RuleListener = {}
+
+    const allKeys = new Set(
+      Object.keys(detectionInstructions).concat(Object.keys(ruleInstructions)),
+    )
+
+    // Iterate over ALL instructions keys so we can override original rule instructions
+    // to prevent their execution if conditions to report errors are not met.
+    allKeys.forEach((instruction) => {
+      enhancedRuleInstructions[instruction] = (node) => {
+        if (instruction in detectionInstructions) {
+          detectionInstructions[instruction]?.(node)
+        }
+
+        const ruleFunction = ruleInstructions[instruction]
+        if (ruleFunction !== undefined) {
+          return ruleFunction(node)
+        }
+
+        return undefined
+      }
+    })
+
+    return enhancedRuleInstructions
+  }
+}

package/src/utils/get-docs-url.ts

@@ -0,0 +1,2 @@
+export const getDocsUrl = (ruleName: string): string =>
+  `https://tanstack.com/router/latest/docs/eslint/${ruleName}`