@swagger-api/apidom-ast 1.0.0-rc.3 → 1.0.0-rc.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/README.md +6 -6
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [1.0.0-rc.4](https://github.com/swagger-api/apidom/compare/v1.0.0-rc.3...v1.0.0-rc.4) (2025-11-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @swagger-api/apidom-ast
|
|
9
|
+
|
|
6
10
|
# [1.0.0-rc.3](https://github.com/swagger-api/apidom/compare/v1.0.0-rc.2...v1.0.0-rc.3) (2025-11-07)
|
|
7
11
|
|
|
8
12
|
**Note:** Version bump only for package @swagger-api/apidom-ast
|
package/README.md
CHANGED
|
@@ -38,18 +38,18 @@ along with [formatters for canonical block scalars](https://github.com/swagger-a
|
|
|
38
38
|
|
|
39
39
|
## Traversal
|
|
40
40
|
|
|
41
|
-
`@swagger-api/apidom-ast` comes with its own traversal algorithm convenient for traversing [CST](https://en.wikipedia.org/wiki/Parse_tree) or [AST](https://en.wikipedia.org/wiki/
|
|
41
|
+
`@swagger-api/apidom-ast` comes with its own traversal algorithm convenient for traversing [CST](https://en.wikipedia.org/wiki/Parse_tree) or [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree).
|
|
42
42
|
|
|
43
43
|
### visit
|
|
44
44
|
|
|
45
|
-
[visit](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts#
|
|
45
|
+
[visit](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/traversal/visitor.ts#L442) will walk through an CST/AST using a depth first traversal, calling
|
|
46
46
|
the visitor's enter function at each node in the traversal, and calling the
|
|
47
47
|
leave function after visiting that node and all of its child nodes.
|
|
48
48
|
|
|
49
49
|
By returning different values from the enter and leave functions, the
|
|
50
50
|
behavior of the visitor can be altered, including skipping over a sub-tree of
|
|
51
51
|
the Node (by returning false), editing the Node Tree by returning a value or null
|
|
52
|
-
to remove the value, or to stop the whole traversal by returning [BREAK](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts#
|
|
52
|
+
to remove the value, or to stop the whole traversal by returning [BREAK](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/traversal/visitor.ts#L52).
|
|
53
53
|
|
|
54
54
|
When using `visit` to edit an Node Tree, the original Node Tree will not be modified, and
|
|
55
55
|
a new version of the Node Tree with the changes applied will be returned from the
|
|
@@ -90,9 +90,9 @@ Configuration option | Type | Default | Description
|
|
|
90
90
|
<a name="keyMap"></a>`keyMap` | `Object` | `null` | Defines how nodes map to it's children.
|
|
91
91
|
<a name="state"></a>`state` | `Object` | `{}` | Additional state that is provided to the visitor. State is merged inti visitor object in following manner: `Object.assign(visitor, state)`
|
|
92
92
|
<a name="breakSymbol"></a>`breakSymbol` | `Object` | `{}` | Defines a symbol that can break the traversal. Symbol is compared by strict equality (`===`).
|
|
93
|
-
<a name="visitFnGetter"></a>`visitFnGetter` | `Function` | [getVisitFn](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts#
|
|
94
|
-
<a name="nodeTypeGetter"></a>`nodeTypeGetter` | `Function` | [getNodeType](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts#
|
|
95
|
-
<a name="nodePredicate"><a/>`nodePredicate` | `Function` | [isNode](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts#
|
|
93
|
+
<a name="visitFnGetter"></a>`visitFnGetter` | `Function` | [getVisitFn](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/traversal/visitor.ts#L12) | Function that extract appropriate method from the visitor given specific Node type.
|
|
94
|
+
<a name="nodeTypeGetter"></a>`nodeTypeGetter` | `Function` | [getNodeType](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/traversal/visitor.ts#L57) | Node type extractor function.
|
|
95
|
+
<a name="nodePredicate"><a/>`nodePredicate` | `Function` | [isNode](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/traversal/visitor.ts#L62) | Predicate that checks if particular Node can be really considered a Node.
|
|
96
96
|
<a name="detectCycles"><a/>`detectCycles` | `Boolean` | `true` | If the structure that needs to be traversed is represented as directed cyclic graph, `visit` will skip Nodes that have already been traversed to avoid infinite recursion.
|
|
97
97
|
|
|
98
98
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@swagger-api/apidom-ast",
|
|
3
|
-
"version": "1.0.0-rc.
|
|
3
|
+
"version": "1.0.0-rc.4",
|
|
4
4
|
"description": "Tools necessary for parsing stage of ApiDOM, specifically for syntactic analysis.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"homepage": "https://github.com/swagger-api/apidom#readme",
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"@babel/runtime-corejs3": "^7.26.10",
|
|
45
|
-
"@swagger-api/apidom-error": "^1.0.0-rc.
|
|
45
|
+
"@swagger-api/apidom-error": "^1.0.0-rc.4",
|
|
46
46
|
"@types/ramda": "~0.30.0",
|
|
47
47
|
"ramda": "~0.30.0",
|
|
48
48
|
"ramda-adjunct": "^5.0.0",
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"README.md",
|
|
59
59
|
"CHANGELOG.md"
|
|
60
60
|
],
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "ee774281a884eedf1445699d8f2b0092e50db432"
|
|
62
62
|
}
|