mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-22 11:24:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

The linter and code actions can now be disabled in client settings for ruff server (#10800)

Browse source 
## Summary

This is a follow-up to https://github.com/astral-sh/ruff/pull/10764.
Support for diagnostics, quick fixes, and source actions can now be
disabled via client settings.

## Test Plan

### Manual Testing

Set up your workspace as described in the test plan in
https://github.com/astral-sh/ruff/pull/10764, up to step 2. You don't
need to add a debug statement.
The configuration for `folder_a` and `folder_b` should be as follows:
`folder_a`:
```json
{
    "ruff.codeAction.fixViolation": {
        "enable": true
    }
}
```

`folder_b`
```json
{
    "ruff.codeAction.fixViolation": {
        "enable": false
    }
}
```
Finally, open up your VS Code User Settings and un-check the `Ruff > Fix
All` setting.

1. Open a Python file in `folder_a` that has existing problems. The
problems should be highlighted, and quick fix should be available.
`source.fixAll` should not be available as a source action.
2. Open a Python file in `folder_b` that has existing problems. The
problems should be highlighted, but quick fixes should not be available
for any of them. `source.fixAll` should not be available as a source
action.
3. Open up your VS Code Workspace Settings (second tab under the search
bar) and un-check `Ruff > Lint: Enable`
4. Both files you tested in steps 1 and 2 should now lack any visible
diagnostics. `source.organizeImports` should still be available as a
source action.
This commit is contained in:
Jane Lewis 2024-04-08 07:53:28 -07:00 • committed by GitHub
parent a188ba5c26
commit c3e28f9d55
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 43 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

12
crates/ruff_server/src/server/api/requests/code_action.rs
View file

@ -29,18 +29,24 @@ impl super::BackgroundDocumentRequestHandler for CodeActions {
let supported_code_actions = supported_code_actions(params.context.only.clone());
if supported_code_actions.contains(&SupportedCodeAction::QuickFix) {
if snapshot.client_settings().fix_violation()
&& supported_code_actions.contains(&SupportedCodeAction::QuickFix)
{
response.extend(
quick_fix(&snapshot, params.context.diagnostics.clone())
.with_failure_code(ErrorCode::InternalError)?,
);
}
if supported_code_actions.contains(&SupportedCodeAction::SourceFixAll) {
if snapshot.client_settings().fix_all()
&& supported_code_actions.contains(&SupportedCodeAction::SourceFixAll)
{
response.push(fix_all(&snapshot).with_failure_code(ErrorCode::InternalError)?);
}
if supported_code_actions.contains(&SupportedCodeAction::SourceOrganizeImports) {
if snapshot.client_settings().organize_imports()
&& supported_code_actions.contains(&SupportedCodeAction::SourceOrganizeImports)
{
response.push(organize_imports(&snapshot).with_failure_code(ErrorCode::InternalError)?);
}

14
crates/ruff_server/src/server/api/requests/diagnostic.rs
View file

@ -19,11 +19,15 @@ impl super::BackgroundDocumentRequestHandler for DocumentDiagnostic {
_notifier: Notifier,
_params: types::DocumentDiagnosticParams,
) -> Result<DocumentDiagnosticReportResult> {
let diagnostics = crate::lint::check(
snapshot.document(),
&snapshot.configuration().linter,
snapshot.encoding(),
);
let diagnostics = if snapshot.client_settings().lint() {
crate::lint::check(
snapshot.document(),
&snapshot.configuration().linter,
snapshot.encoding(),
)
} else {
vec![]
};
Ok(DocumentDiagnosticReportResult::Report(
types::DocumentDiagnosticReport::Full(RelatedFullDocumentDiagnosticReport {