Merge pull request #82 from ropensci/prepare-release-1-5-0

richfitz · web-flow · commit 01868830ce88 · 2025-02-07T11:47:42.000Z
Prepare CRAN release
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: jsonvalidate
 Title: Validate 'JSON' Schema
-Version: 1.4.2
+Version: 1.5.0
 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
     email = "rich.fitzjohn@gmail.com"),
     person("Rob", "Ashton", role = "aut"),
@@ -29,7 +29,7 @@ Suggests:
     rmarkdown,
     testthat,
     withr
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
 VignetteBuilder: knitr
 Encoding: UTF-8
diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2016
+YEAR: 2024
 COPYRIGHT HOLDER: Rich FitzJohn
diff --git a/R/schema.R b/R/schema.R
@@ -5,7 +5,7 @@
 ##' @description Interact with JSON schemas, using them to validate
 ##'   json strings or serialise objects to JSON safely.
 ##'
-##' This interface supercedes [jsonvalidate::json_schema] and changes
+##' This interface supersedes [jsonvalidate::json_schema] and changes
 ##'   some default arguments.  While the old interface is not going
 ##'   away any time soon, users are encouraged to switch to this
 ##'   interface, which is what we will develop in the future.
diff --git a/R/serialise.R b/R/serialise.R
@@ -5,7 +5,7 @@
 ##' particular:
 ##'
 ##' * R has no scalar types so it is not clear if `1` should be
-##'   serialised as a number or a vector of length 1; jsonlite
+##'   serialised as a number or a vector of length 1; `jsonlite`
 ##'   provides support for "automatically unboxing" such values
 ##'   (assuming that length-1 vectors are scalars) or never unboxing
 ##'   them unless asked to using [jsonlite::unbox]
@@ -20,7 +20,7 @@
 ##'
 ##' These issues are somewhat lessened when we have a schema because
 ##' we know what our target type looks like.  This function attempts
-##' to use the schema to guide serialsation of json safely.  Currently
+##' to use the schema to guide serialisation of json safely.  Currently
 ##' it only supports detecting the appropriate treatment of length-1
 ##' vectors, but we will expand functionality over time.
 ##'
@@ -43,7 +43,7 @@
 ##' schemas contained within a `oneOf` block (or similar) will not be
 ##' recursed into.
 ##'
-##' @section: Warning:
+##' # Warning
 ##'
 ##' Direct use of this function will be slow!  If you are going to
 ##'   serialise more than one or two objects with a single schema, you
diff --git a/R/validate.R b/R/validate.R
@@ -21,7 +21,7 @@
 ##'   scope this option if you want to quieten it within code you do
 ##'   not control.  Alternatively, setting the option
 ##'   `jsonvalidate.no_note_imjv` to `FALSE` will print the message
-##'   even noninteractively.
+##'   even non-interactively.
 ##'
 ##' Updating the engine should be simply a case of adding `engine
 ##'   = "ajv"` to your `json_validator` or `json_validate`
@@ -80,7 +80,7 @@
 ##'
 ##' @return A function that can be used to validate a
 ##'   schema. Additionally, the function has two attributes assigned:
-##'   `v8` which is the javascript context (used internally) and
+##'   `v8` which is the JavaScript context (used internally) and
 ##'   `engine`, which contains the name of the engine used.
 ##'
 ##' @export
diff --git a/R/zzz.R b/R/zzz.R
@@ -6,6 +6,6 @@ jsonvalidate_js <- function() {
 
 
 ## Via Gabor, remove NOTE about Imports while not loading R6 at load.
-function() {
+ignore_unused_imports <- function() {
   R6::R6Class
 }
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <!-- badges: start -->
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![R-CMD-check](https://github.com/ropensci/jsonvalidate/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/jsonvalidate/actions/workflows/R-CMD-check.yaml)
-[![codecov.io](https://codecov.io/github/ropensci/jsonvalidate/coverage.svg?branch=master)](https://codecov.io/github/ropensci/jsonvalidate?branch=master)
+[![codecov.io](https://codecov.io/github/ropensci/jsonvalidate/coverage.svg?branch=master)](https://app.codecov.io/github/ropensci/jsonvalidate?branch=master)
 [![](http://www.r-pkg.org/badges/version/jsonvalidate)](https://cran.r-project.org/package=jsonvalidate)
 <!-- badges: end -->
 
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -1,6 +1,9 @@
+CMD
+R's
 ajv
 arg
 codecov
+deserialise
 imjv
 io
 js
@@ -10,3 +13,4 @@ metaschema
 org
 ropensci
 subschema
+unboxable
diff --git a/man/json_schema.Rd b/man/json_schema.Rd
diff --git a/man/json_serialise.Rd b/man/json_serialise.Rd
diff --git a/man/json_validator.Rd b/man/json_validator.Rd
diff --git a/vignettes/jsonvalidate.Rmd b/vignettes/jsonvalidate.Rmd
@@ -19,13 +19,13 @@ using [V8](https://cran.r-project.org/package=V8) to do JSON schema
 validation in R.
 
 You need a JSON schema file; see
-[json-schema.org](http://json-schema.org) for details on writing
+[json-schema.org](https://json-schema.org/) for details on writing
 these.  Often someone else has done the hard work of writing one
 for you, and you can just check that the JSON you are producing or
 consuming conforms to the schema.
 
 The examples below come from the [JSON schema
-website](http://json-schema.org/learn/getting-started-step-by-step.html)
+website](https://json-schema.org//learn/getting-started-step-by-step.html)
 
 They describe a JSON based product catalogue, where each product
 has an id, a name, a price, and an optional set of tags.  A JSON

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-YEAR: 2016`
	`1`	`+YEAR: 2024`
`2`	`2`	`COPYRIGHT HOLDER: Rich FitzJohn`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ jsonvalidate_js <- function() {`
`6`	`6`
`7`	`7`
`8`	`8`	`## Via Gabor, remove NOTE about Imports while not loading R6 at load.`
`9`		`-function() {`
	`9`	`+ignore_unused_imports <- function() {`
`10`	`10`	`R6::R6Class`
`11`	`11`	`}`