@vuedx/template-ast-types v0.7.4

Support

This package is part of VueDX project, maintained by Rahul Kadyan. You can 💖 sponsor him for continued development of this package and other VueDX tools.

Usage

npm add @vuedx/template-ast-types

API

createSimpleExpression

Create AST Node

Signature:

declare function createSimpleExpression(content: SimpleExpressionNode['content'], isStatic: SimpleExpressionNode['isStatic'], loc?: SourceLocation, isConstant?: boolean): SimpleExpressionNode;

findParentNode

Find the parent element node.

Signature:

declare function findParentNode(ast: RootNode, node: Node): ElementNode | undefined;

findTemplateChildNodeAt

Find a child (element, component, text, interpolation, or comment) node containing the given position.

Signature:

declare function findTemplateChildNodeAt(ast: RootNode, position: number, mode?: 'start' | 'end'): SearchResult;

findTemplateChildrenInRange

Get all child (element, component, text, interpolation, or comment) nodes contained in given range. (partial overlaps are ignored)

Signature:

declare function findTemplateChildrenInRange(ast: RootNode, start: number, end: number): Node[];

findTemplateNodeAt

Find the deepest node containing the given position.

Signature:

declare function findTemplateNodeAt(ast: RootNode, position: number): SearchResult;

findTemplateNodeInRange

Find the deepest node containing the given position.

Signature:

declare function findTemplateNodeInRange(ast: RootNode, start: number, end: number, mode?: 'start' | 'end'): SearchResult;

findTemplateNodesInRange

Get all nodes contained in given range. (partial overlaps are ignored)

Signature:

declare function findTemplateNodesInRange(ast: RootNode, start: number, end: number): Node[];

isAttributeNode

Checks if it is an AST AttributeNode.

Signature:

declare function isAttributeNode(node: unknown): node is AttributeNode;

isCommentNode

Checks if it is an AST CommentNode.

Signature:

declare function isCommentNode(node: unknown): node is CommentNode;

isComponentNode

Checks if it is an AST ComponentNode.

Signature:

declare function isComponentNode(node: unknown): node is ComponentNode;

isDirectiveNode

Checks if it is an AST DirectiveNode.

Signature:

declare function isDirectiveNode(node: unknown): node is DirectiveNode;

isElementNode

Checks if it is an AST ElementNode.

Signature:

declare function isElementNode(node: unknown): node is ElementNode;

isInterpolationNode

Checks if it is an AST InterpolationNode.

Signature:

declare function isInterpolationNode(node: unknown): node is InterpolationNode;

isNode

Checks if it is Vue template AST Node.

Signature:

declare function isNode(node: unknown): node is Node;

isPlainElementNode

Checks if it is an AST PlainElementNode.

Signature:

declare function isPlainElementNode(node: unknown): node is PlainElementNode;

isRootNode

Checks if it is an AST RootNode.

Signature:

declare function isRootNode(node: unknown): node is RootNode;

isSimpleExpressionNode

Checks if it is an AST ExpressionNode.

Signature:

declare function isSimpleExpressionNode(node: unknown): node is SimpleExpressionNode;

isSimpleIdentifier

Checks if it is a valid JavaScript identifers.

Signature:

declare function isSimpleIdentifier(content: string): boolean;

isTemplateNode

Checks if it is an AST TemplateNode.

Signature:

declare function isTemplateNode(node: unknown): node is TemplateNode;

isTextNode

Checks if it is an AST TextNode.

Signature:

declare function isTextNode(node: unknown): node is TextNode;

stringify

Convert template AST to template code.

Signature:

declare function stringify(node: Node | Node[], options?: Partial<StringifyOptions>): string;

traverse

A general AST traversal utility with both prefix and postfix handlers, and a state object. Exposes ancestry data to each handler so that more complex AST data can be taken into account.

Signature:

declare function traverse<T>(node: Node, handlers: TraversalHandler<T> | TraversalHandlers<T>, state?: T): void;

traverseEvery

An abortable AST traversal utility. Return false (or falsy value) to stop traversal.

Signature:

declare function traverseEvery<T>(node: Node, enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean, state?: any, ancestors?: TraversalAncestors): void;

traverseFast

A faster AST traversal utility. It behaves same as traverse() but there is no ancestory data.

Signature:

declare function traverseFast<T = any>(node: object, enter: (node: Node, state: T, stop: () => void) => void, state?: T): void;

Types

SearchResult

interface SearchResult {
  ancestors: TraversalAncestors;
  node: Node | null;
}

StringifyOptions

interface StringifyOptions {
  directive: 'shorthand' | 'longhand';
  indent: number;
  initialIndent: number;
  replaceNodes: Map<Node, Node | null>;
}

TraversalHandlers

interface TraversalHandlers<T> {
  enter?: TraversalHandler<T>;
  exit?: TraversalHandler<T>;
}