Initial {renv} hook

Author: jrdnbradford

.pre-commit-hooks.yaml

@@ -120,3 +120,10 @@
     language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'
+-   id: validate-renv-lock
+    name: validate-renv-lock
+    description: Validate that your `renv.lock`` file is valid json and fits the {renv} schema
+    entry: inst/hooks/exported/validate-renv-lock.R
+    language: r
+    minimum_pre_commit_version: "2.13.0"
+    files: '^renv\.lock$'

inst/hooks/exported/validate-renv-lock.R

@@ -0,0 +1,44 @@
+#!/usr/bin/env Rscript
+
+if (!require(readr, quietly = TRUE)) {
+  stop("{readr} could not be loaded, please install it.")
+}
+
+if (!require(jsonvalidate, quietly = TRUE)) {
+  stop("{jsonvalidate} could not be loaded, please install it.")
+}
+
+library(readr)
+library(jsonvalidate)
+
+files <- commandArgs(trailing = TRUE)
+path_renv_schema <- file.path("inst", "renv.schema.json")
+renv_schema <- readr::read_file(path_renv_schema)
+
+validate_renv_lock <- function(renv_path, renv_lock_schema) {
+  renv_json <- readr::read_file(renv_path)
+
+  jsonvalidate::json_validate(
+    renv_json,
+    renv_lock_schema,
+    engine  = "ajv",
+    greedy  = TRUE,
+    error   = TRUE,
+    verbose = TRUE
+  )
+}
+
+#files <- list.files(recursive = TRUE)
+out <- lapply(files, function(path) {
+  is_renv_lock <- grepl("^.*renv\\.lock$", path)
+  if (is_renv_lock) {
+    print(paste0(path, " is a renv.lock file"))
+    tryCatch(
+      validate_renv_lock(path, renv_schema),
+      error = function(error) {
+        cat(c("renv.lock at", path, "failed validation. Full context:\n"))
+        stop(conditionMessage(error), call. = FALSE)
+      }
+    )
+  }
+})

inst/pre-commit-hooks.yaml

@@ -120,3 +120,10 @@
     language: script
     minimum_pre_commit_version: "2.13.0"
     files: '^man/|_pkgdown\.yml'
+-   id: validate-renv-lock
+    name: validate-renv-lock
+    description: Validate that your `renv.lock`` file is valid json and fits the {renv} schema
+    entry: inst/hooks/exported/validate-renv-lock.R
+    language: r
+    minimum_pre_commit_version: "2.13.0"
+    files: '^renv\.lock$'

inst/renv.schema.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "renv.lock file.",
+  "description": "A schema for renv.lock files generated by {renv}",
+  "type": "object",
+  "properties": {
+    "R": {
+      "type": "object",
+      "properties": {
+        "Version": {
+          "type": "string"
+        },
+        "Repositories": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "Name": {
+                "type": "string"
+              },
+              "URL": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "required": ["Name", "URL"]
+          }
+        }
+      },
+      "required": ["Version", "Repositories"]
+    },
+    "Packages": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "Package": {
+            "type": "string"
+          },
+          "Version": {
+            "type": "string"
+          },
+          "Source": {
+            "type": "string"
+          },
+          "Repository": {
+            "type": "string"
+          },
+          "Hash": {
+            "type": "string",
+            "pattern": "^[a-fA-F0-9]{32}$"
+          },
+          "RemoteType": {
+            "type": "string"
+          },
+          "RemoteHost": {
+            "type": "string",
+            "format": "uri"
+          },
+          "RemoteUsername": {
+            "type": "string"
+          },
+          "RemoteRepo": {
+            "type": "string"
+          },
+          "RemoteRef": {
+            "type": "string"
+          },
+          "RemoteSha": {
+            "type": "string",
+             "pattern": "^[a-fA-F0-9]{40}$"
+          },
+          "Requirements": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": ["Package", "Version", "Source", "Hash"]
+      }
+    }
+  },
+  "required": ["R", "Packages"]
+}

renv.lock

@@ -22,7 +22,7 @@
         "digest",
         "utils"
       ],
-      "Hash": "fe539ca3f8efb7410c3ae2cf5fe6c0f8"
+      "Hash": "fe539c3f8efb7410c3ae2cf5fe6c0f8"
     },
     "R.methodsS3": {
       "Package": "R.methodsS3",
@@ -33,7 +33,7 @@
         "R",
         "utils"
       ],
-      "Hash": "278c286fd6e9e75d0c2e8f731ea445c8"
+      "Hash": "278c286fd6e9e75d02e8f731ea445c8"
     },
     "R.oo": {
       "Package": "R.oo",
@@ -118,7 +118,7 @@
       "Package": "cli",
       "Version": "3.6.2",
       "Source": "Repository",
-      "Repository": "RSPM",
+      "Repository": true,
       "Requirements": [
         "R",
         "utils"