@blumintinc/eslint-plugin-blumint 1.12.6 → 1.13.0

package/lib/rules/prefer-global-router-state-key.js

@@ -4,81 +4,280 @@ exports.preferGlobalRouterStateKey = void 0;
 const utils_1 = require("@typescript-eslint/utils");
 const createRule_1 = require("../utils/createRule");
 /**
- * Rule to enforce best practices for the `key` parameter in `useRouterState` hook calls.
- * Encourages type safety and maintainability by using global constants or type-safe functions.
+ * Rule to enforce the use of centralized router state key constants imported from
+ * `src/util/routing/queryKeys.ts` instead of arbitrary string literals when calling
+ * router methods that accept key parameters.
  */
 exports.preferGlobalRouterStateKey = (0, createRule_1.createRule)({
     name: 'prefer-global-router-state-key',
     meta: {
-        type: 'suggestion',
+        type: 'problem',
         docs: {
-            description: 'Enforce using global constants or type-safe functions for useRouterState key parameter',
-            recommended: 'warn',
+            description: 'Enforce using centralized router state key constants from queryKeys.ts for useRouterState key parameter',
+            recommended: 'error',
         },
+        fixable: 'code',
         schema: [],
         messages: {
-            preferGlobalRouterStateKey: 'Prefer using a global constant or type-safe function for useRouterState key parameter instead of string literals',
+            preferGlobalRouterStateKey: 'Router state key {{keyValue}} is a string literal. String literals bypass the shared queryKeys.ts QUERY_KEY_* constants, which leads to duplicate router cache entries and makes allowed keys hard to discover. Import the corresponding QUERY_KEY_* constant from "@/util/routing/queryKeys" (or its approved re-export) and pass that to useRouterState instead.',
+            invalidQueryKeySource: 'Router state key variable "{{variableName}}" is not sourced from queryKeys.ts. useRouterState keys must come from QUERY_KEY_* exports so routing cache keys stay stable and traceable. Import the matching constant from "@/util/routing/queryKeys" (or its approved re-export) and use that value here instead of {{variableName}}.',
         },
     },
     defaultOptions: [],
     create(context) {
+        const sourceCode = context.getSourceCode();
+        // Track imports from queryKeys.ts
+        const queryKeyImports = new Map();
+        // Track namespace imports (import * as QueryKeys from ...)
+        const namespaceImports = new Map();
+        // Track default imports (import queryKeys from ...)
+        const defaultImports = new Map();
+        // Track re-exports and variable assignments
+        const variableAssignments = new Map();
+        const validQueryKeySources = new Set([
+            'util/routing/queryKeys',
+            'constants',
+            'constants/index',
+        ]);
         /**
-         * Checks if a node contains a string literal that should be reported
+         * Check if a source path refers to queryKeys.ts or re-exports from it
          */
-        function containsStringLiteral(node) {
+        function isQueryKeysSource(source) {
+            const normalized = source
+                .replace(/^@\/|^src\//, '')
+                .replace(/^(\.\/|\.\.\/)+/, '');
+            return (validQueryKeySources.has(normalized) ||
+                normalized.endsWith('util/routing/queryKeys'));
+        }
+        /**
+         * Check if an identifier is a valid QUERY_KEY constant
+         */
+        function isValidQueryKeyConstant(name) {
+            return name.startsWith('QUERY_KEY_');
+        }
+        /**
+         * Check if a node represents a valid query key usage
+         */
+        function isValidQueryKeyUsage(node) {
+            if (node.type === utils_1.AST_NODE_TYPES.Identifier) {
+                // Check direct imports
+                const importInfo = queryKeyImports.get(node.name);
+                if (importInfo && isQueryKeysSource(importInfo.source)) {
+                    return isValidQueryKeyConstant(importInfo.imported);
+                }
+                // Check if it's a variable derived from a query key constant
+                const assignment = variableAssignments.get(node.name);
+                if (assignment) {
+                    return isValidQueryKeyUsage(assignment);
+                }
+            }
+            // Allow member expressions accessing query key constants
+            if (node.type === utils_1.AST_NODE_TYPES.MemberExpression) {
+                if (node.object.type === utils_1.AST_NODE_TYPES.Identifier) {
+                    // Check namespace imports (QueryKeys.QUERY_KEY_USER)
+                    const namespaceSource = namespaceImports.get(node.object.name);
+                    if (namespaceSource && isQueryKeysSource(namespaceSource)) {
+                        if (node.property.type === utils_1.AST_NODE_TYPES.Identifier) {
+                            return isValidQueryKeyConstant(node.property.name);
+                        }
+                        return false; // Invalid property access on namespace import
+                    }
+                    // Check default imports (queryKeys.QUERY_KEY_USER)
+                    const defaultSource = defaultImports.get(node.object.name);
+                    if (defaultSource && isQueryKeysSource(defaultSource)) {
+                        return true; // Allow any property access on default imports
+                    }
+                    // Check regular imports
+                    const importInfo = queryKeyImports.get(node.object.name);
+                    if (importInfo && isQueryKeysSource(importInfo.source)) {
+                        return true;
+                    }
+                }
+            }
+            // Allow template literals if they use valid query keys
+            if (node.type === utils_1.AST_NODE_TYPES.TemplateLiteral) {
+                if (node.expressions.length > 0) {
+                    return node.expressions.some((expr) => isValidQueryKeyUsage(expr));
+                }
+                // Template literals with no expressions are just static strings
+                return false;
+            }
+            // Allow binary expressions if they use valid query keys
+            if (node.type === utils_1.AST_NODE_TYPES.BinaryExpression &&
+                node.operator === '+') {
+                return (isValidQueryKeyUsage(node.left) || isValidQueryKeyUsage(node.right));
+            }
+            // Allow conditional expressions if both branches use valid query keys
+            if (node.type === utils_1.AST_NODE_TYPES.ConditionalExpression) {
+                return (isValidQueryKeyUsage(node.consequent) &&
+                    isValidQueryKeyUsage(node.alternate));
+            }
+            // Allow function calls that might return query keys
+            if (node.type === utils_1.AST_NODE_TYPES.CallExpression) {
+                return true; // Permissive for function calls
+            }
+            // Allow type assertions (key as const)
+            if (node.type === utils_1.AST_NODE_TYPES.TSAsExpression) {
+                return isValidQueryKeyUsage(node.expression);
+            }
+            if (node.type === utils_1.AST_NODE_TYPES.MemberExpression) {
+                return false;
+            }
+            return false;
+        }
+        /**
+         * Check if a node contains string literals that should be reported
+         */
+        function containsInvalidStringLiteral(node) {
             // Direct string literal
             if (node.type === utils_1.AST_NODE_TYPES.Literal &&
                 typeof node.value === 'string') {
                 return true;
             }
-            // String concatenation with + operator
+            // String concatenation with + operator containing literals
             if (node.type === utils_1.AST_NODE_TYPES.BinaryExpression &&
-                node.operator === '+' &&
-                (containsStringLiteral(node.left) || containsStringLiteral(node.right))) {
-                return true;
+                node.operator === '+') {
+                return (containsInvalidStringLiteral(node.left) ||
+                    containsInvalidStringLiteral(node.right));
             }
             // Conditional (ternary) expression with string literals
-            if (node.type === utils_1.AST_NODE_TYPES.ConditionalExpression &&
-                (containsStringLiteral(node.consequent) ||
-                    containsStringLiteral(node.alternate))) {
-                return true;
+            if (node.type === utils_1.AST_NODE_TYPES.ConditionalExpression) {
+                return (containsInvalidStringLiteral(node.consequent) ||
+                    containsInvalidStringLiteral(node.alternate));
             }
-            // Template literal with static parts
+            // Template literal with static parts (but allow if it uses query key variables)
             if (node.type === utils_1.AST_NODE_TYPES.TemplateLiteral) {
-                // Only report if there's a meaningful static part in the template
-                // This allows dynamic templates like `${prefix}-${id}` but catches `static-${id}`
+                // If no expressions, it's just a static template literal
+                if (node.expressions.length === 0) {
+                    return true;
+                }
                 const hasSignificantStaticPart = node.quasis.some((quasi) => {
                     const content = quasi.value.raw.trim();
-                    // Allow common separators like '-', '_', ':', '/' as they're just joining dynamic parts
                     return content.length > 0 && !/^[-_:/.]+$/.test(content);
                 });
-                return hasSignificantStaticPart;
+                if (hasSignificantStaticPart) {
+                    return !node.expressions.every((expr) => isValidQueryKeyUsage(expr));
+                }
             }
             return false;
         }
+        /**
+         * Generate auto-fix suggestion for string literals
+         */
+        function generateAutoFix(keyValue) {
+            const normalizedKey = keyValue
+                .toUpperCase()
+                .replace(/[^A-Z0-9]/g, '_')
+                .replace(/_+/g, '_')
+                .replace(/^_|_$/g, '');
+            return `QUERY_KEY_${normalizedKey}`;
+        }
         return {
+            // Track imports from queryKeys.ts
+            ImportDeclaration(node) {
+                if (node.source.type === utils_1.AST_NODE_TYPES.Literal &&
+                    typeof node.source.value === 'string') {
+                    const source = node.source.value;
+                    if (isQueryKeysSource(source)) {
+                        node.specifiers.forEach((spec) => {
+                            if (spec.type === utils_1.AST_NODE_TYPES.ImportSpecifier) {
+                                const imported = spec.imported.name;
+                                const local = spec.local.name;
+                                queryKeyImports.set(local, { source, imported });
+                            }
+                            else if (spec.type === utils_1.AST_NODE_TYPES.ImportNamespaceSpecifier) {
+                                namespaceImports.set(spec.local.name, source);
+                            }
+                            else if (spec.type === utils_1.AST_NODE_TYPES.ImportDefaultSpecifier) {
+                                defaultImports.set(spec.local.name, source);
+                            }
+                        });
+                    }
+                }
+            },
+            // Track variable declarations that might derive from query key constants
+            VariableDeclarator(node) {
+                if (node.id.type === utils_1.AST_NODE_TYPES.Identifier && node.init) {
+                    variableAssignments.set(node.id.name, node.init);
+                }
+            },
+            // Track assignment expressions
+            AssignmentExpression(node) {
+                if (node.left.type === utils_1.AST_NODE_TYPES.Identifier &&
+                    node.operator === '=') {
+                    variableAssignments.set(node.left.name, node.right);
+                }
+            },
+            // Check useRouterState calls
             CallExpression(node) {
                 // Check if this is a call to useRouterState
                 if (node.callee.type === utils_1.AST_NODE_TYPES.Identifier &&
                     node.callee.name === 'useRouterState') {
-                    // Check if there are arguments
                     if (node.arguments.length > 0) {
                         const firstArg = node.arguments[0];
-                        // Check if the first argument is an object expression
                         if (firstArg.type === utils_1.AST_NODE_TYPES.ObjectExpression) {
-                            // Find the key property in the object
                             const keyProperty = firstArg.properties.find((prop) => prop.type === utils_1.AST_NODE_TYPES.Property &&
                                 prop.key.type === utils_1.AST_NODE_TYPES.Identifier &&
                                 prop.key.name === 'key');
-                            // If key property exists, check its value
                             if (keyProperty && keyProperty.value) {
                                 const keyValue = keyProperty.value;
-                                // Check for string literals in various contexts
-                                if (containsStringLiteral(keyValue)) {
-                                    context.report({
-                                        node: keyValue,
-                                        messageId: 'preferGlobalRouterStateKey',
-                                    });
+                                if (!isValidQueryKeyUsage(keyValue)) {
+                                    if (containsInvalidStringLiteral(keyValue)) {
+                                        context.report({
+                                            node: keyValue,
+                                            messageId: 'preferGlobalRouterStateKey',
+                                            data: {
+                                                keyValue: sourceCode.getText(keyValue),
+                                            },
+                                            fix(fixer) {
+                                                if (keyValue.type === utils_1.AST_NODE_TYPES.Literal &&
+                                                    typeof keyValue.value === 'string') {
+                                                    const suggestedConstant = generateAutoFix(keyValue.value);
+                                                    if (suggestedConstant) {
+                                                        const fixes = [];
+                                                        // 1) Replace the literal with the constant
+                                                        fixes.push(fixer.replaceText(keyValue, suggestedConstant));
+                                                        // 2) Ensure an import exists for the suggested constant
+                                                        const sourceCode = context.getSourceCode();
+                                                        const alreadyImportedNamed = Array.from(queryKeyImports.values()).some((info) => isQueryKeysSource(info.source) &&
+                                                            info.imported === suggestedConstant);
+                                                        const hasNamespaceOrDefault = namespaceImports.size > 0 ||
+                                                            defaultImports.size > 0;
+                                                        if (!alreadyImportedNamed && !hasNamespaceOrDefault) {
+                                                            const importText = `import { ${suggestedConstant} } from '@/util/routing/queryKeys';\n`;
+                                                            const firstImport = sourceCode.ast.body.find((n) => n.type === utils_1.AST_NODE_TYPES.ImportDeclaration);
+                                                            if (firstImport) {
+                                                                fixes.push(fixer.insertTextBefore(firstImport, importText));
+                                                            }
+                                                            else {
+                                                                fixes.push(fixer.insertTextBeforeRange([0, 0], importText));
+                                                            }
+                                                        }
+                                                        return fixes;
+                                                    }
+                                                }
+                                                return null;
+                                            },
+                                        });
+                                    }
+                                    else if (keyValue.type === utils_1.AST_NODE_TYPES.Identifier) {
+                                        context.report({
+                                            node: keyValue,
+                                            messageId: 'invalidQueryKeySource',
+                                            data: {
+                                                variableName: keyValue.name,
+                                            },
+                                        });
+                                    }
+                                    else if (keyValue.type === utils_1.AST_NODE_TYPES.MemberExpression) {
+                                        context.report({
+                                            node: keyValue,
+                                            messageId: 'invalidQueryKeySource',
+                                            data: {
+                                                variableName: sourceCode.getText(keyValue),
+                                            },
+                                        });
+                                    }
                                 }
                             }
                         }

package/lib/rules/prefer-next-dynamic.d.ts

@@ -0,0 +1,9 @@
+import { TSESLint } from '@typescript-eslint/utils';
+type MessageIds = 'preferNextDynamic' | 'addNextDynamicImport' | 'removeUseDynamicImport';
+type Options = [
+    {
+        useDynamicSources?: string[];
+    }?
+];
+export declare const preferNextDynamic: TSESLint.RuleModule<MessageIds, Options, TSESLint.RuleListener>;
+export {};