|
| 1 | +import { createRule } from '../utils/index.js'; |
| 2 | +import { type TSTools, getTypeScriptTools } from 'src/utils/ts-utils/index.js'; |
| 3 | +import { |
| 4 | + type MethodSignature, |
| 5 | + type Symbol, |
| 6 | + SymbolFlags, |
| 7 | + SyntaxKind, |
| 8 | + type Type, |
| 9 | + type TypeReferenceNode, |
| 10 | + type PropertySignature |
| 11 | +} from 'typescript'; |
| 12 | +import type { CallExpression } from 'estree'; |
| 13 | + |
| 14 | +export default createRule('require-event-prefix', { |
| 15 | + meta: { |
| 16 | + docs: { |
| 17 | + description: 'require component event names to start with "on"', |
| 18 | + category: 'Stylistic Issues', |
| 19 | + conflictWithPrettier: false, |
| 20 | + recommended: false |
| 21 | + }, |
| 22 | + schema: [ |
| 23 | + { |
| 24 | + type: 'object', |
| 25 | + properties: { |
| 26 | + checkAsyncFunctions: { |
| 27 | + type: 'boolean' |
| 28 | + } |
| 29 | + }, |
| 30 | + additionalProperties: false |
| 31 | + } |
| 32 | + ], |
| 33 | + messages: { |
| 34 | + nonPrefixedFunction: 'Component event name must start with "on".' |
| 35 | + }, |
| 36 | + type: 'suggestion', |
| 37 | + conditions: [ |
| 38 | + { |
| 39 | + svelteVersions: ['5'], |
| 40 | + svelteFileTypes: ['.svelte'] |
| 41 | + } |
| 42 | + ] |
| 43 | + }, |
| 44 | + create(context) { |
| 45 | + const tsTools = getTypeScriptTools(context); |
| 46 | + if (!tsTools) { |
| 47 | + return {}; |
| 48 | + } |
| 49 | + |
| 50 | + const checkAsyncFunctions = context.options[0]?.checkAsyncFunctions ?? false; |
| 51 | + |
| 52 | + return { |
| 53 | + CallExpression(node) { |
| 54 | + const propsType = getPropsType(node, tsTools); |
| 55 | + if (propsType === undefined) { |
| 56 | + return; |
| 57 | + } |
| 58 | + for (const property of propsType.getProperties()) { |
| 59 | + if (isFunctionLike(property) && !property.getName().startsWith('on')) { |
| 60 | + if (!checkAsyncFunctions && isFunctionAsync(property)) { |
| 61 | + continue; |
| 62 | + } |
| 63 | + context.report({ |
| 64 | + node, |
| 65 | + messageId: 'nonPrefixedFunction' |
| 66 | + }); |
| 67 | + } |
| 68 | + } |
| 69 | + } |
| 70 | + }; |
| 71 | + } |
| 72 | +}); |
| 73 | + |
| 74 | +function getPropsType(node: CallExpression, tsTools: TSTools): Type | undefined { |
| 75 | + if ( |
| 76 | + node.callee.type !== 'Identifier' || |
| 77 | + node.callee.name !== '$props' || |
| 78 | + node.parent.type !== 'VariableDeclarator' |
| 79 | + ) { |
| 80 | + return undefined; |
| 81 | + } |
| 82 | + |
| 83 | + const tsNode = tsTools.service.esTreeNodeToTSNodeMap.get(node.parent.id); |
| 84 | + if (tsNode === undefined) { |
| 85 | + return undefined; |
| 86 | + } |
| 87 | + |
| 88 | + const checker = tsTools.service.program.getTypeChecker(); |
| 89 | + return checker.getTypeAtLocation(tsNode); |
| 90 | +} |
| 91 | + |
| 92 | +function isFunctionLike(functionSymbol: Symbol): boolean { |
| 93 | + return ( |
| 94 | + (functionSymbol.getFlags() & SymbolFlags.Method) !== 0 || |
| 95 | + (functionSymbol.valueDeclaration?.kind === SyntaxKind.PropertySignature && |
| 96 | + (functionSymbol.valueDeclaration as PropertySignature).type?.kind === SyntaxKind.FunctionType) |
| 97 | + ); |
| 98 | +} |
| 99 | + |
| 100 | +function isFunctionAsync(functionSymbol: Symbol): boolean { |
| 101 | + return ( |
| 102 | + functionSymbol.getDeclarations()?.some((declaration) => { |
| 103 | + if (declaration.kind !== SyntaxKind.MethodSignature) { |
| 104 | + return false; |
| 105 | + } |
| 106 | + const declarationType = (declaration as MethodSignature).type; |
| 107 | + if (declarationType?.kind !== SyntaxKind.TypeReference) { |
| 108 | + return false; |
| 109 | + } |
| 110 | + const declarationTypeName = (declarationType as TypeReferenceNode).typeName; |
| 111 | + return ( |
| 112 | + declarationTypeName.kind === SyntaxKind.Identifier && |
| 113 | + declarationTypeName.escapedText === 'Promise' |
| 114 | + ); |
| 115 | + }) ?? false |
| 116 | + ); |
| 117 | +} |
0 commit comments