@komaci/static-analyzer 260.30.0 → 260.32.0

package/build/shared.d.ts

@@ -35,10 +35,10 @@ export declare const LLSRange: {
  * @param rootAst the Abstract Syntax Tree for the component
  * @param moduleMetadata metadata about the given component
  * @param moduleContext contextual details about the component, like module level variables, etc
- * @param onlyValidateWireUsedGetters optional parameter to only validate getters used in wire configurations (usedInPriming: true)
+ * @param templateReferences an optional list of template reference names. If specified, only getter functions that are in this list will be validated.
  * @returns diagnostics for the getters
  */
-export declare function analyzeSrcForInvalidGetterFunctions(adgIndex: number, rootAst: t.File, moduleMetadata: ModuleMetadata, moduleContext: ModuleContext): GetterDiagnosticsContext;
+export declare function analyzeSrcForInvalidGetterFunctions(adgIndex: number, rootAst: t.File, moduleMetadata: ModuleMetadata, moduleContext: ModuleContext, templateReferences?: string[]): GetterDiagnosticsContext;
 /**
  * Function to analyze tempplate strings and collect any Priming Diagnostic info for them along with returning valid templates contexts
  * @param adgIndex index of the current adg to process

package/build/shared.js

@@ -89,10 +89,10 @@ exports.LLSRange = {
  * @param rootAst the Abstract Syntax Tree for the component
  * @param moduleMetadata metadata about the given component
  * @param moduleContext contextual details about the component, like module level variables, etc
- * @param onlyValidateWireUsedGetters optional parameter to only validate getters used in wire configurations (usedInPriming: true)
+ * @param templateReferences an optional list of template reference names. If specified, only getter functions that are in this list will be validated.
  * @returns diagnostics for the getters
  */
-function analyzeSrcForInvalidGetterFunctions(adgIndex, rootAst, moduleMetadata, moduleContext) {
+function analyzeSrcForInvalidGetterFunctions(adgIndex, rootAst, moduleMetadata, moduleContext, templateReferences) {
     const diagnostics = [];
     const validGetters = [];
     const { getters } = (0, common_shared_1.getPropertyMetadataFromAst)(rootAst);
@@ -100,20 +100,16 @@ function analyzeSrcForInvalidGetterFunctions(adgIndex, rootAst, moduleMetadata,
     const adg = moduleMetadata.adgs.get(adgIndex);
     if (getters.length > 0 && adg) {
         const usedByPrimingFunctions = new Set();
-        const usedByTemplates = new Set();
         adg.functions.forEach((func) => {
             if (func.type === common_shared_1.FunctionTypes.PRIMING_FUNCTION) {
                 func.requiredProperties.forEach((prop) => usedByPrimingFunctions.add(prop));
             }
-            if (func.type === common_shared_1.FunctionTypes.TEMPLATE_STRING) {
-                func.requiredProperties.forEach((prop) => usedByTemplates.add(prop));
-            }
         });
         getters.forEach((getterFunc, index) => {
             const getterName = (0, common_shared_1.getClassMethodName)(getterFunc);
             const property = adg.properties.get(getterName);
             const usedByPrimingFunction = usedByPrimingFunctions.has(getterName);
-            const usedInTemplate = usedByTemplates.has(getterName);
+            const usedInTemplate = templateReferences?.includes(getterName);
             const usedInPriming = typeof property !== 'undefined' ? property.usedInPriming : false;
             // Only validate getters that are used by priming or the template
             if (usedInPriming || usedByPrimingFunction || usedInTemplate) {

package/build/staticAnalyzer.d.ts

@@ -1,4 +1,5 @@
 import { KomaciDocument } from '@komaci/types';
+import type { ChildNode } from '@lwc/template-compiler';
 import { AnalyzerInput, PrimingDiagnostic, Range, Position, WireInfo } from './types';
 export declare class StaticAnalyzer {
     startPos: Position;
@@ -84,5 +85,6 @@ export declare class StaticAnalyzer {
     private reorderFunctionsByWireDependency;
     private dependsOn;
     private findWireInfo;
+    findReferences(node: ChildNode, functionNames: string[]): void;
 }
 //# sourceMappingURL=staticAnalyzer.d.ts.map

package/build/staticAnalyzer.js

@@ -55,9 +55,10 @@ class StaticAnalyzer {
             // generate komaciDoc from source file from collector in lwc-metadata-next package
             const metadataObj = this.getMetadata(input);
             if (metadataObj) {
-                let templateKomaciDoc;
                 let scriptKomaciDoc;
                 let sourceFileName;
+                let templateKomaciDoc;
+                let templateFile;
                 let templateLimitReached = false;
                 for (const file of metadataObj.files) {
                     if (file.komaciDoc) {
@@ -76,6 +77,7 @@ class StaticAnalyzer {
                                 diagnostics.push((0, rules_1.updatePrimingDiagnosticWithFileInfo)((0, rules_1.getPrimingDiagnostic)(rules_1.diagnosticMessages.NO_MULTIPLE_TEMPLATE_FILES, this.emptyRange, []), this.fileNamesMap.get('html')));
                             }
                             else {
+                                templateFile = file;
                                 templateKomaciDoc = file.komaciDoc;
                                 templateLimitReached = true;
                                 this.fileNamesMap.set('html', file.fileName);
@@ -101,10 +103,14 @@ class StaticAnalyzer {
                         astContext: (0, common_shared_1.getAstContextObject)(rootAst),
                         isExternal: (0, common_shared_1.isExternalModule)(input.namespace),
                     };
+                    const templateReferences = [];
                     if (templateKomaciDoc !== undefined) {
+                        if (templateFile && templateFile.ast) {
+                            templateFile.ast.children.forEach((child) => this.findReferences(child, templateReferences));
+                        }
                         (0, common_shared_1.addTemplateUsageForAdg)(templateKomaciDoc, adgIndex, moduleMetadata);
                     }
-                    const { getterFunctionDiagnostics, validGetters } = (0, shared_1.analyzeSrcForInvalidGetterFunctions)(adgIndex, rootAst, moduleMetadata, moduleContext);
+                    const { getterFunctionDiagnostics, validGetters } = (0, shared_1.analyzeSrcForInvalidGetterFunctions)(adgIndex, rootAst, moduleMetadata, moduleContext, templateReferences);
                     const { templateDiagnostics, validTemplates } = (0, shared_1.analyzeSrcForTemplateStringDiagnostics)(adgIndex, rootAst, moduleMetadata, moduleContext);
                     const getterAndTemplateDiagnostics = [
                         ...getterFunctionDiagnostics,
@@ -782,6 +788,32 @@ class StaticAnalyzer {
         }
         return wireInfo;
     }
+    findReferences(node, functionNames) {
+        // Rule: If type is "If", "ForEach", or "ForOf" and condition.type is "Identifier"
+        if ((node.type === 'If' || node.type === 'ForEach' || node.type === 'ForOf') &&
+            'condition' in node &&
+            node.condition &&
+            typeof node.condition === 'object' &&
+            'type' in node.condition &&
+            node.condition.type === 'Identifier' &&
+            'name' in node.condition) {
+            functionNames.push(node.condition.name);
+        }
+        // Rule: If type is "Text" and value.type is "Identifier"
+        if (node.type === 'Text' &&
+            'value' in node &&
+            node.value &&
+            typeof node.value === 'object' &&
+            'type' in node.value &&
+            node.value.type === 'Identifier' &&
+            'name' in node.value) {
+            functionNames.push(node.value.name);
+        }
+        // Recurse into children
+        if ('children' in node && Array.isArray(node.children)) {
+            node.children.forEach((child) => this.findReferences(child, functionNames));
+        }
+    }
 }
 exports.StaticAnalyzer = StaticAnalyzer;
 //# sourceMappingURL=staticAnalyzer.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/static-analyzer",
-    "version": "260.30.0",
+    "version": "260.32.0",
     "description": "Komaci Diagnostics API",
     "homepage": "https://komaci.dev/",
     "repository": {
@@ -29,10 +29,10 @@
     ],
     "dependencies": {
         "@babel/types": "^7.9.0",
-        "@komaci/common-shared": "258.0.0"
+        "@komaci/common-shared": "^260.31.0"
     },
     "devDependencies": {
-        "@komaci/types": "258.0.0"
+        "@komaci/types": "^260.31.0"
     },
     "peerDependencies": {
         "@lwc/metadata": "^12.0.0",