Add a Stdin Specification #586
Open
Conversation
This file contains hidden or 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
This completes step 1 of numtide#573 (comment).
jfly
commented
May 13, 2025
|
|
||
| When in stdin mode, the formatter: | ||
|
|
||
| 1. **MUST** print the formatted file to stdout. |
There was a problem hiding this comment.
This is a lie: it's OK for the formatter to fail to format, but it probably should (must?):
- Print an explanation why to stderr
- Exit non-zero
This made me realize the current formatter specification doesn't have anything to say about subprocess exit codes, but treefmt does check the exit code of the formatter it invokes. We should probably mention this in the spec?
jfly
commented
May 13, 2025
| @@ -60,3 +60,54 @@ outputs. | |||
| ### 4. Reliable | |||
|
|
|||
| We expect the formatter to be reliable and not break the semantics of the formatted files. | |||
|
|
|||
| ## Stdin Specification | |||
There was a problem hiding this comment.
Should I actually promote this to a top level file? That is, docs/site/reference/stdin-spec.md?
jfly
commented
May 13, 2025
| Example: | ||
|
|
||
| ``` | ||
| $ echo "{}" | nixfmt --stdin path/to/file.nix |
There was a problem hiding this comment.
This is a bad example, as nixfmt doesn't actually behave this way yet.
Do folks know if there's an existing formatter (besides treefmt itself) that implements this spec?
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 completes step 1 of
#573 (comment).