Pre commit (#23)

* Adding the pre-commit hook

* Removing adding README.md back to pre-commit

* Adding pre-commit to Rbuildignore

* Adding pre-commit as dependency

* Passing Rscript differently

* Get to get the library

* Setting up R in pre-commit

* Setting up where to install the package and from where

* Both can only be used in mac and windows

* Adding jammy to the repo

* Removing dangling pre-commit file

* Setting no cache root

* Reverting root cache pre-commit

* Running pre-commit alternatively

* Update pre-commit.yaml

* Correct hooks

* Forgot to install it:

* Dealing with styler

* Revising how to deal with pre-commit

* Forcing the R version to be 4.4.1 in precommit R

* Adding some contextual information

* Reverting how pre-commit works

* Adding pre-commit Renv

* Need a cache-root maybe

.Rbuildignore

@@ -31,6 +31,7 @@ README\.html
 
 # Adding gitattributes
 \.gitattributes
+\.pre-commit-config.yaml
 
 paper\..+
 docker

.github/workflows/pre-commit.yaml

@@ -10,6 +10,9 @@ on:
 
 jobs:
   pre-commit:
+
+    name: Pre-commit
+
     runs-on: ubuntu-latest
 
     steps:
@@ -19,5 +22,18 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
 
+      - name: Cache R packages for pre-commit (live in renv)
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/R/renv
+          key: r-precommit-cache|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
+
+      # Notice this step depends on what
+      # https://github.com/lorenzwalthert/precommit has as
+      # R version in renv.lock. GHA ubuntu-latest runner comes
+      # with R 4.4.1, which is the same as in renv.lock. If that
+      # changes, caching will not work as it will be loading a
+      # different version of R.
       - name: Run pre-commit hooks
         uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -14,14 +14,17 @@ repos:
         exclude: ^(inst/|man/|src/cpp11.cpp|playgroud/|R/cpp11.R)
 
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.4.2
+    # This version of precommit uses R 4.4.1 (renv.lock)
+    # See the pre-commit.yaml workflow file for more details.
+    rev: v0.4.3
     hooks:
       - id: style-files
         args:
           [
             '--ignore-start="^# styler: off$"',
             '--ignore-stop="^# styler: on$"',
-            '--strict=FALSE'
+            '--strict=FALSE',
+            '--cache-root=styler-perm'
           ]
         exclude: ^(inst/|man/|src/cpp11.cpp|playgroud/|R/cpp11.R)
       - id: readme-rmd-rendered