|
| 1 | +import type * as ESTree from "estree" |
| 2 | +import { createRule } from "../utils" |
| 3 | +import type { RuleContext } from "../types" |
| 4 | +import { extractStoreReferences } from "./reference-helpers/svelte-store" |
| 5 | + |
| 6 | +export default createRule("derived-has-same-inputs-outputs", { |
| 7 | + meta: { |
| 8 | + docs: { |
| 9 | + description: |
| 10 | + "derived store should use same variable names between values and callback", |
| 11 | + category: "Stylistic Issues", |
| 12 | + recommended: false, |
| 13 | + conflictWithPrettier: false, |
| 14 | + }, |
| 15 | + schema: [], |
| 16 | + messages: { |
| 17 | + unexpected: "The argument name should be '{{name}}'.", |
| 18 | + }, |
| 19 | + type: "suggestion", |
| 20 | + }, |
| 21 | + create(context) { |
| 22 | + /** check node type */ |
| 23 | + function isIdentifierOrArrayExpression( |
| 24 | + node: ESTree.SpreadElement | ESTree.Expression, |
| 25 | + ): node is ESTree.Identifier | ESTree.ArrayExpression { |
| 26 | + return ["Identifier", "ArrayExpression"].includes(node.type) |
| 27 | + } |
| 28 | + |
| 29 | + type ArrowFunctionExpressionOrFunctionExpression = |
| 30 | + | ESTree.ArrowFunctionExpression |
| 31 | + | ESTree.FunctionExpression |
| 32 | + |
| 33 | + /** check node type */ |
| 34 | + function isFunctionExpression( |
| 35 | + node: ESTree.SpreadElement | ESTree.Expression, |
| 36 | + ): node is ArrowFunctionExpressionOrFunctionExpression { |
| 37 | + return ["ArrowFunctionExpression", "FunctionExpression"].includes( |
| 38 | + node.type, |
| 39 | + ) |
| 40 | + } |
| 41 | + |
| 42 | + /** |
| 43 | + * Check for identifier type. |
| 44 | + * e.g. derived(a, ($a) => {}); |
| 45 | + */ |
| 46 | + function checkIdentifier( |
| 47 | + context: RuleContext, |
| 48 | + args: ESTree.Identifier, |
| 49 | + fn: ArrowFunctionExpressionOrFunctionExpression, |
| 50 | + ) { |
| 51 | + const fnParam = fn.params[0] |
| 52 | + if (fnParam.type !== "Identifier") return |
| 53 | + const expectedName = `$${args.name}` |
| 54 | + if (expectedName !== fnParam.name) { |
| 55 | + context.report({ |
| 56 | + node: fn, |
| 57 | + loc: fnParam.loc!, |
| 58 | + messageId: "unexpected", |
| 59 | + data: { name: expectedName }, |
| 60 | + }) |
| 61 | + } |
| 62 | + } |
| 63 | + |
| 64 | + /** |
| 65 | + * Check for array type. |
| 66 | + * e.g. derived([ a, b ], ([ $a, $b ]) => {}) |
| 67 | + */ |
| 68 | + function checkArrayExpression( |
| 69 | + context: RuleContext, |
| 70 | + args: ESTree.ArrayExpression, |
| 71 | + fn: ArrowFunctionExpressionOrFunctionExpression, |
| 72 | + ) { |
| 73 | + const fnParam = fn.params[0] |
| 74 | + if (fnParam.type !== "ArrayPattern") return |
| 75 | + const argNames = args.elements.map((element) => { |
| 76 | + return element && element.type === "Identifier" ? element.name : null |
| 77 | + }) |
| 78 | + fnParam.elements.forEach((element, index) => { |
| 79 | + const argName = argNames[index] |
| 80 | + if (element && element.type === "Identifier" && argName) { |
| 81 | + const expectedName = `$${argName}` |
| 82 | + if (expectedName !== element.name) { |
| 83 | + context.report({ |
| 84 | + node: fn, |
| 85 | + loc: element.loc!, |
| 86 | + messageId: "unexpected", |
| 87 | + data: { name: expectedName }, |
| 88 | + }) |
| 89 | + } |
| 90 | + } |
| 91 | + }) |
| 92 | + } |
| 93 | + |
| 94 | + return { |
| 95 | + Program() { |
| 96 | + for (const { node } of extractStoreReferences(context, ["derived"])) { |
| 97 | + const [args, fn] = node.arguments |
| 98 | + if (!args || !isIdentifierOrArrayExpression(args)) continue |
| 99 | + if (!fn || !isFunctionExpression(fn)) continue |
| 100 | + if (!fn.params || fn.params.length === 0) continue |
| 101 | + if (args.type === "Identifier") checkIdentifier(context, args, fn) |
| 102 | + else checkArrayExpression(context, args, fn) |
| 103 | + } |
| 104 | + }, |
| 105 | + } |
| 106 | + }, |
| 107 | +}) |
0 commit comments