web-component-analyzer/lib/cjs/analyze/flavors/analyzer-flavor.d.ts

CLI that analyzes web components

import { Node, SourceFile } from "typescript";
import { AnalyzerVisitContext } from "../analyzer-visit-context";
import { ComponentDeclaration, ComponentDeclarationKind, ComponentHeritageClause } from "../types/component-declaration";
import { ComponentCssPart } from "../types/features/component-css-part";
import { ComponentCssProperty } from "../types/features/component-css-property";
import { ComponentEvent } from "../types/features/component-event";
import { ComponentFeature } from "../types/features/component-feature";
import { ComponentMember } from "../types/features/component-member";
import { ComponentMethod } from "../types/features/component-method";
import { ComponentSlot } from "../types/features/component-slot";
export type PriorityKind = "low" | "medium" | "high";
export interface DefinitionNodeResult {
    tagName: string;
    tagNameNode?: Node;
    identifierNode?: Node;
    declarationNode?: Node;
    analyzerFlavor?: AnalyzerFlavor;
}
export interface FeatureVisitReturnTypeMap {
    member: ComponentMember;
    method: ComponentMethod;
    cssproperty: ComponentCssProperty;
    csspart: ComponentCssPart;
    event: ComponentEvent;
    slot: ComponentSlot;
}
export interface ComponentFeatureCollection {
    members: ComponentMember[];
    methods: ComponentMethod[];
    events: ComponentEvent[];
    slots: ComponentSlot[];
    cssProperties: ComponentCssProperty[];
    cssParts: ComponentCssPart[];
}
export interface AnalyzerDeclarationVisitContext extends AnalyzerVisitContext {
    getDeclaration: () => ComponentDeclaration;
    declarationNode: Node;
    sourceFile: SourceFile;
}
export type FeatureDiscoverVisitMap<Context extends AnalyzerVisitContext> = {
    [K in ComponentFeature]: (node: Node, context: Context) => FeatureVisitReturnTypeMap[K][] | undefined;
};
export type FeatureRefineVisitMap = {
    [K in ComponentFeature]: (feature: FeatureVisitReturnTypeMap[K], context: AnalyzerVisitContext) => FeatureVisitReturnTypeMap[K] | FeatureVisitReturnTypeMap[K][] | undefined;
};
export interface InheritanceResult {
    heritageClauses?: ComponentHeritageClause[];
    declarationNodes?: Node[];
    declarationKind?: ComponentDeclarationKind;
}
export interface AnalyzerFlavor {
    excludeNode?(node: Node, context: AnalyzerVisitContext): boolean | undefined;
    discoverDefinitions?(node: Node, context: AnalyzerVisitContext): DefinitionNodeResult[] | undefined;
    discoverInheritance?(node: Node, context: AnalyzerVisitContext): InheritanceResult | undefined;
    discoverFeatures?: Partial<FeatureDiscoverVisitMap<AnalyzerDeclarationVisitContext>>;
    discoverGlobalFeatures?: Partial<FeatureDiscoverVisitMap<AnalyzerVisitContext>>;
    refineFeature?: Partial<FeatureRefineVisitMap>;
    refineDeclaration?(declaration: ComponentDeclaration, context: AnalyzerDeclarationVisitContext): ComponentDeclaration | undefined;
}
//# sourceMappingURL=analyzer-flavor.d.ts.map