New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@vuedx/template-ast-types
Advanced tools
@vuedx/template-ast-types - npm Package Compare versions
Comparing version 0.7.3-next-1649585554.0 to 0.7.3-next-1649614433.0
| { | ||
| "name": "@vuedx/template-ast-types", | ||
| "version": "0.7.3-next-1649585554.0", | ||
| "version": "0.7.3-next-1649614433.0", | ||
| "description": "Helper functions for Vue template AST", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
348
readme.md
@@ -7,6 +7,2 @@ <div align="center" style="text-align: center; margin-bottom: 72px"> | ||
| ## Support | ||
| This package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools. | ||
| ## Usage | ||
@@ -17,2 +13,3 @@ | ||
| ``` | ||
| <!-- #region API-DOCS --> | ||
@@ -23,3 +20,2 @@ <!-- Do not edit this file. It is a report generated by [scripts/docgen.js](https://github.com/znck/vue-developer-experience/tree/main/scripts/docgen.js). --> | ||
| <a href="#-vuedx-template-ast-types-createSimpleExpression-function-1-" id="-vuedx-template-ast-types-createSimpleExpression-function-1-"></a> | ||
@@ -35,12 +31,18 @@ | ||
| **Signature:** | ||
| ```ts | ||
| declare function createSimpleExpression(content: SimpleExpressionNode['content'], isStatic: SimpleExpressionNode['isStatic'], loc?: SourceLocation, isConstant?: boolean): SimpleExpressionNode; | ||
| declare function createSimpleExpression( | ||
| content: SimpleExpressionNode['content'], | ||
| isStatic: SimpleExpressionNode['isStatic'], | ||
| loc?: SourceLocation, | ||
| isConstant?: boolean, | ||
| ): SimpleExpressionNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | content | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['content']</code> | - | | ||
| | isStatic | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['isStatic']</code> | - | | ||
| | loc | <code><a href="#-vue-compiler-core-SourceLocation-interface">SourceLocation</a></code> | - | | ||
| | isConstant | <code>boolean</code> | - | | ||
| | Parameter | Type | Description | | ||
| | ---------- | -------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | content | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['content']</code> | - | | ||
| | isStatic | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['isStatic']</code> | - | | ||
| | loc | <code><a href="#-vue-compiler-core-SourceLocation-interface">SourceLocation</a></code> | - | | ||
| | isConstant | <code>boolean</code> | - | | ||
@@ -60,10 +62,14 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findParentNode(ast: RootNode, node: Node): ElementNode | undefined; | ||
| declare function findParentNode( | ||
| ast: RootNode, | ||
| node: Node, | ||
| ): ElementNode | undefined | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ----------- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
@@ -83,11 +89,16 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findTemplateChildNodeAt(ast: RootNode, position: number, mode?: 'start' | 'end'): SearchResult; | ||
| declare function findTemplateChildNodeAt( | ||
| ast: RootNode, | ||
| position: number, | ||
| mode?: 'start' | 'end', | ||
| ): SearchResult | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | position | <code>number</code> | - | | ||
| | mode | <code>'start' | 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | position | <code>number</code> | - | | ||
| | mode | <code>'start' | 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] | | ||
@@ -107,11 +118,16 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findTemplateChildrenInRange(ast: RootNode, start: number, end: number): Node[]; | ||
| declare function findTemplateChildrenInRange( | ||
| ast: RootNode, | ||
| start: number, | ||
| end: number, | ||
| ): Node[] | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ----------- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
@@ -131,10 +147,14 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findTemplateNodeAt(ast: RootNode, position: number): SearchResult; | ||
| declare function findTemplateNodeAt( | ||
| ast: RootNode, | ||
| position: number, | ||
| ): SearchResult | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | position | <code>number</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ----------- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | position | <code>number</code> | - | | ||
@@ -154,12 +174,18 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findTemplateNodeInRange(ast: RootNode, start: number, end: number, mode?: 'start' | 'end'): SearchResult; | ||
| declare function findTemplateNodeInRange( | ||
| ast: RootNode, | ||
| start: number, | ||
| end: number, | ||
| mode?: 'start' | 'end', | ||
| ): SearchResult | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
| | mode | <code>'start' | 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
| | mode | <code>'start' | 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] | | ||
@@ -179,11 +205,16 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function findTemplateNodesInRange(ast: RootNode, start: number, end: number): Node[]; | ||
| declare function findTemplateNodesInRange( | ||
| ast: RootNode, | ||
| start: number, | ||
| end: number, | ||
| ): Node[] | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------- | ----------- | | ||
| | ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - | | ||
| | start | <code>number</code> | - | | ||
| | end | <code>number</code> | - | | ||
@@ -203,9 +234,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isAttributeNode(node: unknown): node is AttributeNode; | ||
| declare function isAttributeNode(node: unknown): node is AttributeNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -225,9 +257,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isCommentNode(node: unknown): node is CommentNode; | ||
| declare function isCommentNode(node: unknown): node is CommentNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -247,9 +280,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isComponentNode(node: unknown): node is ComponentNode; | ||
| declare function isComponentNode(node: unknown): node is ComponentNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -269,9 +303,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isDirectiveNode(node: unknown): node is DirectiveNode; | ||
| declare function isDirectiveNode(node: unknown): node is DirectiveNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -291,9 +326,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isElementNode(node: unknown): node is ElementNode; | ||
| declare function isElementNode(node: unknown): node is ElementNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -313,9 +349,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isInterpolationNode(node: unknown): node is InterpolationNode; | ||
| declare function isInterpolationNode(node: unknown): node is InterpolationNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -335,9 +372,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isNode(node: unknown): node is Node; | ||
| declare function isNode(node: unknown): node is Node | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -357,9 +395,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isPlainElementNode(node: unknown): node is PlainElementNode; | ||
| declare function isPlainElementNode(node: unknown): node is PlainElementNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -379,9 +418,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isRootNode(node: unknown): node is RootNode; | ||
| declare function isRootNode(node: unknown): node is RootNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -401,9 +441,12 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isSimpleExpressionNode(node: unknown): node is SimpleExpressionNode; | ||
| declare function isSimpleExpressionNode( | ||
| node: unknown, | ||
| ): node is SimpleExpressionNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -423,9 +466,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isSimpleIdentifier(content: string): boolean; | ||
| declare function isSimpleIdentifier(content: string): boolean | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | content | <code>string</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | ------------------- | ----------- | | ||
| | content | <code>string</code> | - | | ||
@@ -445,9 +489,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isTemplateNode(node: unknown): node is TemplateNode; | ||
| declare function isTemplateNode(node: unknown): node is TemplateNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -467,9 +512,10 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function isTextNode(node: unknown): node is TextNode; | ||
| declare function isTextNode(node: unknown): node is TextNode | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>unknown</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------- | ----------- | | ||
| | node | <code>unknown</code> | - | | ||
@@ -489,10 +535,14 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function stringify(node: Node | Node[], options?: Partial<StringifyOptions>): string; | ||
| declare function stringify( | ||
| node: Node | Node[], | ||
| options?: Partial<StringifyOptions>, | ||
| ): string | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a> | <a href="#-vue-compiler-core--Node-2-interface">Node</a>[]</code> | - | | ||
| | options | <code><a href="#-Partial-type">Partial</a><<a href="#-vuedx-template-ast-types--StringifyOptions-interface">StringifyOptions</a>></code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a> | <a href="#-vue-compiler-core--Node-2-interface">Node</a>[]</code> | - | | ||
| | options | <code><a href="#-Partial-type">Partial</a><<a href="#-vuedx-template-ast-types--StringifyOptions-interface">StringifyOptions</a>></code> | - | | ||
@@ -512,11 +562,16 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function traverse<T>(node: Node, handlers: TraversalHandler<T> | TraversalHandlers<T>, state?: T): void; | ||
| declare function traverse<T>( | ||
| node: Node, | ||
| handlers: TraversalHandler<T> | TraversalHandlers<T>, | ||
| state?: T, | ||
| ): void | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
| | handlers | <code><a href="#-vuedx-template-ast-types--TraversalHandler-type">TraversalHandler</a><T> | <a href="#-vuedx-template-ast-types--TraversalHandlers-interface">TraversalHandlers</a><T></code> | - | | ||
| | state | <code>T</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
| | handlers | <code><a href="#-vuedx-template-ast-types--TraversalHandler-type">TraversalHandler</a><T> | <a href="#-vuedx-template-ast-types--TraversalHandlers-interface">TraversalHandlers</a><T></code> | - | | ||
| | state | <code>T</code> | - | | ||
@@ -536,12 +591,18 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function traverseEvery<T>(node: Node, enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean, state?: any, ancestors?: TraversalAncestors): void; | ||
| declare function traverseEvery<T>( | ||
| node: Node, | ||
| enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean, | ||
| state?: any, | ||
| ancestors?: TraversalAncestors, | ||
| ): void | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
| | enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, ancestors: <a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a>, state: T) => boolean</code> | - | | ||
| | state | <code>any</code> | - | | ||
| | ancestors | <code><a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a></code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - | | ||
| | enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, ancestors: <a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a>, state: T) => boolean</code> | - | | ||
| | state | <code>any</code> | - | | ||
| | ancestors | <code><a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a></code> | - | | ||
@@ -561,11 +622,16 @@ </details> | ||
| **Signature:** | ||
| ```ts | ||
| declare function traverseFast<T = any>(node: object, enter: (node: Node, state: T, stop: () => void) => void, state?: T): void; | ||
| declare function traverseFast<T = any>( | ||
| node: object, | ||
| enter: (node: Node, state: T, stop: () => void) => void, | ||
| state?: T, | ||
| ): void | ||
| ``` | ||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | node | <code>object</code> | - | | ||
| | enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, state: T, stop: () => void) => void</code> | - | | ||
| | state | <code>T</code> | - | | ||
| | Parameter | Type | Description | | ||
| | --------- | ----------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | node | <code>object</code> | - | | ||
| | enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, state: T, stop: () => void) => void</code> | - | | ||
| | state | <code>T</code> | - | | ||
@@ -577,3 +643,2 @@ </details> | ||
| <a href="#-vuedx-template-ast-types-SearchResult-interface" id="-vuedx-template-ast-types-SearchResult-interface"></a> | ||
@@ -583,12 +648,9 @@ | ||
| ```ts | ||
| interface SearchResult { | ||
| ancestors: TraversalAncestors; | ||
| node: Node | null; | ||
| ancestors: TraversalAncestors | ||
| node: Node | null | ||
| } | ||
| ``` | ||
| <br> | ||
@@ -600,14 +662,11 @@ | ||
| ```ts | ||
| interface StringifyOptions { | ||
| directive: 'shorthand' | 'longhand'; | ||
| indent: number; | ||
| initialIndent: number; | ||
| replaceNodes: Map<Node, Node | null>; | ||
| directive: 'shorthand' | 'longhand' | ||
| indent: number | ||
| initialIndent: number | ||
| replaceNodes: Map<Node, Node | null> | ||
| } | ||
| ``` | ||
| <br> | ||
@@ -619,13 +678,20 @@ | ||
| ```ts | ||
| interface TraversalHandlers<T> { | ||
| enter?: TraversalHandler<T>; | ||
| exit?: TraversalHandler<T>; | ||
| enter?: TraversalHandler<T> | ||
| exit?: TraversalHandler<T> | ||
| } | ||
| ``` | ||
| <br> | ||
| <!-- #region API-DOCS --> | ||
| ## Support | ||
| This package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools. | ||
| <p align="center"> | ||
| <a href="https://cdn.jsdelivr.net/gh/znck/sponsors@main/sponsors.svg"> | ||
| <img src='https://cdn.jsdelivr.net/gh/znck/sponsors@main/sponsors.png'/> | ||
| </a> | ||
| </p> |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by7.34%
98230
- Number of lines in readme file
- increased by10.98%
667
No dependency changes