Merge remote-tracking branch 'origin/dev' into master, v0.4.6

Author: m-mohr

COMPARISON.md

@@ -14,7 +14,7 @@ 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               | 0.4.4               |
+| Validator Version          | 1.0.1                                      | 0.5.2               | 0.4.6               |
 | Language                   | Python 3.6                                 | Python 3            | NodeJS              |
 | CLI                        | Yes                                        | No                  | Yes                 |
 | Programmatic               | Yes                                        | Yes                 | Planned             |

README.md

@@ -6,7 +6,7 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## Versions
 
-**Current version: 0.4.5**
+**Current version: 0.4.6**
 
 | STAC Node Validator Version | Supported STAC Versions |
 | --------------------------- | ----------------------- |
@@ -37,7 +37,7 @@ Further options to add to the commands above:
 
 - To validate against schemas in a local STAC folder (e.g. `dev` branch): `--schemas /path/to/stac/folder`
 - To not verify SSL/TLS certificates: `--ignoreCerts`
-- To lint local JSON files:  `--lint`
+- 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!)
 
 **Note on API support:** Validating lists of STAC items/collections (i.e. `GET /collections` and `GET /collections/:id/items`) is partially supported.

index.js

@@ -5,6 +5,7 @@ const klaw = require('klaw');
 const path = require('path')
 const minimist = require('minimist');
 const compareVersions = require('compare-versions');
+const {diffStringsUnified} = require('jest-diff');
 
 let DEBUG = false;
 let COMPILED = {};
@@ -91,15 +92,17 @@ async function run() {
 					}
 				}
 				else {
-					let fileContent = await fs.readFile(file);
+					let fileContent = await fs.readFile(file, "utf8");
 					json = JSON.parse(fileContent);
 					if (doLint || doFormat) {
-						// 2 spaces, *nix newlines, newline at end of file
-						const expectedContent = JSON.stringify(json, null, 2).replace(/(\r\n|\r)/g, "\n") + "\n";
-						if (fileContent !== expectedContent) {
+						const expectedContent = JSON.stringify(json, null, 2);
+						if (!matchFile(fileContent, expectedContent)) {
 							stats.malformed++;
 							if (doLint) {
 								console.warn("--- Lint: File is malformed -> use `--format` to fix the issue");
+								if (typeof args.verbose !== 'undefined') {
+									console.log(diffStringsUnified(fileContent, expectedContent));
+								}
 							}
 							if (doFormat) {
 								console.warn("--- Format: File was malformed -> fixed the issue");
@@ -221,7 +224,8 @@ async function run() {
 		if (doLint || doFormat) {
 			console.info("Malformed: " + stats.malformed);
 		}
-		process.exit(stats.invalid);
+		let errored = (stats.invalid > 0 || (doLint && !doFormat && stats.malformed > 0)) ? 1 : 0;
+		process.exit(errored);
 	}
 	catch(error) {
 		console.error(error);
@@ -231,6 +235,15 @@ async function run() {
 
 const SUPPORTED_PROTOCOLS = ['http', 'https'];
 
+function matchFile(given, expected) {
+	return normalizeNewline(given) === normalizeNewline(expected);
+}
+
+function normalizeNewline(str) {
+	// 2 spaces, *nix newlines, newline at end of file
+	return str.trimRight().replace(/(\r\n|\r)/g, "\n") + "\n";
+}
+
 function isUrl(uri) {
 	let part = uri.match(/^(\w+):\/\//i);
 	if(part) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stac-node-validator",
-  "version": "0.4.5",
+  "version": "0.4.6",
   "description": "STAC Validator for NodeJS",
   "author": "Matthias Mohr",
   "license": "Apache-2.0",
@@ -29,6 +29,7 @@
     "ajv": "^6.12.2",
     "compare-versions": "^3.6.0",
     "fs-extra": "^9.0.0",
+    "jest-diff": "^26.6.2",
     "klaw": "^3.0.0",
     "minimist": "^1.2.5"
   }