5etools-utils 0.12.77 → 0.13.0

package/bin/test-file-locations.js

@@ -2,4 +2,4 @@
 
 import {BrewTester} from "../lib/BrewTester.js";
 
-BrewTester.testFileLocations();
+await BrewTester.pTestFileLocations();

package/bin/test-file-names.js

@@ -2,4 +2,4 @@
 
 import {BrewTester} from "../lib/BrewTester.js";
 
-BrewTester.testFileNames();
+await BrewTester.pTestFileNames();

package/bin/test-file-props.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {BrewTester} from "../lib/BrewTester.js";
+
+await BrewTester.pTestFileProps();

package/bin/test-json-brew.js

@@ -1,5 +1,18 @@
 #!/usr/bin/env node
 
 import {BrewTester} from "../lib/BrewTester.js";
+import {Command} from "commander";
 
-BrewTester.pTestJson(process.argv);
+const program = new Command()
+	.argument("[file]", "File to test")
+	.option("--dir <dir>", "Directory to test")
+;
+
+program.parse(process.argv);
+const opts = program.opts();
+
+await BrewTester.pTestJson({
+	mode: "brew",
+	filepath: program.args[0],
+	dir: opts.dir,
+});

package/bin/test-json-ua.js

@@ -1,5 +1,18 @@
 #!/usr/bin/env node
 
 import {BrewTester} from "../lib/BrewTester.js";
+import {Command} from "commander";
 
-BrewTester.pTestJson(process.argv, {mode: "ua"});
+const program = new Command()
+	.argument("[file]", "File to test")
+	.option("--dir <dir>", "Directory to test")
+;
+
+program.parse(process.argv);
+const opts = program.opts();
+
+await BrewTester.pTestJson({
+	mode: "ua",
+	filepath: program.args[0],
+	dir: opts.dir,
+});

package/lib/BrewCleaner.js

@@ -93,12 +93,21 @@ class _BrewFileTester {
 		},
 	];
 
+	static _ALL_CORPUS_IDS_LOWER = new Set();
+
 	static _testFile_publicationTuples ({ALL_ERRORS, file, contents}) {
 		this._PROP_PUBLICATION_PAIRS
 			.forEach(({propContents, propData}) => {
 				const idsContents = new Set((contents[propContents] || []).map(it => it.id));
 				const idsData = new Set((contents[propData] || []).map(it => it.id));
 
+				const idsCombined = new Set([...idsContents, ...idsData]);
+				const duplicateCorpusIds = [...idsCombined].filter(src => this._ALL_CORPUS_IDS_LOWER.has(src.toLowerCase()));
+				if (duplicateCorpusIds.length) {
+					ALL_ERRORS.push(`${file} :: "${propContents}"/"${propData}" id${duplicateCorpusIds.length === 1 ? "" : "s"} exist in other documents; ids were: ${duplicateCorpusIds.map(id => `"${id}"`).join(", ")}`);
+				}
+				duplicateCorpusIds.forEach(id => this._ALL_CORPUS_IDS_LOWER.add(id.toLowerCase()));
+
 				if (MiscUtil.setEq(idsContents, idsData)) return;
 
 				const lstContents = [...idsContents].sort((a, b) => a.localeCompare(b, {sensitivity: "base"}));

package/lib/BrewIndexGenerator.js

@@ -114,50 +114,6 @@ class _BrewIndexAdventureBookIds extends _BrewIndex {
 }
 
 class BrewIndexGenerator {
-	static _DIR_TO_PRIMARY_PROP = {
-		"creature": [
-			"monster",
-		],
-		"book": [
-			"book",
-			"bookData",
-		],
-		"adventure": [
-			"adventure",
-			"adventureData",
-		],
-		"makebrew": [
-			"makebrewCreatureTrait",
-		],
-	};
-
-	static _checkFileContents () {
-		Um.info(`PROP_CHECK`, `Checking file contents...`);
-		const results = [];
-		Uf.runOnDirs((dir) => {
-			if (dir === "collection") return;
-
-			Um.info(`PROP_CHECK`, `Checking dir "${dir}"...`);
-			const dirFiles = fs.readdirSync(dir, "utf8")
-				.filter(file => file.endsWith(".json"));
-
-			dirFiles.forEach(file => {
-				const json = JSON.parse(fs.readFileSync(`${dir}/${file}`, "utf-8"));
-				const props = this._DIR_TO_PRIMARY_PROP[dir] || [dir];
-				props.forEach(prop => {
-					if (!json[prop]) results.push(`${dir}/${file} was missing a "${prop}" property!`);
-				});
-			});
-		});
-
-		if (results.length) {
-			results.forEach(r => Um.error(`PROP_CHECK`, r));
-			throw new Error(`${results.length} file${results.length === 1 ? " was missing a primary prop!" : "s were missing primary props!"} See above for more info.`);
-		}
-
-		Um.info(`PROP_CHECK`, `Complete.`);
-	}
-
 	static _buildDeepIndex () {
 		const indexes = [
 			new _BrewIndexTimestamps(),
@@ -196,7 +152,6 @@ class BrewIndexGenerator {
 	}
 
 	static run () {
-		this._checkFileContents();
 		this._buildDeepIndex();
 		Um.info(`INDEX`, `Complete.`);
 		return null;

package/lib/BrewTester/BrewTesterBase.js

@@ -0,0 +1,25 @@
+import Um from "../UtilMisc.js";
+
+/**
+ * @abstract
+ */
+export class BrewTesterBase {
+	_LOG_TAG;
+
+	async pRun () {
+		const tStart = Date.now();
+		try {
+			await this._pRun();
+		} finally {
+			const duration = Date.now() - tStart;
+			Um.info(this._LOG_TAG, `Ran in ${(duration / 1000).toFixed(2)}s`);
+		}
+	}
+
+	/**
+	 * @abstract
+	 */
+	async _pRun () {
+		throw new Error("Unimplemented!");
+	}
+}

package/lib/BrewTester/BrewTesterFileLocations.js

@@ -0,0 +1,25 @@
+import Um from "../UtilMisc.js";
+import fs from "fs";
+import {BrewTesterBase} from "./BrewTesterBase.js";
+
+export class BrewTesterFileLocations extends BrewTesterBase {
+	static _ROOT_JSON_FILES = new Set([
+		"package.json",
+		"package-lock.json",
+	]);
+
+	_LOG_TAG = `FILES_ROOT`;
+
+	async _pRun () {
+		Um.info(this._LOG_TAG, `Testing for unwanted JSON files in root dir...`);
+
+		const errors = fs.readdirSync(".", "utf8")
+			.filter(it => it.toLowerCase().endsWith(".json") && !this.constructor._ROOT_JSON_FILES.has(it))
+			.map(it => `Unwanted JSON file in root directory: ${it}`);
+
+		if (!errors.length) return Um.info(this._LOG_TAG, `No unwanted JSON files found.`);
+
+		errors.forEach(it => console.error(it));
+		throw new Error(`Test failed! See above for more info`);
+	}
+}

package/lib/BrewTester/BrewTesterFileNames.js

@@ -0,0 +1,37 @@
+import Um from "../UtilMisc.js";
+import * as Uf from "../UtilFs.js";
+import fs from "fs";
+import {BrewTesterBase} from "./BrewTesterBase.js";
+
+export class BrewTesterFileNames extends BrewTesterBase {
+	_LOG_TAG = `FILE_NAME`;
+
+	static _RE_NAME_FORMAT = /^[^;]+; .+\.json$/;
+
+	async _pRun () {
+		Um.info(this._LOG_TAG, `Testing for incorrect file names...`);
+
+		const errors = [];
+
+		Uf.runOnDirs((dir) => {
+			const filenames = fs.readdirSync(dir);
+
+			errors.push(
+				...filenames
+					.filter(it => !it.endsWith(".json"))
+					.map(it => `File did not have ".json" extension: ${it}`),
+			);
+
+			errors.push(
+				...filenames
+					.filter(it => !this.constructor._RE_NAME_FORMAT.test(it))
+					.map(it => `Filename did not match expected pattern "${this.constructor._RE_NAME_FORMAT.toString()}" extension: ${it}`),
+			);
+		});
+
+		if (!errors.length) return Um.info(this._LOG_TAG, `Files had expected names.`);
+
+		errors.forEach(it => console.error(it));
+		throw new Error(`Test failed! See above for more info`);
+	}
+}

package/lib/BrewTester/BrewTesterFileProps.js

@@ -0,0 +1,53 @@
+import Um from "../UtilMisc.js";
+import * as Uf from "../UtilFs.js";
+import fs from "fs";
+import {BrewTesterBase} from "./BrewTesterBase.js";
+
+export class BrewTesterFileProps extends BrewTesterBase {
+	_LOG_TAG = `PROP_CHECK`;
+
+	static _DIR_TO_PRIMARY_PROP = {
+		"creature": [
+			"monster",
+		],
+		"book": [
+			"book",
+			"bookData",
+		],
+		"adventure": [
+			"adventure",
+			"adventureData",
+		],
+		"makebrew": [
+			"makebrewCreatureTrait",
+		],
+	};
+
+	async _pRun () {
+		Um.info(this._LOG_TAG, `Checking file contents...`);
+
+		const results = [];
+		Uf.runOnDirs((dir) => {
+			if (dir === "collection") return;
+
+			Um.info(this._LOG_TAG, `Checking dir "${dir}"...`);
+			const dirFiles = fs.readdirSync(dir, "utf8")
+				.filter(file => file.endsWith(".json"));
+
+			dirFiles.forEach(file => {
+				const json = JSON.parse(fs.readFileSync(`${dir}/${file}`, "utf-8"));
+				const props = this.constructor._DIR_TO_PRIMARY_PROP[dir] || [dir];
+				props.forEach(prop => {
+					if (!json[prop]) results.push(`${dir}/${file} was missing a "${prop}" property!`);
+				});
+			});
+		});
+
+		if (results.length) {
+			results.forEach(r => Um.error(this._LOG_TAG, r));
+			throw new Error(`${results.length} file${results.length === 1 ? " was missing a primary prop!" : "s were missing primary props!"} See above for more info.`);
+		}
+
+		Um.info(this._LOG_TAG, `Complete.`);
+	}
+}

package/lib/BrewTester/BrewTesterJson.js

@@ -0,0 +1,54 @@
+import {JsonTester} from "../TestJson.js";
+import {listJsonFiles} from "../UtilFs.js";
+import pathlib from "path";
+import fs from "fs";
+import Um from "../UtilMisc.js";
+import {BrewTesterBase} from "./BrewTesterBase.js";
+
+export class BrewTesterJson extends BrewTesterBase {
+	_LOG_TAG = "JSON";
+	_IS_FAIL_SLOW = !!process.env.FAIL_SLOW;
+
+	constructor ({mode, filepath, dir, ...rest}) {
+		super({...rest});
+		this._mode = mode;
+		this._filepath = filepath;
+		this._dir = dir;
+	}
+
+	async _pRun () {
+		const jsonTester = new JsonTester({mode: this._mode, tagLog: this._LOG_TAG, fnGetSchemaId: () => "homebrew.json"});
+		await jsonTester.pInit();
+
+		let results;
+		if (this._filepath) {
+			results = jsonTester.getFileErrors({filePath: this._filepath});
+		} else if (this._dir) {
+			const fileList = listJsonFiles(this._dir)
+				.filter(it => pathlib.basename(it) !== "index.json");
+			results = await jsonTester.pGetErrorsOnDirsWorkers({isFailFast: !this._IS_FAIL_SLOW, fileList: fileList});
+		} else {
+			results = await jsonTester.pGetErrorsOnDirsWorkers({isFailFast: !this._IS_FAIL_SLOW});
+		}
+
+		const {errors, errorsFull, isUnknownError = false} = results;
+
+		if (errors.length) {
+			if (!process.env.CI) {
+				const outDir = fs.existsSync("_test") && fs.lstatSync("_test").isDirectory()
+					? "_test"
+					: ".";
+				fs.writeFileSync(`${outDir}/test-json.error.log`, errorsFull.join("\n\n=====\n\n"));
+			}
+			console.error(`Schema test failed (${errors.length} failure${errors.length === 1 ? "" : "s"}).`);
+			throw new Error(`Test failed! See above for more info`);
+		}
+
+		if (isUnknownError) {
+			console.error(`Unknown error when testing! (See above logs)`);
+			throw new Error(`Test failed! See above for more info`);
+		}
+
+		if (!errors.length) Um.info(this._LOG_TAG, `Schema test passed.`);
+	}
+}

package/lib/BrewTester.js

@@ -1,119 +1,11 @@
-import * as fs from "fs";
-import {Command} from "commander";
-import Um from "./UtilMisc.js";
-import {JsonTester} from "./TestJson.js";
-import {listJsonFiles} from "./UtilFs.js";
-import * as pathlib from "path";
-import * as Uf from "./UtilFs.js";
+import {BrewTesterJson} from "./BrewTester/BrewTesterJson.js";
+import {BrewTesterFileLocations} from "./BrewTester/BrewTesterFileLocations.js";
+import {BrewTesterFileNames} from "./BrewTester/BrewTesterFileNames.js";
+import {BrewTesterFileProps} from "./BrewTester/BrewTesterFileProps.js";
 
-class _BrewTesterJson {
-	static _LOG_TAG = "JSON";
-	static _IS_FAIL_SLOW = !!process.env.FAIL_SLOW;
-
-	static async pRun (args, {mode = "brew"} = {}) {
-		const program = new Command()
-			.argument("[file]", "File to test")
-			.option("--dir <dir>", "Directory to test")
-		;
-
-		program.parse(args);
-		const opts = program.opts();
-
-		const jsonTester = new JsonTester({mode, tagLog: this._LOG_TAG, fnGetSchemaId: () => "homebrew.json"});
-		await jsonTester.pInit();
-
-		let results;
-		if (program.args[0]) {
-			results = jsonTester.getFileErrors({filePath: program.args[0]});
-		} else if (opts.dir) {
-			const fileList = listJsonFiles(opts.dir)
-				.filter(it => pathlib.basename(it) !== "index.json");
-			results = await jsonTester.pGetErrorsOnDirsWorkers({isFailFast: !this._IS_FAIL_SLOW, fileList: fileList});
-		} else {
-			results = await jsonTester.pGetErrorsOnDirsWorkers({isFailFast: !this._IS_FAIL_SLOW});
-		}
-
-		const {errors, errorsFull, isUnknownError = false} = results;
-
-		if (errors.length) {
-			if (!process.env.CI) {
-				const outDir = fs.existsSync("_test") && fs.lstatSync("_test").isDirectory()
-					? "_test"
-					: ".";
-				fs.writeFileSync(`${outDir}/test-json.error.log`, errorsFull.join("\n\n=====\n\n"));
-			}
-			console.error(`Schema test failed (${errors.length} failure${errors.length === 1 ? "" : "s"}).`);
-			process.exit(1);
-		}
-
-		if (isUnknownError) {
-			console.error(`Unknown error when testing! (See above logs)`);
-			process.exit(1);
-		}
-
-		if (!errors.length) Um.info(this._LOG_TAG, `Schema test passed.`);
-	}
-}
-
-class _BrewTesterFileLocations {
-	static _ROOT_JSON_FILES = new Set([
-		"package.json",
-		"package-lock.json",
-	]);
-
-	static _LOG_TAG = `FILES_ROOT`;
-
-	static run () {
-		Um.info(this._LOG_TAG, `Testing for unwanted JSON files in root dir...`);
-
-		const errors = fs.readdirSync(".", "utf8")
-			.filter(it => it.toLowerCase().endsWith(".json") && !this._ROOT_JSON_FILES.has(it))
-			.map(it => `Unwanted JSON file in root directory: ${it}`);
-
-		if (!errors.length) return Um.info(this._LOG_TAG, `No unwanted JSON files found.`);
-
-		errors.forEach(it => console.error(it));
-		process.exit(1);
-	}
-}
-
-class _BrewTesterFileNames {
-	static _LOG_TAG = `FILE_NAME`;
-
-	static _RE_NAME_FORMAT = /^[^;]+; .+\.json$/;
-
-	static run () {
-		Um.info(this._LOG_TAG, `Testing for incorrect file names...`);
-
-		const errors = [];
-
-		Uf.runOnDirs((dir) => {
-			const filenames = fs.readdirSync(dir);
-
-			errors.push(
-				...filenames
-					.filter(it => !it.endsWith(".json"))
-					.map(it => `File did not have ".json" extension: ${it}`),
-			);
-
-			errors.push(
-				...filenames
-					.filter(it => !this._RE_NAME_FORMAT.test(it))
-					.map(it => `Filename did not match expected pattern "${this._RE_NAME_FORMAT.toString()}" extension: ${it}`),
-			);
-		});
-
-		if (!errors.length) return Um.info(this._LOG_TAG, `Files had expected names.`);
-
-		errors.forEach(it => console.error(it));
-		process.exit(1);
-	}
+export class BrewTester {
+	static async pTestJson ({mode, filepath, dir}) { return (new BrewTesterJson({mode, filepath, dir})).pRun(); }
+	static pTestFileLocations () { return (new BrewTesterFileLocations()).pRun(); }
+	static pTestFileNames () { return (new BrewTesterFileNames()).pRun(); }
+	static pTestFileProps () { return (new BrewTesterFileProps()).pRun(); }
 }
-
-class BrewTester {
-	static async pTestJson (args, opts) { return _BrewTesterJson.pRun(args, opts); }
-	static testFileLocations () { return _BrewTesterFileLocations.run(); }
-	static testFileNames () { return _BrewTesterFileNames.run(); }
-}
-
-export {BrewTester};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.12.77",
+	"version": "0.13.0",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -15,7 +15,8 @@
 		"test-json-brew": "bin/test-json-brew.js",
 		"test-json-ua": "bin/test-json-ua.js",
 		"test-file-names": "bin/test-file-names.js",
-		"test-file-locations": "bin/test-file-locations.js"
+		"test-file-locations": "bin/test-file-locations.js",
+		"test-file-props": "bin/test-file-props.js"
 	},
 	"scripts": {
 		"build:dangerous:sources": "node node/fetch-5etools-sources.js",

package/schema/brew/adventures.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "adventures.json",
-	"version": "1.10.24",
+	"version": "1.10.25",
 	"type": "object",
 	"properties": {
 		"adventure": {
@@ -18,8 +18,7 @@
 						"$ref": "util.json#/$defs/alias"
 					},
 					"id": {
-						"type": "string",
-						"description": "An ID that will be used to refer to this adventure in tags."
+						"$ref": "util.json#/$defs/corpusId"
 					},
 					"source": {
 						"$ref": "util.json#/$defs/source"

package/schema/brew/books.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "books.json",
-	"version": "1.2.13",
+	"version": "1.2.14",
 	"type": "object",
 	"properties": {
 		"book": {
@@ -18,8 +18,7 @@
 						"$ref": "util.json#/$defs/alias"
 					},
 					"id": {
-						"type": "string",
-						"description": "An ID that will be used to refer to this book in tags."
+						"$ref": "util.json#/$defs/corpusId"
 					},
 					"source": {
 						"$ref": "util.json#/$defs/source"

package/schema/brew/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.10.29",
+	"version": "1.10.30",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -10,7 +10,7 @@
 				"type": "object",
 				"properties": {
 					"id": {
-						"type": "string"
+						"$ref": "util.json#/$defs/corpusId"
 					},
 					"source": {
 						"$ref": "util.json#/$defs/source"

package/schema/brew/sources-5etools.json

@@ -8,15 +8,15 @@
 		"sources": {
 			"type": "string",
 			"enum": [
-				"CoS",
+				"PHB",
 				"DMG",
+				"MM",
+				"CoS",
 				"EEPC",
 				"EET",
 				"HotDQ",
 				"LMoP",
-				"MM",
 				"OotA",
-				"PHB",
 				"PotA",
 				"RoT",
 				"RoTOS",
@@ -114,17 +114,21 @@
 				"VEoR",
 				"GHLoE",
 				"DoDk",
-				"HWCS",
-				"HWAitW",
 				"ToB1-2023",
+				"XPHB",
+				"XDMG",
+				"XMM",
 				"TD",
 				"Screen",
 				"ScreenWildernessKit",
 				"ScreenDungeonKit",
 				"ScreenSpelljammer",
+				"XScreen",
 				"HF",
 				"HFFotM",
 				"HFStCM",
+				"PaF",
+				"HFDoMM",
 				"CM",
 				"NRH",
 				"NRH-TCMC",
@@ -146,6 +150,9 @@
 				"DitLCoT",
 				"VNotEE",
 				"LRDT",
+				"UtHftLH",
+				"ScoEE",
+				"HBTD",
 				"ALCurseOfStrahd",
 				"ALElementalEvil",
 				"ALRageOfDemons",

package/schema/brew/util.json

@@ -3,7 +3,7 @@
 	"$id": "util.json",
 	"title": "Util",
 	"description": "Utility definitions to be used in other schemas.",
-	"version": "1.17.21",
+	"version": "1.17.22",
 	"$defs": {
 		"metaDependenciesArray": {
 			"type": "array",
@@ -55,6 +55,17 @@
 				}
 			]
 		},
+		"corpusId": {
+			"description": "An ID that will be used to refer to this corpus (adventure/book) in tags.",
+			"anyOf": [
+				{
+					"$ref": "#/$defs/_sourceString"
+				},
+				{
+					"$ref": "sources-homebrew-legacy.json#/$defs/sourcesColon"
+				}
+			]
+		},
 		"sourceJson": {
 			"anyOf": [
 				{

package/schema/brew-fast/adventures.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "adventures.json",
-	"version": "1.10.24",
+	"version": "1.10.25",
 	"type": "object",
 	"properties": {
 		"adventure": {
@@ -18,8 +18,7 @@
 						"$ref": "util.json#/$defs/alias"
 					},
 					"id": {
-						"type": "string",
-						"description": "An ID that will be used to refer to this adventure in tags."
+						"$ref": "util.json#/$defs/corpusId"
 					},
 					"source": {
 						"$ref": "util.json#/$defs/source"

package/schema/brew-fast/books.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "books.json",
-	"version": "1.2.13",
+	"version": "1.2.14",
 	"type": "object",
 	"properties": {
 		"book": {
@@ -18,8 +18,7 @@
 						"$ref": "util.json#/$defs/alias"
 					},
 					"id": {
-						"type": "string",
-						"description": "An ID that will be used to refer to this book in tags."
+						"$ref": "util.json#/$defs/corpusId"
 					},
 					"source": {
 						"$ref": "util.json#/$defs/source"