Avoid writing empty source on excluded files #317
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
charliermarsh
force-pushed
the
charlie/empty
branch
from
94ae4a4 to
fdb332c
Compare
charliermarsh
added a commit
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.
Right now, if the user tries to fix or format an excluded file, we don't write anything to
stdout. As a result, the LSP then overwrites the file with the empty string.This is a compromise fix whereby we avoid writing empty fixes in the LSP. It's a "compromise" in that it'll do the wrong thing in some cases, e.g., if the file is just
import os, we won't remove that when the user runs "Fix all". However, I think we already had this behavior in the LSP in the past, and we can fix it for newer versions by changing Ruff to output the unchanged file.Test Plan
Ran the debug extension.
Opened a first-party file, and ensured that formatting and linting work as before (with the exception of the
import oscase).Opened a third-party file, and ensured that formatting and linting had no effect (and didn't delete the file).