Merge pull request #570 from jcken95/add-qmd

feat: lint .qmd docs
lorenzwalthert · May 22, 2024 · efaa00a · efaa00a
2 parents 21917fb + ea57e1a
commit efaa00a
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 2 deletions.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -110,7 +110,7 @@
     description: check if a `.R` file is lint free (using {lintr})
     entry: Rscript inst/hooks/exported/lintr.R
     language: r
-    files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
+    files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw|\.[qQ]md)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: pkgdown

diff --git a/inst/pre-commit-hooks.yaml b/inst/pre-commit-hooks.yaml
@@ -110,7 +110,7 @@
     description: check if a `.R` file is lint free (using {lintr})
     entry: Rscript inst/hooks/exported/lintr.R
     language: r
-    files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
+    files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw|\.[qQ]md)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: pkgdown

diff --git a/tests/testthat/in/lintr-fail.qmd b/tests/testthat/in/lintr-fail.qmd
@@ -0,0 +1,8 @@
+---
+title: "Test doc: fail lintr"
+format: html
+---
+
+```{r}
+sum(1,2)
+```
diff --git a/tests/testthat/in/lintr-success.qmd b/tests/testthat/in/lintr-success.qmd
@@ -0,0 +1,8 @@
+---
+title: "Test doc: success lintr"
+format: html
+---
+
+```{r}
+sum(1, 2)
+```
diff --git a/tests/testthat/test-hook-lintr.R b/tests/testthat/test-hook-lintr.R
@@ -1,3 +1,5 @@
+# .R ----
+
 # success
 run_test("lintr",
   suffix = "-success.R",
@@ -12,3 +14,11 @@ run_test(
   "lintr",
   suffix = "-fail.R", cmd_args = "--warn_only", std_err = NULL
 )
+
+# .qmd ----
+
+# success
+run_test("lintr", suffix = "-success.qmd", std_err = NULL)
+
+# failure
+run_test("lintr", suffix = "-fail.qmd", std_err = "not lint free")