Skip to content

Commit acdd572

Browse files
committed
Add lockfile_validate docs
1 parent c1a118c commit acdd572

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

DESCRIPTION

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: precommit
22
Title: Pre-Commit Hooks
3-
Version: 0.4.3.9004
3+
Version: 0.4.3.9005
44
Author: Lorenz Walthert
55
Maintainer: Lorenz Walthert <[email protected]>
66
Description: Useful git hooks for R building on top of the multi-language
@@ -22,7 +22,7 @@ Imports:
2222
rprojroot,
2323
withr,
2424
yaml
25-
Suggests:
25+
Suggests:
2626
desc,
2727
docopt (>= 0.7.1),
2828
git2r,
@@ -42,7 +42,7 @@ Suggests:
4242
testthat (>= 2.1.0),
4343
tibble,
4444
usethis (>= 2.0.0)
45-
VignetteBuilder:
45+
VignetteBuilder:
4646
knitr
4747
Encoding: UTF-8
4848
Roxygen: list(markdown = TRUE, roclets = c( "rd", "namespace", "collate",

vignettes/available-hooks.Rmd

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Available Hooks"
3-
description: >
3+
description: >
44
Check out all hooks this repo contains and how they can be customized
55
output: rmarkdown::html_vignette
66
vignette: >
77
%\VignetteIndexEntry{available-hooks}
88
%\VignetteEncoding{UTF-8}
99
%\VignetteEngine{knitr::rmarkdown}
10-
editor_options:
11-
markdown:
10+
editor_options:
11+
markdown:
1212
wrap: 72
1313
---
1414

@@ -164,7 +164,7 @@ to run the `roxygenize` hook for that.
164164

165165
id: parsable-roxygen
166166
args: [--eval]
167-
167+
168168
This hook was added in version 0.4.3.9000.
169169

170170
## `no-browser-statement`
@@ -274,7 +274,7 @@ roclets you specified in `DESCRIPTION`.
274274
<!-- -->
275275

276276
id: roxygenize
277-
args: [--root=<R package root>]
277+
args: [--root=<R package root>]
278278

279279
- Argument `root` specifies the directory in the git repo that
280280
contains the R package. Defaults to `.` since for most R package git
@@ -295,8 +295,8 @@ your DESCRIPTION file. Note that `README.Rmd` is never checked.
295295

296296
<!-- -->
297297

298-
id: deps-in-desc
299-
args: [--allow_private_imports]
298+
id: deps-in-desc
299+
args: [--allow_private_imports]
300300

301301
- Argument `root` specifies the directory in the git repo that
302302
contains the R package. Defaults to `.` since for most R package git
@@ -305,8 +305,8 @@ your DESCRIPTION file. Note that `README.Rmd` is never checked.
305305

306306
<!-- -->
307307

308-
id: deps-in-desc
309-
args: [--root=<R package root>]
308+
id: deps-in-desc
309+
args: [--root=<R package root>]
310310

311311
This hook does not modify the file `DESCRIPTION` because the user should
312312
decide for each package if it should go to `Imports:` or `Suggests:`,
@@ -324,7 +324,7 @@ This hook does modify the file `DESCRIPTION`.
324324
<!-- -->
325325

326326
id: use-tidy-description
327-
args: [--root=<R package root>]
327+
args: [--root=<R package root>]
328328

329329
- Argument `root` specifies the directory in the git repo that
330330
contains the R package. Defaults to `.` since for most R package git
@@ -364,7 +364,7 @@ This hook does not modify any file.
364364
<!-- -->
365365

366366
id: codemeta-description-updated
367-
args: [--root=<R package root>]
367+
args: [--root=<R package root>]
368368

369369
- Argument `root` specifies the directory in the git repo that
370370
contains the R package. Defaults to `.` since for most R package git
@@ -374,29 +374,32 @@ This hook does not modify any file.
374374

375375
## `pkgdown`
376376

377-
Check if your {pkgdown} config file (e.g. `_pkgdown.yml` in your root) has the
378-
correct entries for references and articles.
377+
Check if your {pkgdown} config file (e.g. `_pkgdown.yml` in your root) has the
378+
correct entries for references and articles.
379379
This hook skips the time-consuming parts of building the index and reference and
380-
only performs the validation. Hence we don't rely on the extensive dependency
381-
graph of {pkgdown} being installed, including packages with heavy build-time
380+
only performs the validation. Hence we don't rely on the extensive dependency
381+
graph of {pkgdown} being installed, including packages with heavy build-time
382382
dependencies and system libraries.
383383

384-
For this check, we rely on the the global R package library and require all
385-
development dependencies of the package you want to run this hook for to be
384+
For this check, we rely on the the global R package library and require all
385+
development dependencies of the package you want to run this hook for to be
386386
installed, as well as {pkgdown} (without its dependencies).
387387

388388
This hook does not modify files. Added in version 0.3.2.9003.
389389

390390

391391
## `renv-lockfile-validate`
392392

393-
Guarantees you that you don't accidentally commit an invalid renv.lock file.
393+
Guarantees that you don't accidentally commit an invalid `renv.lock` file.
394+
See [`renv::lockfile_validate()` documentation](https://rstudio.github.io/renv/reference/lockfile_validate.html)
395+
for details.
396+
394397
The below config that uses only `--error` should suffice for most users.
395398

396399
id: renv-lockfile-validate
397400
args: [--error]
398401

399-
This hook does not modify files.
402+
This hook does not modify files. Added in version 0.4.3.9005.
400403

401404
**Arguments**
402405

0 commit comments

Comments
 (0)