Merge pull request #317 from bart1/main

- Common config files that should not be spell checked (#317).

Author: lorenzwalthert

.pre-commit-config.yaml

@@ -134,7 +134,7 @@ repos:
         -    fs
     -   id: spell-check-exclude-to-config
         name: spell-check-exclude-to-config
-        entry: Rscript inst/hooks/local/spell-check-exclude-to-config.R
+        entry: Rscript inst/hooks/local/spell-check-exclude-identical.R
         language: r
         stages: [commit, push]
         additional_dependencies:

inst/hooks/local/spell-check-exclude-identical.R

@@ -0,0 +1,17 @@
+#!/usr/bin/env Rscript
+library(magrittr)
+read_config <- function(path) {
+  yaml::read_yaml(path) %>%
+    purrr::pluck("repos") %>%
+    purrr::keep(~ .x$repo == "https://github.com/lorenzwalthert/precommit") %>%
+    purrr::pluck(1, "hooks") %>%
+    purrr::keep(~ .x$id == "spell-check") %>%
+    purrr::pluck(1, "exclude")
+}
+hooks_pkg <- read_config(here::here("inst/pre-commit-config-pkg.yaml"))
+hooks_proj <- read_config(here::here("inst/pre-commit-config-proj.yaml"))
+if (!identical(hooks_proj, hooks_pkg)) {
+  rlang::abort(paste0(
+    "The `exclude` key from the spell-check hook should be the same for all templates in `inst/`."
+  ))
+}

inst/hooks/local/spell-check-exclude-to-config.R

@@ -25,6 +25,8 @@ repos:
           .*\.Rproj|
           .*\.sh|
           (.*/|)\.gitignore|
+          (.*/|)\.gitlab-ci\.yml|
+          (.*/|)\.lintr|
           (.*/|)\.pre-commit-.*|
           (.*/|)\.Rbuildignore|
           (.*/|)\.Renviron|
@@ -57,4 +59,4 @@ repos:
         entry: Cannot commit .Rhistory, .RData, .Rds or .rds.
         language: fail
         files: '\.Rhistory|\.RData|\.Rds|\.rds$'
-        # `exclude: <regex>` to allow committing specific files.
+        # `exclude: <regex>` to allow committing specific files

inst/pre-commit-config-pkg.yaml

@@ -21,6 +21,8 @@ repos:
           .*\.Rproj|
           .*\.sh|
           (.*/|)\.gitignore|
+          (.*/|)\.gitlab-ci\.yml|
+          (.*/|)\.lintr|
           (.*/|)\.pre-commit-.*|
           (.*/|)\.Rbuildignore|
           (.*/|)\.Renviron|
@@ -52,4 +54,4 @@ repos:
         entry: Cannot commit .Rhistory, .RData, .Rds or .rds.
         language: fail
         files: '\.Rhistory|\.RData|\.Rds|\.rds$'
-        # `exclude: <regex>` to allow committing specific files.
+        # `exclude: <regex>` to allow committing specific files