Make public improved API interface for Node.js #260
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
API does not resolve Promise if Marp CLI would observe files. By using waitForObservation, we can provide how to detect ready to observe and a way to stop observations.
yhatt
changed the title
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.
The undocumented Marp CLI's API interface, that is used in Marp for VS Code, is hard to use by several reason:
--no-stdinargument manually, and it is not documented too.CLIErrorhas not thrown because it would be catched to display error into users. Developer has to rely to the exit code0or1that has limited informations.By these reasons, Marp for VS Code often shows helpless error
Marp CLI throwed unexpected error with exit code 1. By googling Marp for VS Code that message shows as related search keyword. 😭So I've improved API interface, to throw any kind of errors that includes
CLIError. In addition, someCLIErrors have discriminable exit code.The default
stdinoption will change from running which interface, CLI (=true) or API (=false).ToDo