-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Run
ruff format when lsp formatting is invoked (#57)
* Run `ruff format` when lsp formatting is invoked Adds the Subcommand enum to indicate which `ruff` subcommand should be executed by `run_ruff`. At this time, only `check` and `format` are supported. As different subcommands support different parameters, argument generation is delegated based on the specific subcommand value. The `ruff format` subcommand does not currently organize imports and there does not appear to be a way to convince it to do so. Until a unified command exists the approach taken here is to format and then make a second run of `ruff check` that _only_ performs import formatting. * Preserve compatibility with `format` settings Codes listed in this setting should be included in fixes performed as part of a formatting pass. * Make import sorting opt-in
- Loading branch information
Showing
5 changed files
with
209 additions
and
50 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import contextlib | ||
| import tempfile | ||
| import textwrap as tw | ||
| from typing import Any, List, Mapping, Optional | ||
| from unittest.mock import Mock | ||
|
|
||
| import pytest | ||
| from pylsp import uris | ||
| from pylsp.config.config import Config | ||
| from pylsp.workspace import Document, Workspace | ||
|
|
||
| import pylsp_ruff.plugin as plugin | ||
|
|
||
| _UNSORTED_IMPORTS = tw.dedent( | ||
| """ | ||
| from thirdparty import x | ||
| import io | ||
| import asyncio | ||
| """ | ||
| ).strip() | ||
|
|
||
| _SORTED_IMPORTS = tw.dedent( | ||
| """ | ||
| import asyncio | ||
| import io | ||
| from thirdparty import x | ||
| """ | ||
| ).strip() | ||
|
|
||
| _UNFORMATTED_CODE = tw.dedent( | ||
| """ | ||
| def foo(): pass | ||
| def bar(): pass | ||
| """ | ||
| ).strip() | ||
|
|
||
| _FORMATTED_CODE = tw.dedent( | ||
| """ | ||
| def foo(): | ||
| pass | ||
| def bar(): | ||
| pass | ||
| """ | ||
| ).strip() | ||
|
|
||
|
|
||
| @pytest.fixture() | ||
| def workspace(tmp_path): | ||
| """Return a workspace.""" | ||
| ws = Workspace(tmp_path.absolute().as_uri(), Mock()) | ||
| ws._config = Config(ws.root_uri, {}, 0, {}) | ||
| return ws | ||
|
|
||
|
|
||
| def temp_document(doc_text, workspace): | ||
| with tempfile.NamedTemporaryFile( | ||
| mode="w", dir=workspace.root_path, delete=False | ||
| ) as temp_file: | ||
| name = temp_file.name | ||
| temp_file.write(doc_text) | ||
| doc = Document(uris.from_fs_path(name), workspace) | ||
| return name, doc | ||
|
|
||
|
|
||
| def run_plugin_format(workspace: Workspace, doc: Document) -> str: | ||
| class TestResult: | ||
| result: Optional[List[Mapping[str, Any]]] | ||
|
|
||
| def __init__(self): | ||
| self.result = None | ||
|
|
||
| def get_result(self): | ||
| return self.result | ||
|
|
||
| def force_result(self, r): | ||
| self.result = r | ||
|
|
||
| generator = plugin.pylsp_format_document(workspace, doc) | ||
| result = TestResult() | ||
| with contextlib.suppress(StopIteration): | ||
| generator.send(None) | ||
| generator.send(result) | ||
|
|
||
| if result.result: | ||
| return result.result[0]["newText"] | ||
| return pytest.fail() | ||
|
|
||
|
|
||
| def test_ruff_format_only(workspace): | ||
| txt = f"{_UNSORTED_IMPORTS}\n{_UNFORMATTED_CODE}" | ||
| want = f"{_UNSORTED_IMPORTS}\n\n\n{_FORMATTED_CODE}\n" | ||
| _, doc = temp_document(txt, workspace) | ||
| got = run_plugin_format(workspace, doc) | ||
| assert want == got | ||
|
|
||
|
|
||
| def test_ruff_format_and_sort_imports(workspace): | ||
| txt = f"{_UNSORTED_IMPORTS}\n{_UNFORMATTED_CODE}" | ||
| want = f"{_SORTED_IMPORTS}\n\n\n{_FORMATTED_CODE}\n" | ||
| _, doc = temp_document(txt, workspace) | ||
| workspace._config.update( | ||
| { | ||
| "plugins": { | ||
| "ruff": { | ||
| "format": ["I001"], | ||
| } | ||
| } | ||
| } | ||
| ) | ||
| got = run_plugin_format(workspace, doc) | ||
| assert want == got |
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