Change hook type of {pkgdown} hook to script

lorenzwalthert · lorenzwalthert · commit 97740f3eeaa8 · 2022-11-14T16:41:25.000+01:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -86,10 +86,7 @@ repos:
           renv/activate.R|
           vignettes/FAQ\.Rmd|
           )$
-    # -   id: pkgdown-check
-    #     additional_dependencies: 
-    #     -    pkgdown
-    #     -    mockery
+#    -   id: pkgdown-check
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
     hooks: 
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -1,21 +1,21 @@
 -   id: roxygenize
     name: roxygenize
-    description: run roxygen2::roxygenize()
+    description: run `roxygen2::roxygenize()`
     entry: Rscript inst/hooks/exported/roxygenize.R
     language: r
     files: '^(R|man)/'
     require_serial: true
     minimum_pre_commit_version: "2.13.0"
 -   id: use-tidy-description
     name: use-tidy-description
-    description: run usethis::use_tidy_description()
+    description: run `usethis::use_tidy_description()`
     entry: Rscript inst/hooks/exported/use-tidy-description.R
     language: r
     files: '^DESCRIPTION$'
     minimum_pre_commit_version: "2.13.0"
 -   id: style-files
     name: style-files
-    description: style files with styler
+    description: style files with {styler}
     entry: Rscript inst/hooks/exported/style-files.R
     language: r
     files: '(\.[rR]profile|\.[rR]|\.[rR]md|\.[rR]nw|\.[qQ]md)$'
@@ -44,21 +44,21 @@
     minimum_pre_commit_version: "2.13.0"
 -   id: readme-rmd-rendered
     name: readme-rmd-rendered
-    description: make sure README.Rmd hasn't been edited more recently than README.md
+    description: make sure README.Rmd hasn't been edited more recently than `README.md`
     entry: Rscript inst/hooks/exported/readme-rmd-rendered.R
     language: r
     files: 'README\.[Rr]?md$'
     minimum_pre_commit_version: "2.13.0"
 -   id: codemeta-description-updated
     name: codemeta-description-updated
-    description: make sure codemeta.json is in sync with DESCRIPTION. It should be run after use-tidy-description.
+    description: make sure `codemeta.json` is in sync with `DESCRIPTION`. It should be run after use-tidy-description
     entry: Rscript inst/hooks/exported/codemeta-description-updated.R
     language: r
     files: '^DESCRIPTION$'
     minimum_pre_commit_version: "2.13.0"
 -   id: spell-check 
     name: spell-check
-    description: perform a spell check with spelling::spell_check_files()
+    description: perform a spell check with `spelling::spell_check_files()`
     entry: Rscript inst/hooks/exported/spell-check.R
     language: r
     exclude: >
@@ -92,24 +92,24 @@
     minimum_pre_commit_version: "2.13.0"
 -   id: deps-in-desc
     name: deps-in-desc
-    description: Check if dependencies that can be parsed from code are in DESCRIPTION.
+    description: Check if dependencies that can be parsed from code are in `DESCRIPTION`
     entry: Rscript inst/hooks/exported/deps-in-desc.R
     language: r
     files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: lintr
     name: lintr
-    description: check if a .R file is lint free (using lintr)
+    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)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: pkgdown-check
     name: pkgdown-check
-    description: check if _pkgdown.yml has the correct entries for references and articles.
-    entry: Rscript inst/hooks/exported/pkgdown-check.R
-    language: r
+    description: check if your {pkgdown} config file has the correct entries for references and articles
+    entry: inst/hooks/exported/pkgdown-check.R
+    language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'
diff --git a/NEWS.md b/NEWS.md
@@ -4,8 +4,10 @@ editor_options:
     wrap: 72
 ---
 
-# precommit v0.3.2.9001 (Development version)
+# precommit v0.3.2.9003 (Development version)
 
+-   new hook `pkgdown-check` 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 
     specifies the directory in the git repo that contains the R package. 
diff --git a/inst/hooks/exported/pkgdown-check.R b/inst/hooks/exported/pkgdown-check.R
@@ -1,10 +1,10 @@
 #!/usr/bin/env Rscript
 
 if (!require(pkgdown, quietly = TRUE)) {
-  stop("{pkgdown} could not be loaded.")
+  stop("{pkgdown} could not be loaded, please install it.")
 }
 if (!require(mockery, quietly = TRUE)) {
-  stop("{mockery} could not be loaded.")
+  stop("{mockery} could not be loaded, please install it.")
 }
 
 stub_render_page <- function(pkg, name, data, ...) {
@@ -13,6 +13,7 @@ stub_render_page <- function(pkg, name, data, ...) {
 stub(build_reference_index, "render_page", stub_render_page)
 stub(build_articles_index, "render_page", stub_render_page)
 config <- yaml::read_yaml(pkgdown:::pkgdown_config_path("."))
+
 tryCatch(
   {
     if ("reference" %in% names(config)) {
diff --git a/inst/pre-commit-config-pkg.yaml b/inst/pre-commit-config-pkg.yaml
@@ -46,10 +46,6 @@ repos:
     -   id: no-browser-statement
     -   id: no-debug-statement
     -   id: deps-in-desc
-    -   id: pkgdown-check
-        additional_dependencies: 
-        -    pkgdown
-        -    mockery
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.2.3
     hooks: 
diff --git a/inst/pre-commit-hooks.yaml b/inst/pre-commit-hooks.yaml
@@ -1,21 +1,21 @@
 -   id: roxygenize
     name: roxygenize
-    description: run roxygen2::roxygenize()
+    description: run `roxygen2::roxygenize()`
     entry: Rscript inst/hooks/exported/roxygenize.R
     language: r
     files: '^(R|man)/'
     require_serial: true
     minimum_pre_commit_version: "2.13.0"
 -   id: use-tidy-description
     name: use-tidy-description
-    description: run usethis::use_tidy_description()
+    description: run `usethis::use_tidy_description()`
     entry: Rscript inst/hooks/exported/use-tidy-description.R
     language: r
     files: '^DESCRIPTION$'
     minimum_pre_commit_version: "2.13.0"
 -   id: style-files
     name: style-files
-    description: style files with styler
+    description: style files with {styler}
     entry: Rscript inst/hooks/exported/style-files.R
     language: r
     files: '(\.[rR]profile|\.[rR]|\.[rR]md|\.[rR]nw|\.[qQ]md)$'
@@ -44,21 +44,21 @@
     minimum_pre_commit_version: "2.13.0"
 -   id: readme-rmd-rendered
     name: readme-rmd-rendered
-    description: make sure README.Rmd hasn't been edited more recently than README.md
+    description: make sure README.Rmd hasn't been edited more recently than `README.md`
     entry: Rscript inst/hooks/exported/readme-rmd-rendered.R
     language: r
     files: 'README\.[Rr]?md$'
     minimum_pre_commit_version: "2.13.0"
 -   id: codemeta-description-updated
     name: codemeta-description-updated
-    description: make sure codemeta.json is in sync with DESCRIPTION. It should be run after use-tidy-description.
+    description: make sure `codemeta.json` is in sync with `DESCRIPTION`. It should be run after use-tidy-description
     entry: Rscript inst/hooks/exported/codemeta-description-updated.R
     language: r
     files: '^DESCRIPTION$'
     minimum_pre_commit_version: "2.13.0"
 -   id: spell-check 
     name: spell-check
-    description: perform a spell check with spelling::spell_check_files()
+    description: perform a spell check with `spelling::spell_check_files()`
     entry: Rscript inst/hooks/exported/spell-check.R
     language: r
     exclude: >
@@ -92,24 +92,24 @@
     minimum_pre_commit_version: "2.13.0"
 -   id: deps-in-desc
     name: deps-in-desc
-    description: Check if dependencies that can be parsed from code are in DESCRIPTION.
+    description: Check if dependencies that can be parsed from code are in `DESCRIPTION`
     entry: Rscript inst/hooks/exported/deps-in-desc.R
     language: r
     files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: lintr
     name: lintr
-    description: check if a .R file is lint free (using lintr)
+    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)$'
     exclude: 'renv/activate\.R'
     minimum_pre_commit_version: "2.13.0"
 -   id: pkgdown-check
     name: pkgdown-check
-    description: check if _pkgdown.yml has the correct entries for references and articles.
-    entry: Rscript inst/hooks/exported/pkgdown-check.R
-    language: r
+    description: check if your {pkgdown} config file has the correct entries for references and articles
+    entry: inst/hooks/exported/pkgdown-check.R
+    language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'
diff --git a/tests/testthat/reference-objects/pre-commit-config.yaml b/tests/testthat/reference-objects/pre-commit-config.yaml
@@ -49,10 +49,6 @@ repos:
     -   id: no-browser-statement
     -   id: no-debug-statement
     -   id: deps-in-desc
-    -   id: pkgdown-check
-        additional_dependencies: 
-        -    pkgdown
-        -    mockery
 -   repo: local
     hooks:
     -   id: consistent-release-tag
diff --git a/vignettes/available-hooks.Rmd b/vignettes/available-hooks.Rmd
@@ -223,22 +223,18 @@ This hook does not modify input files, but writes to `.Rd` files in
 `man/`, `NAMESPACE` and potentially others depending on which roxygen
 roclets you specified in `DESCRIPTION`.
 
-
 **Arguments**
 
 <!-- -->
 
     id: roxygenize
     args: [--root=<R package root>] 
 
-
 -   Argument `root` specifies the directory in the git repo that
     contains the R package. Defaults to `.` since for most R package git
     repos, the git and R package root coincide. Added in version
     0.3.3.00000.
 
-
-
 ## `deps-in-desc`
 
 Checks if packages used with the `pkgname::fun()` syntax are listed in
@@ -284,12 +280,11 @@ This hook does modify the file `DESCRIPTION`.
     id: use-tidy-description
     args: [--root=<R package root>] 
 
-
 -   Argument `root` specifies the directory in the git repo that
     contains the R package. Defaults to `.` since for most R package git
     repos, the git and R package root coincide. Added in version
     0.3.3.00000.
-    
+
 ## `lintr`
 
 A hook to run `lintr::lint()` to check that R files are lint free.
@@ -325,8 +320,21 @@ This hook does not modify any file.
     id: codemeta-description-updated
     args: [--root=<R package root>] 
 
-
 -   Argument `root` specifies the directory in the git repo that
     contains the R package. Defaults to `.` since for most R package git
     repos, the git and R package root coincide. Added in version
     0.3.3.00000.
+
+
+## `pkgdown-check`
+
+Check if your {pkgdown} config file (e.g. `_pkgdown.yml` in your root) has the 
+correct entries for references and articles. 
+This hook skips the time-consuming parts of building the index and reference and
+only performs the validation.
+
+For this check, we rely on the the global R package library and require all 
+development dependencies of the package to be installed, as well as {pkgdown} 
+and {mockery}. 
+
+This hook does not modify files. Added in version 0.3.2.9003.

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`#!/usr/bin/env Rscript`
`2`	`2`
`3`	`3`	`if (!require(pkgdown, quietly = TRUE)) {`
`4`		`- stop("{pkgdown} could not be loaded.")`
	`4`	`+ stop("{pkgdown} could not be loaded, please install it.")`
`5`	`5`	`}`
`6`	`6`	`if (!require(mockery, quietly = TRUE)) {`
`7`		`- stop("{mockery} could not be loaded.")`
	`7`	`+ stop("{mockery} could not be loaded, please install it.")`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`stub_render_page <- function(pkg, name, data, ...) {`
`@@ -13,6 +13,7 @@ stub_render_page <- function(pkg, name, data, ...) {`
`13`	`13`	`stub(build_reference_index, "render_page", stub_render_page)`
`14`	`14`	`stub(build_articles_index, "render_page", stub_render_page)`
`15`	`15`	`config <- yaml::read_yaml(pkgdown:::pkgdown_config_path("."))`
	`16`	`+`
`16`	`17`	`tryCatch(`
`17`	`18`	`{`
`18`	`19`	`if ("reference" %in% names(config)) {`