@grafana/plugin-meta-extractor 0.0.1 → 0.0.2-canary.902.bd718a3.0

package/dist/utils.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.debug = exports.parseExtensionPointOptions = exports.parseExtensionPointId = exports.parseString = exports.getExtensionConfigs = exports.getComponentExtensionConfigs = exports.getLinkExtensionsConfigs = void 0;
 const ts = __importStar(require("typescript"));
 const debug_1 = __importDefault(require("debug"));
-const tsquery = __importStar(require("@phenomnomnominal/tsquery"));
 const types_1 = require("./types");
 const _debug = (0, debug_1.default)('plugin-meta-extractor');
 const CONFIGURE_FN_NAME_TO_TYPE = {
@@ -45,7 +44,7 @@ function getComponentExtensionConfigs(ast, checker) {
 }
 exports.getComponentExtensionConfigs = getComponentExtensionConfigs;
 function getExtensionConfigs(functionName, ast, checker) {
-    const identifiers = tsquery.query(ast, `Identifier[name=${functionName}]`);
+    const identifiers = query(ast, createIdentifierMatcher(functionName));
     const extensionConfigs = [];
     for (const identifier of identifiers) {
         const callExpression = identifier.parent.parent;
@@ -63,6 +62,40 @@ function getExtensionConfigs(functionName, ast, checker) {
     return extensionConfigs;
 }
 exports.getExtensionConfigs = getExtensionConfigs;
+function createIdentifierMatcher(functionName) {
+    return (node) => {
+        if (!ts.isIdentifier(node)) {
+            return false;
+        }
+        return node.escapedText === functionName;
+    };
+}
+function query(node, findMatches) {
+    const results = [];
+    traverse(node, (childNode, ancestry) => {
+        if (findMatches(childNode, ancestry)) {
+            results.push(childNode);
+        }
+    });
+    return results;
+}
+function traverse(node, iterator, ancestors = []) {
+    if (node.parent != null) {
+        ancestors.unshift(node.parent);
+    }
+    iterator(node, ancestors);
+    let children = [];
+    try {
+        // We need to use `getChildren()` to traverse JSDoc nodes
+        children = node.getChildren();
+    }
+    catch {
+        // but it will fail for synthetic nodes, in which case we fall back:
+        node.forEachChild((child) => traverse(child, iterator, ancestors));
+    }
+    children.forEach((child) => traverse(child, iterator, ancestors));
+    ancestors.shift();
+}
 function parseString(node) {
     // If value is simple string
     if (ts.isStringLiteral(node)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-meta-extractor",
-  "version": "0.0.1",
+  "version": "0.0.2-canary.902.bd718a3.0",
   "description": "Extract meta information from a Grafana plugin source code.",
   "types": "./dist/index.d.ts",
   "bin": "./dist/bin/run.js",
@@ -32,9 +32,8 @@
     "url": "https://github.com/grafana/plugin-tools/issues"
   },
   "dependencies": {
-    "@phenomnomnominal/tsquery": "^6.1.3",
     "debug": "^4.3.4",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   },
   "devDependencies": {
     "@grafana/data": "^10.4.1",
@@ -44,5 +43,5 @@
     "react": "^18.2.0",
     "ts-jest": "^29.1.2"
   },
-  "gitHead": "5533099402b7b5f626223a8d58592984c45b13eb"
+  "gitHead": "bd718a345d9eaf999d039d8eaac6aa41a27b0542"
 }

package/src/meta-extractor.ts

@@ -33,7 +33,6 @@ export function extractPluginExtensions(entry: string): PluginExtensionMeta[] {
 
   const linkExtensionConfigs = getLinkExtensionsConfigs(appNode, checker);
   const componentExtensionConfigs = getComponentExtensionConfigs(appNode, checker);
-
   return [...linkExtensionConfigs, ...componentExtensionConfigs];
 }
 

package/src/utils.ts

@@ -1,6 +1,5 @@
 import * as ts from 'typescript';
 import createDebug from 'debug';
-import * as tsquery from '@phenomnomnominal/tsquery';
 import { PluginExtensionTypes } from './types';
 
 const _debug = createDebug('plugin-meta-extractor');
@@ -19,7 +18,7 @@ export function getComponentExtensionConfigs(ast: ts.Node, checker: ts.TypeCheck
 }
 
 export function getExtensionConfigs(functionName: string, ast: ts.Node, checker: ts.TypeChecker) {
-  const identifiers = tsquery.query(ast, `Identifier[name=${functionName}]`) as ts.Identifier[];
+  const identifiers = query(ast, createIdentifierMatcher(functionName));
   const extensionConfigs = [];
 
   for (const identifier of identifiers) {
@@ -39,6 +38,48 @@ export function getExtensionConfigs(functionName: string, ast: ts.Node, checker:
   return extensionConfigs;
 }
 
+function createIdentifierMatcher(functionName: string): (node: ts.Node) => boolean {
+  return (node) => {
+    if (!ts.isIdentifier(node)) {
+      return false;
+    }
+    return node.escapedText === functionName;
+  };
+}
+
+function query(node: ts.Node, findMatches: (node: ts.Node, ancestry: ts.Node[]) => boolean) {
+  const results: ts.Node[] = [];
+
+  traverse(node, (childNode: ts.Node, ancestry: ts.Node[]) => {
+    if (findMatches(childNode, ancestry)) {
+      results.push(childNode);
+    }
+  });
+
+  return results;
+}
+
+function traverse(
+  node: ts.Node,
+  iterator: (node: ts.Node, ancestors: ts.Node[]) => void,
+  ancestors: ts.Node[] = []
+): void {
+  if (node.parent != null) {
+    ancestors.unshift(node.parent);
+  }
+  iterator(node, ancestors);
+  let children: ts.Node[] = [];
+  try {
+    // We need to use `getChildren()` to traverse JSDoc nodes
+    children = node.getChildren();
+  } catch {
+    // but it will fail for synthetic nodes, in which case we fall back:
+    node.forEachChild((child) => traverse(child, iterator, ancestors));
+  }
+  children.forEach((child) => traverse(child, iterator, ancestors));
+  ancestors.shift();
+}
+
 export function parseString(node: ts.Expression): string {
   // If value is simple string
   if (ts.isStringLiteral(node)) {