more elaborate approach on hook order

Author: lorenzwalthert

.pre-commit-config.yaml

@@ -3,16 +3,15 @@
 default_stages: ["commit"]
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.0.0.9046
+    rev: v0.1.0
     hooks: 
-    -   id: parsable-R
-    -   id: no-browser-statement
-    -   id: readme-rmd-rendered
-    -   id: deps-in-desc
     -   id: style-files
         args: [--style_pkg=styler, --style_fun=tidyverse_style]
         exclude: '^tests/testthat/.*/*\.R'
-    -   id: roxygenize # spell-check needs up-to date doc.
+    -   id: roxygenize
+    # codemeta must be above use-tidy-description when both are used
+    # -   id: codemeta-description-updated
+    -   id: use-tidy-description
     -   id: spell-check
         exclude: >
           (?x)^(
@@ -35,7 +34,11 @@ repos:
           .*\.sh|
           .*\.RData
           )$
-    -   id: use-tidy-description
+    -   id: lintr
+    -   id: readme-rmd-rendered
+    -   id: parsable-R
+    -   id: no-browser-statement
+    -   id: deps-in-desc
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks: 

inst/pre-commit-config-pkg.yaml

@@ -4,10 +4,12 @@ repos:
 -   repo: https://github.com/lorenzwalthert/precommit
     rev: v0.0.0.9046
     hooks: 
-    -   id: parsable-R
-    -   id: no-browser-statement
-    -   id: lintr
-    -   id: readme-rmd-rendered
+    -   id: style-files
+        args: [--style_pkg=styler, --style_fun=tidyverse_style]    
+    -   id: roxygenize
+    # codemeta must be above use-tidy-description when both are used
+    # -   id: codemeta-description-updated
+    -   id: use-tidy-description
     -   id: spell-check
         exclude: >
           (?x)^(
@@ -30,13 +32,11 @@ repos:
           .*\.sh|
           .*\.RData
           )$
+    -   id: lintr
+    -   id: readme-rmd-rendered
+    -   id: parsable-R
+    -   id: no-browser-statement
     -   id: deps-in-desc
-    -   id: style-files
-        args: [--style_pkg=styler, --style_fun=tidyverse_style]    
-    -   id: roxygenize
-    # codemeta must be above use-tidy-description when both are used
-    # -   id: codemeta-description-updated
-    -   id: use-tidy-description
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.2.3
     hooks: 

inst/pre-commit-config-proj.yaml

@@ -4,10 +4,8 @@ repos:
 -   repo: https://github.com/lorenzwalthert/precommit
     rev: v0.0.0.9046
     hooks: 
-    -   id: parsable-R
-    -   id: no-browser-statement
-    -   id: lintr
-    -   id: readme-rmd-rendered
+    -   id: style-files
+        args: [--style_pkg=styler, --style_fun=tidyverse_style]    
     -   id: spell-check
         exclude: >
           (?x)^(
@@ -30,8 +28,10 @@ repos:
           .*\.sh|
           .*\.RData
           )$
-    -   id: style-files
-        args: [--style_pkg=styler, --style_fun=tidyverse_style]    
+    -   id: lintr
+    -   id: readme-rmd-rendered
+    -   id: parsable-R
+    -   id: no-browser-statement
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.2.3
     hooks: 

vignettes/hook-order.Rmd

@@ -0,0 +1,39 @@
+---
+title: "hook-order"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{hook-order}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(edison.infra)
+```
+
+Hooks with dependencies:
+
+Read and write: 
+
+- styler: should run before roxygen because of caching. Caches.
+- roxygen. Caches.
+- codemeta: must be before tidy description.
+- use-tidy-description.
+
+Just read:
+
+- spell check; run after roxygen
+- lintr: should run after styler.
+- readme-rmd-rendered: Must run after styler.
+- parsable-R
+- no-browser-statement
+- deps in desc.
+
+Read only hooks should generally run only after write hooks.