Fill out schema

Author: jrdnbradford

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

@@ -3,6 +3,7 @@
 files <- commandArgs(trailing = TRUE)
 renv_schema <- '{
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "$comment": "See https://github.com/rstudio/renv",
   "title": "renv.lock file.",
   "description": "A schema for renv.lock files generated by {renv}",
   "type": "object",
@@ -11,9 +12,11 @@ renv_schema <- '{
       "type": "object",
       "properties": {
         "Version": {
+          "description": "The version of R used.",
           "type": "string"
         },
         "Repositories": {
+          "description": "The R repositories used in this project.",
           "type": "array",
           "items": {
             "type": "object",
@@ -31,56 +34,121 @@ renv_schema <- '{
         }
       },
       "required": ["Version", "Repositories"]
+    },
+     "Bioconductor": {
+      "type": "object",
+      "properties": {
+        "Version": {
+          "type": "string"
+        }
+      },
+      "required": ["Version"]
     },
     "Packages": {
       "type": "object",
       "additionalProperties": {
         "type": "object",
         "properties": {
           "Package": {
-            "type": "string"
+            "description": "The package name.",
+            "type": "string",
+            "examples": ["ggplot2", "dplyr"]
           },
           "Version": {
-            "type": "string"
+            "description": "The package version.",
+            "type": "string",
+            "examples": ["1.0.0", "3.4.6"]
           },
           "Source": {
-            "type": "string"
+            "description": "The location from which this package was retrieved.",
+            "type": "string",
+            "examples": ["Repository", "Bioconductor"]
           },
           "Repository": {
-            "type": "string"
+            "description": "The name of the repository (if any) from which this package was retrieved.",
+            "type": "string",
+            "examples": ["CRAN"]
           },
           "Hash": {
+            "description": "(Optional) A unique hash for this package, used for package caching.",
             "type": "string",
             "pattern": "^[a-fA-F0-9]{32}$"
           },
           "RemoteType": {
-            "type": "string"
+            "description": "Type of the remote, typically written for packages installed by the devtools, remotes and pak packages.",
+            "type": "string",
+            "examples": ["standard", "github"]
           },
           "RemoteHost": {
+            "description": "Host for the remote.",
             "type": "string",
-            "format": "uri"
+            "format": "uri",
+            "examples": ["api.github.com"]
           },
           "RemoteUsername": {
+            "description": "Username for the remote.",
             "type": "string"
           },
           "RemoteRepo": {
-            "type": "string"
+            "description": "Repositories for the package.",
+            "type": "string",
+            "examples": [
+              "https://cran.rstudio.com",
+              "https://cloud.r-project.org"
+            ]
+          },
+          "RemoteRepos": {
+            "description": "Repositories for the package.",
+            "type": "string",
+            "format": "uri",
+            "examples": [
+              "https://cran.rstudio.com",
+              "https://cloud.r-project.org"
+            ]
           },
           "RemoteRef": {
+            "description": "Name of the packages.",
             "type": "string"
           },
-          "RemoteSha": {
+          "RemotePkgRef": {
+            "description": "Name of the packages.",
+            "type": "string"
+          },
+          "RemotePkgPlatform": {
+            "description": "Architecture/platform of the remote.",
             "type": "string",
-             "pattern": "^[a-fA-F0-9]{40}$"
+            "examples": ["aarch64-apple-darwin20"]
+          },
+          "RemoteSha": {
+            "description": "Version number of the package.",
+            "type": "string"
           },
           "Requirements": {
+            "description": "Dependencies of the package.",
             "type": "array",
             "items": {
               "type": "string"
-            }
+            },
+            "examples": [
+              [ 
+                "R",
+                "jsonlite",
+                "lifecycle",
+                "magrittr",
+                "stringi"
+              ],
+              [
+                "R6",
+                "Rcpp",
+                "later",
+                "magrittr",
+                "rlang",
+                "stats"
+              ]
+            ]
           }
         },
-        "required": ["Package", "Version", "Source", "Hash"]
+        "required": ["Package", "Version", "Source"]
       }
     }
   },