Drop 'yaml/parse-cst' endpoint #223
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: Users will need to update their code:
-import parseCST from 'yaml/parse-cst'
+import YAML from 'yaml'
+const parseCST = YAML.parseCST
|
@eemeli While I see this as part of v2 release notes, there is nothing named |
|
The new API for that is provided by the Note that the v2 CST is rather different from the v1 CST. |
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.
BREAKING CHANGE
Users will need to update their code:
This simplifies the public API of the library, but should not adversely affect users. Providing a separate endpoint has previously made it simpler for browser bundlers to treeshake the library for users that only use the CST parser, but the updated exports should now allow for that to happen even with a single export. Especially once #208 is resolved, as it should now be possible to provide ES-only exports for browsers.
This is also related to #203, which will change the output & API of
YAML.parseCSTrather thoroughly.