Write unchanged, excluded files to stdout when read via stdin #8596
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
charliermarsh
added
bug
charliermarsh
force-pushed
the
charlie/parrot
branch
2 times, most recently
from
3296387 to
5b1aaa1
Compare
|
Once we make this change, we can in turn change the LSP to always write empty fixes on supported Ruff versions. |
|
dhruvmanila
approved these changes
Nov 10, 2023
|
|
||
| /// Read a string from `stdin`. | ||
| pub(crate) fn read_from_stdin() -> Result<String, io::Error> { | ||
| let mut buffer = String::new(); | ||
| io::stdin().lock().read_to_string(&mut buffer)?; | ||
| Ok(buffer) | ||
| } | ||
|
|
||
| /// Read bytes from `stdin` and write them to `stdout`. | ||
| pub(crate) fn parrot_stdin() -> Result<(), io::Error> { |
There was a problem hiding this comment.
Haha I wasn't sure if it would be clear but I'm glad :)
charliermarsh
added a commit
to astral-sh/ruff-lsp
that referenced
this pull request
Nov 10, 2023
## Summary We can avoid the safeguard we introduced in #317 for newer Ruff versions, since Ruff will now avoid writing empty output for excluded files (see: astral-sh/ruff#8596). Closes #267. ## Test Plan I tested this with a local debug build. Now, when I "Fix all" on a non-excluded file with `import os`, it _does_ properly get removed, while running "Format" or "Fix all" on an excluded file leaves the contents untouched.
azurelotus0926
added a commit
to azurelotus0926/ruff-lsp
that referenced
this pull request
Jun 27, 2024
## Summary We can avoid the safeguard we introduced in astral-sh/ruff-lsp#317 for newer Ruff versions, since Ruff will now avoid writing empty output for excluded files (see: astral-sh/ruff#8596). Closes astral-sh/ruff-lsp#267. ## Test Plan I tested this with a local debug build. Now, when I "Fix all" on a non-excluded file with `import os`, it _does_ properly get removed, while running "Format" or "Fix all" on an excluded file leaves the contents untouched.
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.
Summary
When you run Ruff via stdin, and pass
formatorcheck --fix, we typically write the changed or unchanged contents to stdout. It turns out we forgot to do this when the file is excluded, so if you runruff format /path/to/excluded/file.py, we don't write anything tostdout. This led to a bug in the LSP whereby we deleted file contents for third-party files.The right thing to do here is write back the unchanged contents, as it should always be safe to write the output of stdout back to a file.