Any pipe (|> or %>%) on the end of a line leads to a false negative for commented_code_linter

[jcken95]

##  no pipe

lintr::lint(
  text = "# mean()"
)
#> <text>:1:3: style: [commented_code_linter] Remove commented code.
#> # mean()
#>   ^~~~~~

## base pipes

lintr::lint(
  text = "# mean() |>"
)
#> ℹ No lints found.

lintr::lint(
  text = "# 1:5 |> mean()"
)
#> <text>:1:3: style: [commented_code_linter] Remove commented code.
#> # 1:5 |> mean()
#>   ^~~~~~~~~~~~~

## magrittr pipes

lintr::lint(
  text = "# mean() %>%"
)
#> ℹ No lints found.

lintr::lint(
  text = "# 1:5 %>% mean()"
)
#> <text>:1:3: style: [commented_code_linter] Remove commented code.
#> # 1:5 %>% mean()
#>   ^~~~~~~~~~~~~~

^{Created on 2024-10-18 with reprex v2.1.1}

---

# .lintr

linters: linters_with_defaults(
           line_length_linter(120L),
           object_length_linter(40L),
           pipe_consistency_linter("|>"),
           object_usage_linter = NULL,
           indentation_linter = NULL,
           unreachable_code_linter()
         )
encoding: "UTF-8"

[MichaelChirico]

Sorry, what's the expected behavior here?

In order for code to be detected, it has to parse. Your examples with no lints don't parse.

[jcken95]

The expected behaviour would be for lintr::lint(text = " # mean() |>" to return a commented code linter.

Appreciate this code is not parsable in isolation, however, code of this form is a common occurrence in data wrangling. For example:

# no lint detected (expected, desirable behaviour)
lintr::lint(
  text = "mtcars |>
            dplyr::filter(cyl > 4) |>
            dplyr::summarise(m = mean(wt))",
  linters = lintr:::commented_code_linter()
)

# would like/expect the commented out `dplyr::filter(cyl > 4) |>` to picked up by the lintr
# but commented_code_linter() is not flagged in this example, because the single line
# is not parsable
lintr::lint(
  text = "mtcars |>
           #dplyr::filter(cyl > 4) |>
            dplyr::summarise(m = mean(wt))",
  linters = lintr:::commented_code_linter()
)

^{Created on 2024-10-19 by the reprex package (v2.0.1)}