enable R as language

Author: lorenzwalthert

.Rbuildignore

@@ -1,16 +1,19 @@
-^_pkgdown\.yml$
+^README\.Rmd$
 ^.*\.Rproj$
-^\.github$
-^\.pre-commit-config\.yaml$
-^\.pre-commit-hooks\.yaml$
 ^\.Rproj\.user$
-^API$
+^LICENSE\.md$
+^\.pre-commit-hooks\.yaml$
+^\.travis\.yml$
 ^CONTRIBUTING\.md$
-^cran-comments\.md$
+^appveyor\.yml$
+^tic\.R$
+^_pkgdown\.yml$
 ^docs$
-^inst/hooks/local$
-^inst/WORDLIST$
-^LICENSE\.md$
 ^pkgdown$
-^README\.Rmd$
-^scratch$
+^\.pre-commit-config\.yaml$
+^API$
+^inst/consistent-release-tag$
+^inst/WORDLIST$
+^inst/hooks-config-to-inst$
+^cran-comments\.md$
+^\.github$

.github/workflows/R-CMD-check.yaml

@@ -8,11 +8,9 @@ on:
   push:
     branches:
       - master
-      - main
   pull_request:
     branches:
       - master
-      - main
 
 name: R-CMD-check
 
@@ -36,6 +34,11 @@ jobs:
           # Linux
           - {os: ubuntu-18.04,   r: 'release', installation_method: 'pip', 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" }
           - {os: ubuntu-18.04,   r: 'release', installation_method: 'conda', 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" }
+#          - {os: ubuntu-16.04,   r: 'devel', installation_method: 'conda', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest", http-user-agent: "R/4.0.0 (ubuntu-16.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
+#          - {os: ubuntu-16.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
+#          - {os: ubuntu-16.04,   r: '3.5',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
+#          - {os: ubuntu-16.04,   r: '3.4',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
+#          - {os: ubuntu-16.04,   r: '3.3',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
 
     env:
       R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
@@ -46,12 +49,12 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@master
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@master
 
       - name: Query dependencies
         run: |
@@ -60,20 +63,20 @@ jobs:
           writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
         shell: Rscript {0}
 
-      - name: Restore R package cache
-        uses: actions/cache@v2
+      - name: Cache R packages
+        if: runner.os != 'Windows'
+        uses: actions/cache@v1
         with:
           path: ${{ env.R_LIBS_USER }}
           key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
           restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
-
       - name: Install system dependencies (Linux)
         if: runner.os == 'Linux'
         run: |
           while read -r cmd
           do
             eval sudo $cmd
-          done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "18.04"))')
+          done < <(Rscript -e 'cat(remotes::system_requirements("ubuntu", "18.04"), sep = "\n")')
 
       - name: Install system dependencies (brew)
         if: matrix.config.installation_method == 'brew'
@@ -108,7 +111,6 @@ jobs:
         env:
           _R_CHECK_CRAN_INCOMING_: false
         run: |
-          options(crayon.enabled = TRUE)
           if (Sys.getenv("PRECOMMIT_INSTALLATION_METHOD") != 'conda') {
             Sys.setenv("_R_CHECK_FORCE_SUGGESTS_" = "False")
           }
@@ -127,8 +129,3 @@ jobs:
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check
-
-      - name: Don't use tar from old Rtools to store the cache
-        if: ${{ runner.os == 'Windows' && startsWith(steps.install-r.outputs.installed-r-version, '3.6' ) }}
-        shell: bash
-        run: echo "C:/Program Files/Git/usr/bin" >> $GITHUB_PATH

.gitignore

@@ -1,6 +1,6 @@
-.RData
-.Rhistory
 .Rproj.user
+.Rhistory
+.RData
 .Ruserdata
 docs/
 inst/doc

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 default_stages: ["commit"]
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.1.3.9014
+    rev: v0.1.3
     hooks: 
     -   id: style-files
         args: [--style_pkg=styler, --style_fun=tidyverse_style]
@@ -39,15 +39,15 @@ repos:
           (.*/|)WORDLIST|
           \.github/workflows/.*|
           data/.*|
-          inst/hooks/.*|
+          inst/bin/.*|
           inst/pre-commit-.*|
           )$
     -   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: v4.0.1
+    rev: v3.2.0
     hooks: 
     -   id: check-added-large-files
     -   id: end-of-file-fixer
@@ -56,17 +56,17 @@ repos:
     hooks:
     -   id: consistent-release-tag
         name: consistent-release-tag
-        entry: inst/hooks/local/consistent-release-tag.R
+        entry: inst/consistent-release-tag
         language: script
         stages: [commit, push]
     -   id: hooks-config-to-inst
         name: hooks-config-to-inst
-        entry: inst/hooks/local/hooks-config-to-inst.R
+        entry: inst/hooks-config-to-inst
         language: script
         stages: [commit, push]
     -   id: spell-check-exclude-to-config
         name: spell-check-exclude-to-config
-        entry: inst/hooks/local/spell-check-exclude-to-config.R
+        entry: inst/spell-check-exclude-to-config
         language: script
         stages: [commit, push]
     -   id: forbid-to-commit
@@ -78,6 +78,6 @@ repos:
     -   id: spell-check-ordered-exclude
         name: Ordered regex pattern for spell-check exclusion
         description: Ensure alphabetical order in `exclude:` key of spell check.
-        entry: inst/hooks/local/spell-check-ordered-exclude.R
+        entry: inst/spell-check-ordered-exclude.R
         language: script
         files: '^(.*/|)\.?pre-commit-config.*\.yaml$'

.pre-commit-hooks.yaml

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

CONTRIBUTING.md

@@ -8,7 +8,7 @@ This repo uses the [tic](https://github.com/ropenscilabs/tic) package for CI.
 
 To create a new hook, have a look at the [official
 documentation](https://pre-commit.com/#new-hooks) on creating new hooks, then have a look
-at existing hooks in this repo. The actual executables are defined in [`inst/hooks/`](https://github.com/lorenzwalthert/precommit/tree/master/inst/hooks). In
+at existing hooks in this repo. The actual executables are defined in [`inst/bin/`](https://github.com/lorenzwalthert/precommit/tree/master/inst/bin). In
 the script, you can expect the passed command line arguments to be all options, 
 finally the files that should be processed with the hook.
 

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: precommit
 Title: Pre-Commit Hooks
-Version: 0.1.3.9015
+Version: 0.1.3.9005
 Author: Lorenz Walthert
 Maintainer: Lorenz Walthert <[email protected]>
 Description: Useful git hooks for R building on top of the multi-language
@@ -40,6 +40,8 @@ Suggests:
     testthat (>= 2.1.0)
 VignetteBuilder: 
     knitr
+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 {

NEWS.md

@@ -1,9 +1,9 @@
-# precommit v0.1.3.9014 (Development)
+# precommit v0.1.3.9005 (Development)
 
 This is a pre-release for `v0.2.0` and imposes a minimal version requirement 
 on the [pre-commit framework](https://pre-commit.com/) (`v2.13.0`). Please see
-*Installation/Update* below for how to satisfy it. This will ensure future 
-releases of {precommit} building on the newly supported 
+*Installation* below for how to satisfy it. This will ensure future releases of 
+{precommit} building on the newly supported 
 [`language: r`](https://pre-commit.com/#r) will work out of the box instead of 
 issuing messages that are confusing for most end-users. We aspire the transition
 to `language: r` due to the following benefits: No more manual dependency management
@@ -12,12 +12,11 @@ enable the easy use of continuous integration services (enforcing hooks and
 auto-fixing problems with pre-commit.ci, GitHub Actions).
 
 
-**Installation/Update**
+**Installation**
 
-Please follow the 
-[update instructions](https://lorenzwalthert.github.io/precommit/dev/#update) or
-[installation instructions](https://lorenzwalthert.github.io/precommit/dev/#installation)
-depending on whether or not you previously used pre-commit.
+Please follow the instructions in the [README](https://lorenzwalthert.github.io/precommit/dev/)
+if you are a new user of pre-commit or if you want to update a current  
+installation.
 
 **API changes**
 
@@ -29,22 +28,19 @@ depending on whether or not you previously used pre-commit.
   `.pre-commit-config.yaml`. See the
   [docs](https://lorenzwalthert.github.io/precommit/articles/available-hooks.html#style-files-1)
   for details.
+- `style-files` and `roxygenize` hooks now warn if there is no permanent 
+  `{R.cache}` cache set up. You can silence the warning with the hook argument 
+  `--no-warn-cache` (#225).
 
 **Minor changes**
 
 - Warnings are no longer promoted to errors in the styler hook, which is 
   particularly relevant for the apparently random error 
   `Unknown or uninitialised column: text` (#268).
-- `style-files` and `roxygenize` hooks now warn if there is no permanent 
-  `{R.cache}` cache set up. You can silence the warning with the hook argument 
-  `--no-warn-cache` (#225).
 - `deps-in-desc` now checks `.Rprofile`, `.Rmd` and `.Rnw` files in addition to 
   `.R` files (#216).  
-- the lintr and styler hook now also check `.Rmd`, `.Rnw` and `.Rprofile` files 
-  (#286).
 - In order to avoid multiple installations of the pre-commit framework, a 
-  warning is issued if multiple are found so the user can remove them (#266, 
-  #273, #277, #278).
+  warning is issued if multiple are found so the user can remove them (#266, #273).
 - The cache for the roxygen2 hook is now also invalidated for changes in formals 
   if there are no changes in roxygen comments (#214).
 - `{renv}` infra files are not checked anymore by default in the template config
@@ -58,8 +54,6 @@ depending on whether or not you previously used pre-commit.
 - The `deps-in-desc` hook now points to the hook argument 
   `--allow_private_imports` when the hook fails due to private imports (#254).
 - roxygenize hook is now fully tested (#267).
-- Hook scripts were relocated and R hooks now have a file extension (#280).
-- Updated GitHub Action workflows (#288).
 
 # precommit v0.1.3
 

R/cache.R

@@ -22,7 +22,7 @@ has_persistent_R.cache <- function() {
 #' @export
 may_require_permanent_cache <- function(temp_cache_is_enough = FALSE) {
   if (has_persistent_R.cache()) {
-    cat("Using persistent cache at", R.cache::getCacheRootPath(), "\n")
+    cat("Using persistant cache at", R.cache::getCacheRootPath(), "\n")
   } else {
     if (temp_cache_is_enough) {
       cat("Using temporary cache at", R.cache::getCacheRootPath(), "\n")