Version 2

.github/workflows/test.yaml

@@ -11,7 +11,6 @@ jobs:
       fail-fast: false
       matrix:
         runner: [
-          'macos-11',
           'macos-12',
           'macos-13',
           'macos-latest',
@@ -22,7 +21,7 @@ jobs:
           'windows-2022',
           'windows-latest',
         ]
-        node: [ '16', '18', '20', '22', 'lts/*' ]
+        node: [ '18', '20', '22',  '23', 'lts/*' ]
     runs-on: ${{ matrix.runner }}
     name: ${{ matrix.runner }} runner with Node.js ${{ matrix.node }}
     steps:

COMPARISON.md

@@ -14,13 +14,13 @@ Here I'd like to give an overview of what the validators are capable of and what
 
 |                            | Python Validator                           | PySTAC              | STAC Node Validator |
 | :------------------------- | ------------------------------------------ | ------------------- | ------------------- |
-| Validator Version          | 1.0.1                                      | 0.5.2               | 1.3.1               |
+| Validator Version          | 1.0.1                                      | 0.5.2               | 2.0.0               |
 | Language                   | Python 3.6                                 | Python 3            | NodeJS              |
 | CLI                        | Yes                                        | No                  | Yes                 |
-| Programmatic               | Yes                                        | Yes                 | Planned             |
-| Online                     | Yes, [staclint.com](https://staclint.com/) | No                  | Planned             |
+| Programmatic               | Yes                                        | Yes                 | Yes                 |
+| Online                     | Yes, [staclint.com](https://staclint.com/) | No                  | Yes                 |
 | Protocols supported (Read) | HTTP(S), Filesystem                        | HTTP(S), Filesystem | HTTP(S), Filesystem |
-| Gives                      | HTML / CLI / Python Output                 | Python Dict         | CLI output          |
+| Gives                      | HTML / CLI / Python                        | Python              | CLI / JavaScript    |
 
 ## Specifications supported
 

README.md

@@ -6,11 +6,11 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## Versions
 
-**Current version: 1.3.1**
+**Current version:** 2.0.0-beta.15
 
 | STAC Node Validator Version | Supported STAC Versions |
 | --------------------------- | ----------------------- |
-| 1.1.0 / 1.2.x               | >= 1.0.0-rc.1           |
+| 1.1.0 / 1.2.x / 2.x.x       | >= 1.0.0-rc.1           |
 | 0.4.x / 1.0.x               | >= 1.0.0-beta.2 and < 1.0.0-rc.3 |
 | 0.3.0                       | 1.0.0-beta.2            |
 | 0.2.1                       | 1.0.0-beta.1            |
@@ -22,7 +22,7 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## Setup
 
-1. Install [node and npm](https://nodejs.org) - should run with any version >= 16. Older versions may still work, but no guarantee.
+1. Install [node and npm](https://nodejs.org) - should run with any version >= 22.1.0.
 2. `npm install -g stac-node-validator` to install the library permanently
 
 ## Usage
@@ -44,42 +44,20 @@ Further options to add to the commands above:
 - Add `--strict` to enable strict mode in validation for schemas and numbers (as defined by [ajv](https://ajv.js.org/strict-mode.html) for options `strictSchema`, `strictNumbers` and `strictTuples`)
 - To lint local JSON files: `--lint` (add `--verbose` to get a diff with the changes required)
 - To format / pretty-print local JSON files: `--format` (Attention: this will override the source files without warning!)
+- To run custom validation code: `--custom ./path/to/validation.js` - The validation.js needs to contain a class that implements the `BaseValidator` interface. See [custom.example.js](./custom.example.js) for an example.
 
 **Note on API support:** Validating lists of STAC items/collections (i.e. `GET /collections` and `GET /collections/:id/items`) is partially supported.
 It only checks the contained items/collections, but not the other parts of the response (e.g. `links`).
 
 ### Config file
 
 You can also pass a config file via the `--config` option. Simply pass a file path as value.
-Parameters set via CLI will override the corresponding setting in the config file.
-Make sure to use the value `false` to override boolean flags that are set to `true` in the config file.
+Parameters set via CLI will not override the corresponding setting in the config file.
 
 The config file uses the same option names as above.
 To specify the files to be validated, add an array with paths.
 The schema map is an object instead of string separated with a `=` character.
 
-**Example:**
-```json
-{
-  "files": [
-    "/path/to/your/catalog.json",
-    "/path/to/your/item.json"
-  ],
-  "schemas": "/path/to/stac/folder",
-  "schemaMap": {
-    "https://stac-extensions.github.io/foobar/v1.0.0/schema.json": "./json-schema/schema.json"
-  },
-  "ignoreCerts": false,
-  "verbose": false,
-  "lint": true,
-  "format": false,
-  "strict": true,
-	"all": false
-}
-```
-
-You could now override some options as follows in CLI: `stac-node-validator example.json --config /path/to/config.json --lint false`
-
 ### Development
 
 1. `git clone https://github.com/stac-utils/stac-node-validator` to clone the repo

bin/cli.js

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
-require('../index.js')()
+const runCLI = require('../src/cli.js');
+runCLI();

custom.example.js

@@ -0,0 +1,25 @@
+const BaseValidator = require('stac-node-validator/src/baseValidator.js');
+
+class CustomValidator extends BaseValidator {
+
+	/**
+	 * Any custom validation routines you want to run.
+	 * 
+	 * You can either create a list of errors using the test interface
+	 * or just throw on the first error.
+	 * 
+	 * @param {STAC} data
+	 * @param {Test} test
+	 * @param {import('.').Report} report
+	 * @param {import('.').Config} config
+	 * @throws {Error}
+	 */
+	async afterValidation(data, test, report, config) {
+		if (data.id === 'solid-earth') {
+			test.deepEqual(data.example, [1,2,3]);
+		}
+	}
+
+}
+
+module.exports = CustomValidator;