@immense/vue-pom-generator 1.0.65 → 1.0.67

package/plugin/runtime/annotator/vue-detector.ts

@@ -0,0 +1,216 @@
+export interface VueDetectorOptions {
+  sourceAttribute: string;
+  metadataAttributePrefix: string;
+}
+
+interface VueInstance {
+  parent?: VueInstance;
+  type?: { name?: string; __name?: string; __file?: string };
+  vnode?: { props?: Record<string, unknown> };
+  $parent?: VueInstance;
+  $options?: { name?: string; _componentTag?: string; __file?: string };
+}
+
+export interface ResolvedVueComponentInfo {
+  component?: string;
+  source?: string;
+  formatted?: string;
+}
+
+const ignoredComponentNamePattern = /^(?:items\[\d+\]\.template|template|anonymous|slot|transition|transition-group)$/i;
+
+function getDirectVueInstances(element: Element): VueInstance[] {
+  const instances: VueInstance[] = [];
+  const vue2Instance = (element as Element & { __vue__?: VueInstance }).__vue__;
+  const vue3Instance = (element as Element & { __vueParentComponent?: VueInstance }).__vueParentComponent;
+
+  if (vue2Instance) {
+    instances.push(vue2Instance);
+  }
+
+  if (vue3Instance && vue3Instance !== vue2Instance) {
+    instances.push(vue3Instance);
+  }
+
+  return instances;
+}
+
+function stripSourcePosition(sourcePath: string): string {
+  return sourcePath.replace(/:\d+:\d+$/, "");
+}
+
+function inferNameFromFile(filePath: string): string | null {
+  const fileName = stripSourcePosition(filePath).split("/").pop();
+  if (!fileName) {
+    return null;
+  }
+  return fileName.replace(/\.vue$/, "");
+}
+
+function isMeaningfulComponentName(name: string | null | undefined): name is string {
+  return !!name && !ignoredComponentNamePattern.test(name.trim());
+}
+
+function isComponentLikeSourceTag(tag: string | null | undefined): tag is string {
+  return !!tag && (/[A-Z]/.test(tag.trim()) || tag.includes("-"));
+}
+
+export function formatSourceLabel(sourcePath: string, includePosition = true): string {
+  const match = sourcePath.match(/^(.*?)(?::(\d+):(\d+))?$/);
+  if (!match) {
+    return sourcePath;
+  }
+
+  const [, rawPath, line, column] = match;
+  const frontendPathMatch = rawPath.match(/(?:^|\/)frontend\/(src\/.*)$/);
+  const normalizedPath = frontendPathMatch?.[1] ?? rawPath;
+
+  if (includePosition && line && column) {
+    return `${normalizedPath}:${line}:${column}`;
+  }
+
+  return normalizedPath;
+}
+
+function getStringPropValue(props: Record<string, unknown> | undefined, key: string): string | undefined {
+  const value = props?.[key];
+  return typeof value === "string" && value.length > 0 ? value : undefined;
+}
+
+function getDisplayComponentName(componentName: string | null | undefined, sourcePath?: string, sourceTag?: string | null): string | undefined {
+  if (isComponentLikeSourceTag(sourceTag)) {
+    return sourceTag.trim();
+  }
+
+  const inferredName = sourcePath ? inferNameFromFile(sourcePath) : null;
+  if (isMeaningfulComponentName(inferredName)) {
+    return inferredName;
+  }
+
+  if (isMeaningfulComponentName(componentName)) {
+    return componentName.trim();
+  }
+
+  return undefined;
+}
+
+function resolveAnnotatedInfo(
+  componentName: string | null | undefined,
+  sourcePath: string | undefined,
+  sourceTag: string | null | undefined,
+): ResolvedVueComponentInfo | undefined {
+  const component = getDisplayComponentName(componentName, sourcePath, sourceTag);
+  const source = sourcePath ? formatSourceLabel(sourcePath, true) : undefined;
+
+  if (!component && !source) {
+    return undefined;
+  }
+
+  return {
+    component,
+    source,
+    formatted: component
+      ? source ? `${component} (${source})` : component
+      : source,
+  };
+}
+
+function getAnnotatedInfoFromElement(element: Element, options: VueDetectorOptions): ResolvedVueComponentInfo | undefined {
+  const pomComponentAttribute = `${options.metadataAttributePrefix}-component`;
+  const pomTagAttribute = `${options.metadataAttributePrefix}-tag`;
+  const annotatedElement = element.closest<HTMLElement>(`[${pomComponentAttribute}], [${options.sourceAttribute}]`);
+  if (!annotatedElement) {
+    return undefined;
+  }
+
+  return resolveAnnotatedInfo(
+    annotatedElement.getAttribute(pomComponentAttribute),
+    annotatedElement.getAttribute(options.sourceAttribute) ?? undefined,
+    annotatedElement.getAttribute(pomTagAttribute),
+  );
+}
+
+function getAnnotatedInfoFromInstance(instance: VueInstance, options: VueDetectorOptions): ResolvedVueComponentInfo | undefined {
+  const pomComponentAttribute = `${options.metadataAttributePrefix}-component`;
+  const pomTagAttribute = `${options.metadataAttributePrefix}-tag`;
+  return resolveAnnotatedInfo(
+    getStringPropValue(instance.vnode?.props, pomComponentAttribute),
+    getStringPropValue(instance.vnode?.props, options.sourceAttribute),
+    getStringPropValue(instance.vnode?.props, pomTagAttribute),
+  );
+}
+
+function getInstanceName(instance: VueInstance): ResolvedVueComponentInfo | undefined {
+  if (instance.$options) {
+    const name = instance.$options.name
+      ?? instance.$options._componentTag
+      ?? inferNameFromFile(instance.$options.__file ?? "");
+
+    if (isMeaningfulComponentName(name)) {
+      return {
+        component: name,
+        source: instance.$options.__file ? formatSourceLabel(instance.$options.__file, true) : undefined,
+        formatted: instance.$options.__file ? `${name} (${formatSourceLabel(instance.$options.__file, true)})` : name,
+      };
+    }
+  }
+
+  if (instance.type) {
+    const name = instance.type.name
+      ?? instance.type.__name
+      ?? inferNameFromFile(instance.type.__file ?? "");
+
+    if (isMeaningfulComponentName(name)) {
+      return {
+        component: name,
+        source: instance.type.__file ? formatSourceLabel(instance.type.__file, true) : undefined,
+        formatted: instance.type.__file ? `${name} (${formatSourceLabel(instance.type.__file, true)})` : name,
+      };
+    }
+  }
+
+  return undefined;
+}
+
+function scoreInfo(info: ResolvedVueComponentInfo | undefined): number {
+  if (!info) {
+    return -1;
+  }
+
+  return (info.component ? 10 : 0) + (info.source ? 100 : 0);
+}
+
+export function resolveVueComponentInfo(element: Element, options: VueDetectorOptions): ResolvedVueComponentInfo | undefined {
+  const annotatedElementInfo = getAnnotatedInfoFromElement(element, options);
+  if (annotatedElementInfo) {
+    return annotatedElementInfo;
+  }
+
+  const seenInstances = new Set<VueInstance>();
+  let bestInfo: ResolvedVueComponentInfo | undefined;
+  let bestScore = -1;
+  let current: Element | null = element;
+  let depth = 0;
+
+  while (current && current !== document.body && depth < 50) {
+    for (const instance of getDirectVueInstances(current)) {
+      if (seenInstances.has(instance)) {
+        continue;
+      }
+
+      seenInstances.add(instance);
+      const annotatedInstanceInfo = getAnnotatedInfoFromInstance(instance, options);
+      const candidate = annotatedInstanceInfo ?? getInstanceName(instance);
+      const score = scoreInfo(candidate);
+      if (score > bestScore) {
+        bestInfo = candidate;
+        bestScore = score;
+      }
+    }
+
+    current = current.parentElement;
+    depth += 1;
+  }
+
+  return bestInfo;
+}

package/dist/plugin/support/build-plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-plugin.d.ts","sourceRoot":"","sources":["../../../plugin/support/build-plugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAKzC,OAAO,KAAK,EAAE,sBAAsB,EAAE,iBAAiB,EAA6B,MAAM,aAAa,CAAC;AAExG,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAEvF,UAAU,qBAAqB;IAC7B,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAC3D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,WAAW,EAAE,MAAM,MAAM,EAAE,CAAC;IAC5B,gBAAgB,EAAE,MAAM,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAC9B,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAE9B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,gCAAgC,CAAC;IAC7C,cAAc,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,uCAAuC;IACvC,cAAc,EAAE,iBAAiB,CAAC;IAClC,kDAAkD;IAClD,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,2DAA2D;IAC3D,qBAAqB,EAAE,MAAM,MAAM,EAAE,CAAC;IACtC,sBAAsB,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IAEjD,SAAS,EAAE;QAAE,OAAO,EAAE,qBAAqB,CAAA;KAAE,CAAC;CAC/C;AAuCD,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,qBAAqB,GAAG,YAAY,CA6TvF"}

package/dist/plugin/support/dev-plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dev-plugin.d.ts","sourceRoot":"","sources":["../../../plugin/support/dev-plugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,YAAY,EAAiB,MAAM,MAAM,CAAC;AAKxD,OAAO,KAAK,EAA0B,iBAAiB,EAA6B,MAAM,aAAa,CAAC;AAExG,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAEvF,UAAU,mBAAmB;IAC3B,cAAc,EAAE,iBAAiB,CAAC;IAClC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,MAAM,EAAE,CAAC;IAC5B,gBAAgB,EAAE,MAAM,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAC9B,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,MAAM,EAAE,CAAC;IAEtC,cAAc,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,gCAAgC,CAAC;IAC7C,sBAAsB,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IAEjD,SAAS,EAAE;QAAE,OAAO,EAAE,qBAAqB,CAAA;KAAE,CAAC;CAC/C;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CA2iBnF"}

package/dist/plugin/support/virtual-modules.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"virtual-modules.d.ts","sourceRoot":"","sources":["../../../plugin/support/virtual-modules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAQ1D,wBAAgB,iCAAiC,CAC/C,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,EAC1D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,GACzD,MAAM,CAgBR"}

package/dist/plugin/support-plugins.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"support-plugins.d.ts","sourceRoot":"","sources":["../../plugin/support-plugins.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,+BAA+B,CAAC;AAKtF,UAAU,qBAAqB;IAC7B,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAC3D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAC3D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,cAAc,EAAE,iBAAiB,CAAC;IAClC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,MAAM,EAAE,CAAC;IAC5B,gBAAgB,EAAE,MAAM,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAC9B,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,MAAM,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,MAAM,EAAE,CAAC;IACtC,UAAU,EAAE,gCAAgC,CAAC;IAC7C,cAAc,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE;QAAE,OAAO,EAAE,qBAAqB,CAAA;KAAE,CAAC;CAC/C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,YAAY,EAAE,CAwGnF"}