Add support for spell checking quarto files (#78)

DESCRIPTION

@@ -22,5 +22,5 @@ Imports:
   knitr
 Suggests: pdftools 
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3.9000
+RoxygenNote: 7.3.1
 Language: en-GB

NEWS

@@ -1,3 +1,7 @@
+dev
+
+  - Support for spellchecking on Quarto files (@olivroy, #77)
+
 2.2.1
   - Fix for commonmark 1.7.0 change for auto-linked markdown URLs
 

R/check-files.R

@@ -30,7 +30,7 @@ spell_check_files <- function(path, ignore = character(), lang = "en_US"){
 }
 
 spell_check_file_one <- function(path, dict){
-  if(grepl("\\.r?md$",path, ignore.case = TRUE))
+  if(grepl("\\.r?q?md$",path, ignore.case = TRUE))
     return(spell_check_file_md(path, dict = dict))
   if(grepl("\\.rd$", path, ignore.case = TRUE))
     return(spell_check_file_rd(path, dict = dict))

R/parse-markdown.R

@@ -46,6 +46,10 @@ parse_text_md <- function(path, extensions = TRUE, yaml_fields = c("title" ,"sub
   # Strip bookdown text references, see: https://bookdown.org/yihui/bookdown/markdown-extensions-by-bookdown.html#text-references
   values <- gsub("\\(ref:.*?\\)", "", values)
 
+  # Quarto references start with @, for example @sec-, @fig- @eq- etc. https://quarto.org/docs/authoring/cross-reference-options.html
+  # No special regex is necessary since all words containing @ are removed from
+  # spell check #9
+
   data.frame(
     text = values,
     position = sourcepos,

R/spell-check.R

@@ -72,9 +72,9 @@ spell_check_package <- function(pkg = ".", vignettes = TRUE, use_wordlist = TRUE
 
   if(isTRUE(vignettes)){
     # Where to check for rmd/md files
-    vign_files <- list.files(file.path(pkg$path, "vignettes"), pattern = "\\.r?md$",
+    vign_files <- list.files(file.path(pkg$path, "vignettes"), pattern = "\\.q?r?md$",
                              ignore.case = TRUE, full.names = TRUE, recursive = TRUE)
-    root_files <- list.files(pkg$path, pattern = "(readme|news|changes|index).r?md",
+    root_files <- list.files(pkg$path, pattern = "(readme|news|changes|index).r?q?md",
                              ignore.case = TRUE, full.names = TRUE)
 
     # Markdown vignettes