5etools-utils 0.1.2 → 0.1.5

package/lib/Api.js

@@ -1,5 +1,9 @@
-import {helloWorld} from "./HelloWorld.js";
+import {JsonTester} from "./TestJson.js";
+import * as Um from "./UtilMisc.js";
+import * as Uf from "./UtilFs.js";
 
 export {
-	helloWorld,
+	JsonTester,
+	Um,
+	Uf,
 };

package/lib/TestJson.js

@@ -0,0 +1,121 @@
+import * as path from "path";
+
+import Ajv from "ajv";
+import * as jsonSourceMap from "json-source-map";
+
+import * as uf from "./UtilFs.js";
+import * as um from "./UtilMisc.js";
+
+const _IS_SORT_RESULTS = !process.env.VET_TEST_JSON_RESULTS_UNSORTED;
+const _IS_TRIM_RESULTS = !process.env.VET_TEST_JSON_RESULTS_UNTRIMMED;
+
+class JsonTester {
+	static _RE_DATE = /^\d\d\d\d-\d\d-\d\d$/;
+
+	constructor (
+		{
+			dirSchema,
+			tagLog = "JSON",
+		},
+	) {
+		this._dirSchema = dirSchema;
+		this._tagLog = tagLog;
+
+		// region Set up validator
+		this._ajv = new Ajv({
+			allowUnionTypes: true,
+		});
+
+		this._ajv.addKeyword({
+			keyword: "version",
+			validate: false,
+		});
+
+		this._ajv.addFormat(
+			"date",
+			{
+				validate: str => JsonTester._RE_DATE.test(str),
+			},
+		);
+		// endregion
+	}
+
+	/**
+	 * Add any implicit data to the JSON
+	 */
+	_addImplicits (obj, lastKey) {
+		if (typeof obj !== "object") return;
+		if (obj == null) return;
+		if (obj instanceof Array) obj.forEach(it => this._addImplicits(it, lastKey));
+		else {
+			// "obj.mode" will be set if this is in a "_copy" etc. block
+			if (lastKey === "spellcasting" && !obj.mode) obj.type = obj.type || "spellcasting";
+
+			Object.entries(obj).forEach(([k, v]) => this._addImplicits(v, k));
+		}
+	}
+
+	_getFileErrors ({filePath}) { return `${filePath}\n${JSON.stringify(this._ajv.errors, null, 2)}`; }
+
+	_handleError ({filePath, errors, errorsFull, data}) {
+		if (!process.env.CI) errorsFull.push(this._getFileErrors({filePath}));
+
+		// Sort the deepest errors to the bottom, as these are the ones we're most likely to be the ones we care about
+		//   manually checking.
+		if (_IS_SORT_RESULTS) {
+			this._ajv.errors.sort((a, b) => (a.instancePath.length ?? -1) - (b.instancePath.length ?? -1));
+		}
+
+		// If there are an excessive number of errors, it's probably a junk entry; show only the first error and let the
+		//   user figure it out.
+		if (_IS_TRIM_RESULTS && this._ajv.errors.length > 5) {
+			console.error(`(${this._ajv.errors.length} errors found, showing (hopefully) most-relevant one)`);
+			this._ajv.errors = this._ajv.errors.slice(-1);
+		}
+
+		// Add line numbers
+		const sourceMap = jsonSourceMap.stringify(data, null, "\t");
+		this._ajv.errors.forEach(it => {
+			const errorPointer = sourceMap.pointers[it.instancePath];
+			it.lineNumberStart = errorPointer.value.line;
+			it.lineNumberEnd = errorPointer.valueEnd.line;
+		});
+
+		const error = this._getFileErrors({filePath});
+		um.error(this._tagLog, error);
+		errors.push(error);
+	}
+
+	getErrors () {
+		um.info(this._tagLog, `Validating JSON against schema`);
+
+		uf.listJsonFiles(this._dirSchema)
+			.forEach(filePath => {
+				filePath = path.normalize(filePath);
+				const contents = uf.readJSON(filePath);
+
+				const relativeFilePath = path.relative(this._dirSchema, filePath)
+					.replace(/\\/g, "/");
+
+				this._ajv.addSchema(contents, relativeFilePath);
+			});
+
+		const errors = [];
+		const errorsFull = [];
+
+		uf.runOnDirs((dir) => {
+			uf.listJsonFiles(dir)
+				.forEach(filePath => {
+					const data = uf.readJSON(filePath);
+					this._addImplicits(data);
+					const valid = this._ajv.validate("homebrew.json", data);
+
+					if (!valid) this._handleError({filePath, errors, errorsFull, data});
+				});
+		});
+
+		return {errors, errorsFull};
+	}
+}
+
+export {JsonTester};

package/lib/UtilFs.js

@@ -0,0 +1,64 @@
+import * as fs from "fs";
+
+function isDirectory (path) {
+	return fs.lstatSync(path).isDirectory();
+}
+
+function readJSON (path) {
+	try {
+		if (fs.existsSync(path)) {
+			let str = fs.readFileSync(path, "utf8");
+			// Strip BOM(s)
+			while (str.charCodeAt(0) === 0xFEFF) str = str.slice(1);
+			return JSON.parse(str);
+		} else {
+			const parts = path.split(/[\\/]+/g);
+			const dir = parts.slice(0, -1).join("/");
+			const originalName = parts[parts.length - 1];
+			const filenames = fs.readdirSync(dir, "utf8");
+			const filename = filenames.find(it => it.toLowerCase() === originalName.toLowerCase());
+			if (filename) return JSON.parse(fs.readFileSync(`${dir}/${filename}`, "utf8"));
+			else throw new Error(`Could not find file "${path}"`);
+		}
+	} catch (e) {
+		e.message += ` (Path: ${path})`;
+		throw e;
+	}
+}
+
+function listJsonFiles (dir) {
+	const dirContent = fs.readdirSync(dir, "utf8")
+		.map(file => `${dir}/${file}`);
+	return dirContent.reduce((acc, file) => {
+		if (isDirectory(file)) acc.push(...listJsonFiles(file));
+		else {
+			if (file.toLowerCase().endsWith(".json")) acc.push(file);
+		}
+		return acc;
+	}, []);
+}
+
+function runOnDirs (fn) {
+	fs.readdirSync(".", "utf8")
+		.filter(dir => isDirectory(dir) && !dir.startsWith(".") && !dir.startsWith("_") && dir !== "node_modules")
+		.forEach(dir => fn(dir));
+}
+
+function mkDirs (pathToCreate) {
+	pathToCreate
+		.split(/[\\/]/g)
+		.reduce((currentPath, folder) => {
+			currentPath += `${folder}/`;
+			if (!fs.existsSync(currentPath)) {
+				fs.mkdirSync(currentPath);
+			}
+			return currentPath;
+		}, "");
+}
+
+export {
+	readJSON,
+	listJsonFiles,
+	runOnDirs,
+	mkDirs,
+};

package/lib/UtilMisc.js

@@ -0,0 +1,22 @@
+function _taggedConsole (fn, tag, ...args) {
+	const expandedTag = tag.padStart(12, " ");
+	fn(`[${expandedTag}]`, ...args);
+}
+
+function warn (tag, ...args) {
+	_taggedConsole(console.warn, tag, ...args);
+}
+
+function info (tag, ...args) {
+	_taggedConsole(console.info, tag, ...args);
+}
+
+function error (tag, ...args) {
+	_taggedConsole(console.error, tag, ...args);
+}
+
+export {
+	warn,
+	info,
+	error,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.1.2",
+	"version": "0.1.5",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -11,7 +11,9 @@
 		"lib": "./lib"
 	},
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"test": "npm run test:js",
+		"test:js": "eslint lib",
+		"lint:js": "eslint lib --fix"
 	},
 	"repository": {
 		"type": "git",

package/lib/HelloWorld.js

@@ -1,3 +0,0 @@
-export const helloWorld = () => {
-	console.log("Hello world!");
-};