stderr.write(): add newline suffix consistently #1414
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
Noted while investigating getodk#1403 Some logging is not followed by a newline character, so it is concatenated with the next output to stderrr. This commit adds newline characters to calls to process.stderr.write() where missing, and standardises their inclusion. It's unclear why `process.stderr.write()` is used in preference to `console.error()`
Yes, I think that's right. 👍 |
matthew-white
approved these changes
Feb 19, 2025
I remember asking about this during code review several years ago. issa thought that the two did different things. Sorry, I don't remember anything more specific. 😅 Maybe the two aren't different anymore? |
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.
Noted while investigating #1403.
Some logging is not followed by a newline character, so it is concatenated with the next output to
stderr.This commit adds newline characters to calls to
process.stderr.write()where missing, and standardises their inclusion.What has been done to verify that this works as intended?
Run locally; tests in CI.
Why is this the best possible solution? Were any other approaches considered?
Introduced in f3e8563, it's unclear why
process.stderr.write()is used in preference toconsole.error().How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
No change for users, unless they're parsing stderr for e.g. monitoring. This change would probably make parsing more reliable.
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
I don't think stderr output is currently documented.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes