/
hook-order.Rmd
43 lines (34 loc) · 1.17 KB
/
hook-order.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
---
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 = "#>"
)
```
Read only hooks should generally run only after write hooks.
## Rules for editing this document
- Only add a dependency once, i.e. if styler must run before roxygen, add the requirement to styler or roxygen, not both. This makes keeping track easier.
- The hooks must appear in an order that meets all constraints, not just randomly order constraints.
## Hooks with dependencies
### Read and write
- style-files - caches; should run before roxygenize because of the caching
- roxygenize - caches
- codemeta-description-updated - must be before use-tidy-description
- use-tidy-description
- spell-check - updates `inst/WORDLIST` (unless `--read-only` arg is specified); should run after roxygenize
### Read only
- lintr - should run after styler
- readme-rmd-rendered - must run after styler
- parsable-R
- no-browser-statement
- no-print-statement
- no-debug-statement
- deps-in-desc
- pkgdown