{"Package":"precommit","Title":"Pre-Commit Hooks","Version":"0.4.3","Author":"Lorenz Walthert","Maintainer":"Lorenz Walthert ","Description":"Useful git hooks for R building on top of the multi-language\nframework 'pre-commit' for hook management. This package provides git\nhooks for common tasks like formatting files with 'styler' or spell\nchecking as well as wrapper functions to access the 'pre-commit'\nexecutable.","License":"GPL-3","URL":"https://lorenzwalthert.github.io/precommit/,\nhttps://github.com/lorenzwalthert/precommit","Imports":"cli, fs, here, magrittr, purrr, R.cache, rlang, rprojroot,\nwithr, yaml","Suggests":"desc, docopt (>= 0.7.1), git2r, glue, knitr, lintr, pkgload,\npkgdown, reticulate (>= 1.16), rmarkdown, roxygen2, rstudioapi,\nspelling, styler, testthat (>= 2.1.0), tibble, usethis (>=\n2.0.0)","VignetteBuilder":"knitr","Encoding":"UTF-8","RoxygenNote":"7.3.1","SystemRequirements":"git","Config/testthat/parallel":"true","Config/testthat/edition":"3","NeedsCompilation":"no","Packaged":"2024-07-22 13:56:23 UTC; lorenz","Repository":"CRAN","Date/Publication":"2024-07-22 22:20:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/precommit_0.4.3.tar.gz","readme":"---\neditor_options: \n markdown: \n wrap: 72\n---\n\n\n\n# Useful git pre-commit hooks for R\n\n\n\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/precommit)](https://CRAN.R-project.org/package=precommit)\n[![Lifecycle:\nstable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![R build\nstatus](https://github.com/lorenzwalthert/precommit/workflows/R-CMD-check/badge.svg)](https://github.com/lorenzwalthert/precommit/actions)\n\n\n\n[Pre-commit hooks](https://pre-commit.com) are tests that run each time\nyou attempt to commit. If the tests pass, the commit will be made,\notherwise not. A very basic test is to check if the code is parsable,\nmaking sure you have not forgotten a comma, brace or quote. You can run\nhooks locally and/or in the cloud:\n\n- As a check before local commits: This requires installing\n pre-commit.\n\n- As a CI check with : If you want to enforce\n passing hooks on pull requests (and auto-fix trivial problems like\n styling) even if the committer does not have a local installation.\n\n## Goals of the package\n\nThe goal of this package is to twofold:\n\n- Provide a [set of\n hooks](https://lorenzwalthert.github.io/precommit/articles/available-hooks.html)\n that are useful when your git repo contains R code.\n\n- Provide [usethis](https://github.com/r-lib/usethis)-like\n functionality for common tasks such as installation and set-up and\n config file modification.\n\n## Why do I need pre-commit hooks?\n\n

\n\nFor a more in-depth explanation and even more reasons, see\n`vignette(\"why-use-hooks\")`.\n\n## Documentation\n\nThe following online docs are available:\n\n- [latest CRAN release](https://lorenzwalthert.github.io/precommit/).\n\n- [GitHub development\n version](https://lorenzwalthert.github.io/precommit/dev/).\n\n- [UseR 2022 talk on pre-commit for\n R](https://www.youtube.com/watch?v=r3QXwfxQBLM&t=1280s)\n\nThese only cover the functionality added on top of the pre-commit\nframework by this package. Everything else is covered in the extensive\n[online documentation](https://pre-commit.com) of the pre-commit\nframework itself, including how to create hooks for actions like\n`git push` or `git checkout`, create local hooks etc.","jobInfo":{"package":"precommit","version":"0.4.3","parsingStatus":"success","parserVersion":2,"parsedAt":"2024-07-23T00:30:12+0000"}}

Description

Usage

Arguments

See Also