feat: improve CLI conventions #418
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
- only output true output to stdout, output progress / errors to stderr this allows other programs to parse output - exit with 1 if there is an error this allows other programs to detect errors - accept "-" as an input file, meaning stdin this allows other programs to stream output into geostyler more easily
KaiVolland
approved these changes
Jan 2, 2025
|
Thanks for the approval! Note that even with approval, I can't merge this myself since I don't have write access |
|
Thanks for merging! @KaiVolland Can I ask you to release a new version of geostyler-cli when you have time - ideally, including the geostyler-qgis-parser fix too? Again, thanks for all the code reviews! |
|
I messed up the geostyler-qgis-parser history / release automation so this will need some time. |
|
🎉 This PR is included in version 4.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
this allows other programs to parse output
this allows other programs to detect errors
this allows other programs to stream output into geostyler more easily
I can take out some of these changes and leave in others if only some of them seem good to you.
This may count as a breaking change - if someone is relying on both progress and output being at stdout. I can add the breaking change marker if needed.