drop check in name and add to pre-commit

Author: lorenzwalthert

.pre-commit-config.yaml

@@ -82,11 +82,11 @@ repos:
           (?x)^(
           tests/testthat/in/.*|
           inst/renv-update\.R|
-          inst/hooks/exported/pkgdown-check.R|
+          inst/hooks/exported/pkgdown.R|
           renv/activate.R|
           vignettes/FAQ\.Rmd|
           )$
-#    -   id: pkgdown-check
+#    -   id: pkgdown
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
     hooks: 

.pre-commit-hooks.yaml

@@ -106,10 +106,10 @@
     files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
--   id: pkgdown-check
-    name: pkgdown-check
+-   id: pkgdown
+    name: pkgdown
     description: check if your {pkgdown} config file has the correct entries for references and articles
-    entry: inst/hooks/exported/pkgdown-check.R
+    entry: inst/hooks/exported/pkgdown.R
     language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'

NEWS.md

@@ -6,7 +6,7 @@ editor_options:
 
 # precommit v0.3.2.9003
 
--   new hook `pkgdown-check` to emulate a {pkgdown} build for reference and 
+-   new hook `pkgdown` to emulate a {pkgdown} build for reference and 
     articles (#393).
 -   `codemeta-description-updated`, `roxygenize`, and 
     `use-tidy-description` now all support a `root` argument that 

inst/pre-commit-hooks.yaml

@@ -106,10 +106,10 @@
     files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
--   id: pkgdown-check
-    name: pkgdown-check
+-   id: pkgdown
+    name: pkgdown
     description: check if your {pkgdown} config file has the correct entries for references and articles
-    entry: inst/hooks/exported/pkgdown-check.R
+    entry: inst/hooks/exported/pkgdown.R
     language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'

tests/testthat/reference-objects/pre-commit-config.yaml

@@ -49,6 +49,7 @@ repos:
     -   id: no-browser-statement
     -   id: no-debug-statement
     -   id: deps-in-desc
+    -   id: pkgdown
 -   repo: local
     hooks:
     -   id: consistent-release-tag

tests/testthat/test-hooks.R

@@ -561,7 +561,7 @@ run_test("codemeta-description-update",
 ### pgkdown check                                                           ####
 
 # success index
-run_test("pkgdown-check",
+run_test("pkgdown",
   file_name = c(
     "man/autoudpate.Rd" = "autoupdate.Rd",
     "_pkgdown.yml" = "_pkgdown-index.yml",
@@ -571,7 +571,7 @@ run_test("pkgdown-check",
 )
 
 # failed index
-run_test("pkgdown-check",
+run_test("pkgdown",
   file_name = c(
     "man/flie-true.Rd" = "flie-true.Rd",
     "_pkgdown.yml" = "_pkgdown-index.yml",
@@ -582,7 +582,7 @@ run_test("pkgdown-check",
 )
 
 # failed articles
-run_test("pkgdown-check",
+run_test("pkgdown",
   file_name = c(
     "vignettes/pkgdown.Rmd" = "pkgdown.Rmd",
     "_pkgdown.yml" = "_pkgdown-articles.yml",
@@ -593,7 +593,7 @@ run_test("pkgdown-check",
 )
 
 # success index and article
-run_test("pkgdown-check",
+run_test("pkgdown",
   file_name = c(
     "man/autoudpate.Rd" = "autoupdate.Rd",
     "vignettes/pkgdown.Rmd" = "pkgdown.Rmd",

vignettes/available-hooks.Rmd

@@ -326,7 +326,7 @@ This hook does not modify any file.
     0.3.3.00000.
 
 
-## `pkgdown-check`
+## `pkgdown`
 
 Check if your {pkgdown} config file (e.g. `_pkgdown.yml` in your root) has the 
 correct entries for references and articles.