Use r instead of script as language

.Rbuildignore

@@ -1,3 +1,5 @@
+^renv$
+^renv\.lock$
 ^README\.Rmd$
 ^.*\.Rproj$
 ^\.Rproj\.user$

.github/workflows/hook-tests.yaml

@@ -0,0 +1,126 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+name: Hook tests
+
+jobs:
+  hook-test:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-18.04,   r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.0.0 (ubuntu-18.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
+    env:
+      RSPM: ${{ matrix.config.rspm }}
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: r-lib/actions/setup-r@master
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+      - name: Query dependencies
+        run: |
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+      - name: Cache R packages (macOs)
+        if: startsWith(runner.os, 'macOS')
+        uses: actions/cache@v2
+        with:
+          path: ~/Library/Application Support/renv
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('renv.lock') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+      - name: Cache R packages (Linux)
+        if: startsWith(runner.os, 'Linux')
+        uses: actions/cache@v2
+        with:
+          path: ~/.local/share/renv
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('renv.lock') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+      - name: Cache R packages (Windows)
+        if: startsWith(runner.os, 'Windows')
+        uses: actions/cache@v2
+        with:
+          path: ~\AppData\Local\renv
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('renv.lock') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          Rscript -e "install.packages('remotes', repos = Sys.getenv('RSPM'))"
+          while read -r cmd
+          do
+            eval sudo $cmd
+          done < <(Rscript -e 'cat(remotes::system_requirements("ubuntu", "18.04"), sep = "\n")')
+      - name: Prepare hook environment
+        run: |
+          source('renv/activate.R')
+          renv::restore()
+          renv::install(getwd(), dependencies = FALSE) 
+          # needed to make sure renv is activated in run_test() 
+          activate <- c(
+            "if (nzchar(Sys.getenv('R_PRECOMMIT_HOOK_ENV')))",
+            paste0("renv::load('", getwd(), "')")
+          )
+          writeLines(activate, '~/.Rprofile') 
+        shell: Rscript {0}
+      - name: Perpare testing environment
+        run: |
+          # testing dependencies (incl. {precommit}) live in global R library, 
+          # hook dependencies in renv, which is only activated when child R
+          # process is invoked, e.g. as in run_test()
+          if (!requireNamespace("renv", quietly = TRUE)) {
+            install.packages("renv", repos = c(CRAN = "https://cloud.r-project.org"))
+          }
+          renv::install(c('testthat', 'devtools'))
+          # some testing infrastructure we need is in R/testing.R
+          renv::install(getwd(), dependencies = TRUE) 
+        shell: Rscript {0}
+      - name: Session info (testing environment)
+        run: |
+          renv::install('sessioninfo', repos = 'cloud.r-project.org')
+          options(width = 100)
+          pkgs <- installed.packages()[, "Package"]
+          sessioninfo::session_info(pkgs, include_base = TRUE)
+        shell: Rscript {0}
+      - name: Test
+        run: |
+          devtools::load_all()
+          testthat::test_file(
+            "tests/testthat/test-hooks.R",
+            reporter = testthat::MultiReporter$new(list(
+              testthat::CheckReporter$new(), testthat::FailReporter$new()
+            ))
+          )
+        shell: Rscript {0}
+      - name: Show testthat output
+        if: always()
+        run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+      - name: Assert no leakage from testing to hook env (1/2)
+        run: |
+          Rscript -e "renv::install('usethis'); path_pkg <- file.path(tempdir(), 'someP'); usethis::create_package(path_pkg); renv::install(path_pkg)"
+      - name: Assert no leakage from testing to hook env (2/2)
+        env: 
+            R_PRECOMMIT_HOOK_ENV: "1"
+        run: |
+          Rscript -e "if ('someP' %in% rownames(installed.packages())) stop('environment isolation not working: You installed a package into the testing environment and it is available in the hook environment')"
+      - name: Upload check results
+        if: failure()
+        uses: actions/upload-artifact@main
+        with:
+          name: ${{ runner.os }}-r${{ matrix.config.r }}-results
+          path: check

.pre-commit-config.yaml

@@ -3,11 +3,15 @@
 default_stages: ["commit"]
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.1.3
+    rev: acc8657498d5bfb9e9891098ba00b36e82c7ebd6
     hooks: 
     -   id: style-files
         args: [--style_pkg=styler, --style_fun=tidyverse_style]
-        exclude: '^tests/testthat/in/.*\.R'
+        exclude: > 
+          (?x)^(
+          tests/testthat/in/.*\.R|
+          renv/.*
+          )$
     -   id: roxygenize
     # codemeta must be above use-tidy-description when both are used
     # -   id: codemeta-description-updated

.pre-commit-hooks.yaml

@@ -1,51 +1,59 @@
 -   id: roxygenize
     name: roxygenize
     description: run roxygen2::roxygenize()
-    entry: inst/bin/roxygenize
-    language: script
+    entry: Rscript inst/bin/roxygenize
+    language: r
     files: '^(R|man)/'
+    require_serial: true
+    minimum_pre_commit_version: "2.12"
 -   id: use-tidy-description
     name: use-tidy-description
     description: run usethis::use_tidy_description()
-    entry: inst/bin/use-tidy-description
-    language: script
+    entry: Rscript inst/bin/use-tidy-description
+    language: r
     files: '^DESCRIPTION$'
+    minimum_pre_commit_version: "2.12"
 -   id: style-files
     name: style-files
     description: style files with styler
-    entry: inst/bin/style-files
-    language: script
+    entry: Rscript inst/bin/style-files
+    language: r
     files: '(\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
+    minimum_pre_commit_version: "2.12"
 -   id: no-browser-statement
     name: no-browser-statement
     description: check if a .R file contains a `browser()` statement
-    entry: inst/bin/no-browser-statement
-    language: script
+    entry: Rscript inst/bin/no-browser-statement
+    language: r
     files: '\.[rR]$'
+    minimum_pre_commit_version: "2.12"
 -   id: parsable-R
     name: parsable-R
     description: check if a .R file is parsable
-    entry: inst/bin/parsable-R
-    language: script
+    entry: Rscript inst/bin/parsable-R
+    language: r
     files: '\.[rR]$'
+    minimum_pre_commit_version: "2.12"
 -   id: readme-rmd-rendered
     name: readme-rmd-rendered
     description: make sure README.Rmd hasn't been edited more recently than README.md
     entry: inst/bin/readme-rmd-rendered
     language: script
     files: 'README\.[Rr]?md$'
+    minimum_pre_commit_version: "2.12"
 -   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.
-    entry: inst/bin/codemeta-description-updated
-    language: script
+    entry: Rscript inst/bin/codemeta-description-updated
+    language: r
     files: '^DESCRIPTION$'
+    minimum_pre_commit_version: "2.12"
 -   id: spell-check 
     name: spell-check
     description: perform a spell check with spelling::spell_check_files()
-    entry: inst/bin/spell-check
-    language: script
+    entry: Rscript inst/bin/spell-check
+    language: r
     exclude: >
       (?x)^(
       data/.*| 
@@ -70,17 +78,20 @@
       .*\.RData
       )$
     require_serial: true
+    minimum_pre_commit_version: "2.12"
 -   id: deps-in-desc
     name: deps-in-desc
     description: Check if dependencies that can be parsed from code are in DESCRIPTION.
-    entry: inst/bin/deps-in-desc
-    language: script
+    entry: Rscript inst/bin/deps-in-desc
+    language: r
     files: '(\.[rR]profile|\.R|\.Rmd|\.Rnw|\.r|\.rmd|\.rnw)$'
     exclude: 'renv/activate\.R'
+    minimum_pre_commit_version: "2.12"
 -   id: lintr
     name: lintr
     description: check if a .R file is lint free (using lintr)
-    entry: inst/bin/lintr
-    language: script
+    entry: Rscript inst/bin/lintr
+    language: r
     files: '\.[rR]$'
     exclude: 'renv/activate\.R'
+    minimum_pre_commit_version: "2.12"

DESCRIPTION

@@ -3,11 +3,11 @@ Title: Pre-Commit Hooks
 Version: 0.1.3.9000
 Author: Lorenz Walthert
 Maintainer: Lorenz Walthert <lorenz.walthert@icloud.com>
-Description: Useful git hooks for R building on top of the
-    multi-language framework 'pre-commit' for hook management. This
-    package provides git hooks for common tasks like formatting files with
-    'styler' or spell checking as well as wrapper functions to access the
-    'pre-commit' executable.
+Description: Useful git hooks for R building on top of the multi-language
+    framework 'pre-commit' for hook management. This package provides git
+    hooks for common tasks like formatting files with 'styler' or spell
+    checking as well as wrapper functions to access the 'pre-commit'
+    executable.
 License: GPL-3
 URL: https://lorenzwalthert.github.io/precommit/,
     https://github.com/lorenzwalthert/precommit
@@ -41,8 +41,8 @@ VignetteBuilder:
 Remotes: 
     r-lib/styler
 Encoding: UTF-8
-Roxygen: list(markdown = TRUE, roclets = c( "rd", "namespace",
-    "collate", if (rlang::is_installed("pkgapi")) "pkgapi::api_roclet"
-    else { warning("Please install r-lib/pkgapi to make sure the file API
-    is kept up to date"); NULL} ) )
-RoxygenNote: 7.1.1
+Roxygen: list(markdown = TRUE, roclets = c( "rd", "namespace", "collate",
+    if (rlang::is_installed("pkgapi")) "pkgapi::api_roclet" else {
+    warning("Please install r-lib/pkgapi to make sure the file API is kept
+    up to date"); NULL} ) )
+RoxygenNote: 7.1.1.9001

NEWS.md

@@ -12,6 +12,13 @@
   `{R.cache}` cache set up. You can silence the warning with the hook argument 
   `--no-warn-cache` (#225).
 
+**Major Changes**
+
+- {precommit} now uses [`language: r`](https://pre-commit.com/#r) instead of 
+  `language: script` from the [pre-commit framework](https://pre-commit.com). 
+  This requires `pre-commit >= 2.11.1`. All hooks and dependencies are now 
+  contained in a virtual environment with [`{renv}`](https://rstudio.github.io/renv/)
+  (#233).
 
 **Minor changes**
 

R/setup.R

@@ -1,6 +1,6 @@
-#' Set up pre-commit
+#' Get started with pre-commit
 #'
-#' Get started.
+#' This function sets up pre-commit for your git repo.
 #' @param install_hooks Whether to install environments for all available hooks.
 #'   If `FALSE`, environments are installed with first commit.
 #' @param legacy_hooks How to treat hooks already in the repo which are not

R/testing.R

@@ -1,7 +1,8 @@
 #' Run a test
 #'
 #' Tests for the executables used as pre-commit hooks via `entrypoint` in
-#' `.pre-commit-config.yaml`.
+#' `.pre-commit-config.yaml`. Set's the env variable `R_PRECOMMIT_HOOK_ENV` to
+#' when running.
 #' @details
 #' Two potential outcomes of a hooks are pass or fail. This is reflected on the
 #' level of the executable: Fail means the executable fails or the file is
@@ -15,7 +16,6 @@
 #'   executable. To check for failed executable, we set `error_msg` to
 #'   the message we expect. To check changed file content, we set `error_msg` to
 #'   `NA`.
-#'
 #' @param hook_name The name of the hook in `bin/`.
 #' @param file_name The file to test in `tests/in` (without extension).
 #' @param suffix The suffix of `file_name`.
@@ -39,6 +39,7 @@ run_test <- function(hook_name,
                      copy = NULL,
                      file_transformer = function(files) files,
                      env = character()) {
+  withr::local_envvar(list(R_PRECOMMIT_HOOK_ENV = "1"))
   path_executable <- system.file(
     fs::path("bin", hook_name),
     package = "precommit"
@@ -87,7 +88,7 @@ run_test_impl <- function(path_executable,
   tempdir <- fs::dir_create(fs::file_temp())
   if (!is.null(copy)) {
     if (is.null(names(copy))) {
-      # no names, take basename
+      # not namesm take directory name
       new_dirs <- fs::path(tempdir, fs::path_dir(copy))
       fs::dir_create(new_dirs)
       paths_copy <- fs::path(new_dirs, fs::path_file(copy))