code-quality: switch lint-md to .ci/lint.R

Author: aitap

.ci/linters/md/heading_id_linter.R

@@ -1,8 +1,8 @@
-any_mismatch = FALSE
-
 # ensure that ids are limited to alphanumerics and dashes
 # (in particular, dots and underscores break the links)
 check_header_ids = function(md) {
+  if (!grepl('[.]Rmd$', md)) return()
+  md = readLines(md)
   # A bit surprisingly, some headings don't start with a letter.
   # We're interested in those that set an id to link to, i.e., end with {#id}.
   heading_captures = regmatches(md, regexec("^#+ \\S.*[{]#([^}]*)[}]$", md))
@@ -14,13 +14,5 @@ check_header_ids = function(md) {
     "On line %d, bad heading id '%s':\n%s\n",
     line, heading_captures[[line]][2], heading_captures[[line]][1]
   ))
-  !all(good_ids)
+  stopifnot('Please fix the vignette issues above' = all(good_ids))
 }
-
-any_error = FALSE
-for (vignette in list.files('vignettes', pattern = "[.]Rmd$", recursive = TRUE, full.name = TRUE)) {
-  cat(sprintf("Checking vignette file %s...\n", vignette))
-  rmd_lines = readLines(vignette)
-  any_error = check_header_ids(rmd_lines) || any_error
-}
-if (any_error) stop("Please fix the vignette issues above.")

.ci/linters/md/news_linter.R

@@ -1,13 +1,13 @@
-any_mismatch = FALSE
-
 # ensure that numbered list in each section is in sequence
 check_section_numbering = function(news) {
+  if (!grepl("NEWS", news)) return()
+  news = readLines(news)
   # plain '#' catches some examples; 'd' for 'data.table'
   sections = grep("^#+ [A-Zd]", news)
   entries = grep("^[0-9]+[.]", news)
   entry_value = as.integer(gsub("^([0-9]+)[.].*", "\\1", news[entries]))
   section_id = findInterval(entries, sections)
-  
+
   any_mismatch = FALSE
   for (id in unique(section_id)) {
     section_entries = entry_value[section_id == id]
@@ -22,11 +22,12 @@ check_section_numbering = function(news) {
       paste0("  [", section_entries[!matched], " --> ", intended_value[!matched], "]", collapse="\n")
     ))
   }
-  return(any_mismatch)
+  stopifnot("Please fix the issues above" = !any_mismatch)
 }
 
 # ensure that GitHub link text & URL actually agree
 check_gh_links = function(news) {
+  news = readLines(news)
   gh_links_info = gregexpr(
     "\\[#(?<md_number>[0-9]+)\\]\\(https://github.com/Rdatatable/data.table/(?<link_type>[^/]+)/(?<link_number>[0-9]+)\\)",
     news,
@@ -48,14 +49,5 @@ check_gh_links = function(news) {
     "In line %d, link pointing to %s %s is written #%s\n",
     line_number, link_type, link_number, md_number
   )))
-  return(TRUE)
-}
-
-any_error = FALSE
-for (news in list.files(pattern = "NEWS")) {
-  cat(sprintf("Checking NEWS file %s...\n", news))
-  news_lines = readLines(news)
-  any_error = check_section_numbering(news_lines) || any_error
-  any_error = check_gh_links(news_lines) || any_error
+  stop("Please fix the issues above.")
 }
-if (any_error) stop("Please fix the NEWS issues above.")

.github/workflows/code-quality.yaml

@@ -73,5 +73,4 @@ jobs:
       - uses: actions/checkout@v4
       - uses: r-lib/actions/setup-r@v2
       - name: Lint
-        run: for (f in list.files('.ci/linters/md', full.names=TRUE)) source(f)
-        shell: Rscript {0}
+        run: .ci/lint.R .ci/linters/md . '[.]R?md$'