Make anchor & alias resolution lazier #248
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: With the earlier drop of Merge as a separate class,
createMergePair() became just a convenience wrapper with confusing
behaviour. For the sake of simplicity, it's easier to drop it completely
and replace calling code with:
```diff
-doc.anchors.createMergePair(node)
+doc.createPair('<<', doc.anchors.createAlias(node))
```
BREAKING CHANGE: All of the node-creating methods are now collected on the Document, making the API easier to use and understand. ```diff -doc.anchors.createAlias(node) +doc.createAlias(node) ```
BREAKING CHANGE: - The `source` of an alias is changed from a direct reference to the aliased node to its `anchor` string representation instead. - The `anchors` member of the Document class is dropped. - Anchors are now stored in the `anchor` property of Scalar and Collection nodes. - Assigning the same anchor to multiple nodes will no longer automatically rename an earlier anchor with the same name.
BREAKING CHANGE: Previously, `replacer` was passed as an option to createNode(). Now it's an optional second argument, matching the API used by the Document constructor.
BREAKING CHANGE: The behaviour of doc.createAlias() changes a bit; now it checks that any anchor name that it assigns to the target node is unique in the document.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the
sourceof an alias node was a JS reference to the actual node object that it referred to, anddoc.anchorsprovided separately from that the string identifiers used by YAML anchors.After this change, scalar and collection nodes get a new
anchor?: stringproperty, and thesourceof an alias is a string identifier. Thedoc.anchorsinstance is completely dropped. ThecreateAlias()method is moved to the document instance, and its handling of corner cases is changed a bit.As a consequence of these changes, assigning the same anchor to multiple nodes will no longer automatically rename an earlier anchor with the same name.
Node creation options are somewhat clarified and streamlined, and the
replaceris moved from the options object to be an optional second argument of thecreateNode()method, matching thenew Document()interface.