Skip to content

Use code and codeDescription in diagnostic #611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renkun-ken merged 4 commits into from
Apr 20, 2023
Merged

Use code and codeDescription in diagnostic #611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1165364
Use code and codeDescription in diagnostic
renkun-ken Apr 20, 2023
eaa0b6c
Update test
renkun-ken Apr 20, 2023
e4d0ba8
Fix tests
renkun-ken Apr 20, 2023
aa5fde8
Update code action
renkun-ken Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions R/code_action.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ document_code_action_reply <- function(id, uri, workspace, document, range, cont
listed_linters <- c(listed_linters, "*")
}

if (!(item$source %in% listed_linters)) {
if (!(item$code %in% listed_linters)) {
if (grepl("#\\s*nolint\\s*:.+\\.", line)) {
# modify existing nolint directives
nolint_start <- regexec("#\\s*nolint\\s*:.+\\.", line)[[1]] - 1
Expand All @@ -90,7 +90,7 @@ document_code_action_reply <- function(id, uri, workspace, document, range, cont
item_range$end$row,
nolint_end
)
), sprintf(", %s", item$source))
), sprintf(", %s", item$code))
} else {
position <- document$to_lsp_position(
item_range$end$row,
Expand All @@ -99,22 +99,22 @@ document_code_action_reply <- function(id, uri, workspace, document, range, cont
edit <- text_edit(range = range(
start = position,
end = position
), sprintf(" # nolint: %s.", item$source))
), sprintf(" # nolint: %s.", item$code))
}
changes <- list(
list(edit)
)
names(changes) <- uri
action <- list(
title = sprintf("Disable %s for this line", item$source),
title = sprintf("Disable %s for this line", item$code),
kind = CodeActionKind$QuickFix,
edit = list(
changes = changes
)
)

result <- c(result, list(action))
listed_linters <- c(listed_linters, item$source)
listed_linters <- c(listed_linters, item$code)
}
}
}
Expand Down
8 changes: 6 additions & 2 deletions R/diagnostics.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,12 @@ diagnostic_from_lint <- function(result, content) {
list(
range = diagnostic_range(result, content),
severity = diagnostic_severity(result),
source = result$linter,
message = result$message
source = "lintr",
message = result$message,
code = result$linter,
codeDescription = list(
href = sprintf("https://lintr.r-lib.org/reference/%s.html", result$linter)
)
)
}

Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/test-code-action.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ test_that("Code action works", {

expect_equal(client$diagnostics$size(), 1)
expect_equal(client$diagnostics$get(data$uri), data$diagnostics)
expect_equal(data$diagnostics[[1]]$source, "infix_spaces_linter")
expect_equal(data$diagnostics[[1]]$code, "infix_spaces_linter")
expect_equal(data$diagnostics[[1]]$message, "Put spaces around all infix operators.")
expect_equal(data$diagnostics[[2]]$source, "infix_spaces_linter")
expect_equal(data$diagnostics[[2]]$code, "infix_spaces_linter")
expect_equal(data$diagnostics[[2]]$message, "Put spaces around all infix operators.")

result <- client %>% respond_code_action(temp_file, c(0, 0), c(0, 1))
Expand Down
6 changes: 3 additions & 3 deletions tests/testthat/test-lintr.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ test_that("lintr works", {

expect_equal(client$diagnostics$size(), 1)
expect_equal(client$diagnostics$get(data$uri), data$diagnostics)
expect_equal(data$diagnostics[[1]]$source, "assignment_linter")
expect_equal(data$diagnostics[[1]]$code, "assignment_linter")
expect_equal(data$diagnostics[[1]]$message, "Use <-, not =, for assignment.")
})

Expand All @@ -36,7 +36,7 @@ test_that("lintr config file works", {
expect_equal(client$diagnostics$size(), 1)
expect_equal(client$diagnostics$get(data$uri), data$diagnostics)
expect_length(data$diagnostics, 2)
expect_setequal(vapply(data$diagnostics, "[[", character(1), "source"),
expect_setequal(vapply(data$diagnostics, "[[", character(1), "code"),
c("assignment_linter", "infix_spaces_linter"))


Expand All @@ -53,7 +53,7 @@ test_that("lintr config file works", {
expect_equal(client$diagnostics$size(), 1)
expect_equal(client$diagnostics$get(data$uri), data$diagnostics)
expect_length(data$diagnostics, 1)
expect_setequal(vapply(data$diagnostics, "[[", character(1), "source"),
expect_setequal(vapply(data$diagnostics, "[[", character(1), "code"),
c("infix_spaces_linter"))

writeLines("linters: list()", lintr_file)
Expand Down