How to remove # nolint, # styler: off from being rendered out

[pawelru]

Description

Suppose I have the following:

---
title: "Reproducible Quarto Document"
format: html
engine: knitr
---

```{r}
ABC <- 1 # nolint object_name_linter.
print(ABC)
```

How can I exclude # nolint ... from being rendered out?

I have found that knitr supports tidy chunk option of custom function (source) which in my case will look like this: function(code, ...) gsub(pattern = "#\\s?nolint.*|#\\s?styler:.*", replacement = "", code).

This however seems to be not supported (source).

I can of course go ahead and add it in each chunk I have but that's not so DRY and I am interested in a global setting (presumably specified in _quarto.yaml config file).

Initially I wanted to post it as a feature request but before that - do you see any other way (not necessarily via tidy option) to achieve what I want?

Related: #793

[mcanouil]

You can define a Lua filter, see https://quarto.org/docs/extensions/filters.html.

Knitr specific options needs to be passed according to the documentation: https://quarto.org/docs/computations/r.html#knitr-options

For more, please provide a small self-contained "working" (reproducible) example to work with, i.e., a complete Quarto document or a Git repository.

---

You can share a self-contained "working" (reproducible) Quarto document using the following syntax, i.e., using more backticks than you have in your document (usually four ````).
See https://quarto.org/bug-reports.html#small-is-beautiful-aim-for-a-single-document-with-10-lines.

If you have multiple files (and if it is absolutely required to have multiple files), please share as a Git repository.

````qmd
---
title: "Reproducible Quarto Document"
format: html
engine: knitr
---

This is a reproducible Quarto document using `format: html`.
It is written in Markdown and contains embedded R code.
When you run the code, it will produce a plot.

```{r}
plot(cars)
```

![A placeholder image](https://placehold.co/600x400.png)

The end.
````

Additionally and if not already given, please share the output of quarto check within a code blocks (i.e., using three backticks ```txt), see https://quarto.org/bug-reports.html#check.

[mcanouil]

Still, you need to provide a full reproducible example as shown, not simply a snippet and an error message.
echo should be defined under execute key not within knitr.opts_chunk.

Note that you can still use the old way:

---
title: "Reproducible Quarto Document"
format: html
engine: knitr
---

```{r}
#| include: false
knitr::opts_chunk$set(
  tidy = function(code, ...) {
    gsub(pattern = "#\\s?nolint.*|#\\s?styler:.*", replacement = "", code)
  }
)
```

```{r}
ABC <- 1 # nolint object_name_linter.
print(ABC)
```

[pawelru]

Still, you need to provide a full reproducible example as shown, not simply a snippet and an error message.

You mean that variant with tidy in yaml file? This is clearly not supported as per manual and codebase - I guess there is nothing to reproduce :)

echo should be defined under execute key not within knitr.opts_chunk.

Apologies - my mistake. I will fix it separately. I assume this does not impact the main issue there.

Note that you can still use the old way:

True but I'm dealing with ~100 articles and looking for a single, global place to configure it. AFAIK I can define define that single code chunk in one file and use include shortcode in all articles to load it but still there would be ~ 100 include statements. If there is no other way I will probably go with this. The question is if there is a more DRY way.

[mcanouil]

What you showed from the codebase is the code cell option.

Although I don't understand the point to make that many linter exclusion on code cells.

You could simply define .lintr and exclude rules.

Here the issue is that YAML does not take R code.

The best and more general approach remains a LUA filter, especially because contrary to knitr it is not limited to R code cell.

Edit: I believe there is an example of such filter in here. (Cannot search for it now)

[mcanouil]

FYI:

• How can I disable comment printing inside code chunks? #7521

[pawelru]

Thank you for all good hints. I went ahead and created a custom lua filter as you suggested.
For everyone else coming back to this in the future it's available here: https://github.com/insightsengineering/pattern-strip