v1.198.1

2025-10-28 20:45:35 -05:00 · 2024-01-01 19:34:49 +00:00
parent 332769043f
commit 8117ebddc5
1748 changed files with 2544409 additions and 1 deletions
--- a/test/test-pagenumbers.js
+++ b/test/test-pagenumbers.js
@@ -0,0 +1,146 @@
+import * as ut from "../node/util.js";
+import * as rl from "readline-sync";
+import * as fs from "fs";
+import "../js/parser.js";
+import "../js/utils.js";
+
+const BLOCKLIST_FILE_PREFIXES = [
+	...ut.FILE_PREFIX_BLOCKLIST,
+	"fluff-",
+
+	// specific files
+	"makebrew-creature.json",
+	"makecards.json",
+	"foundry.json",
+	"characters.json",
+];
+
+const BLOCKLIST_KEYS = new Set([
+	"_meta",
+	"data",
+	"itemProperty",
+	"itemEntry",
+	"lifeClass",
+	"lifeBackground",
+	"lifeTrinket",
+	"cr",
+	"monsterfeatures",
+	"adventure",
+	"book",
+	"itemTypeAdditionalEntries",
+	"legendaryGroup",
+	"languageScript",
+	"dragonMundaneItems",
+]);
+
+const BLOCKLIST_SOURCES = new Set([
+	// region Sources which only exist in digital form
+	Parser.SRC_DC,
+	Parser.SRC_SLW,
+	Parser.SRC_SDW,
+	Parser.SRC_VD,
+	Parser.SRC_HAT_TG,
+	Parser.SRC_HAT_LMI,
+	Parser.SRC_LK,
+	Parser.SRC_AATM,
+	Parser.SRC_HFStCM,
+
+	// N.b.: other MCV source creatures mysteriously have page numbers on Beyond
+	Parser.SRC_MCV4EC,
+	// endregion
+
+	// region Sources which are screens, and therefore "pageless"
+	Parser.SRC_SCREEN,
+	Parser.SRC_SCREEN_WILDERNESS_KIT,
+	Parser.SRC_SCREEN_DUNGEON_KIT,
+	Parser.SRC_SCREEN_SPELLJAMMER,
+	// endregion
+]);
+
+const SUB_KEYS = {};
+
+function run ({isModificationMode = false} = {}) {
+	console.log(`##### Checking for Missing Page Numbers #####`);
+	const FILE_MAP = {};
+	const files = ut.listFiles({dir: `./data`, blocklistFilePrefixes: BLOCKLIST_FILE_PREFIXES});
+	files
+		.forEach(file => {
+			let mods = 0;
+
+			const json = ut.readJson(file);
+			Object.keys(json)
+				.filter(k => !BLOCKLIST_KEYS.has(k))
+				.forEach(k => {
+					const data = json[k];
+					if (data instanceof Array) {
+						const noPage = data
+							.filter(it => !BLOCKLIST_SOURCES.has(SourceUtil.getEntitySource(it)))
+							.filter(it => !(it.inherits ? it.inherits.page : it.page))
+							.filter(it => !it._copy?._preserve?.page);
+
+						const subKeys = SUB_KEYS[k];
+						if (subKeys) {
+							subKeys.forEach(sk => {
+								data
+									.filter(it => it[sk] && it[sk] instanceof Array)
+									.forEach(it => {
+										const subArr = it[sk];
+										subArr
+											.forEach(subIt => subIt.source = subIt.source || it.source);
+										noPage.push(...subArr
+											// Skip un-named entries, as these are usually found on the page of their parent
+											.filter(subIt => subIt.name)
+											.filter(subIt => !BLOCKLIST_SOURCES.has(subIt.source))
+											.filter(subIt => !subIt.page));
+									});
+							});
+						}
+
+						if (noPage.length && isModificationMode) {
+							console.log(`${file}:`);
+							console.log(`\t${noPage.length} missing page number${noPage.length === 1 ? "" : "s"}`);
+						}
+
+						noPage
+							.forEach(it => {
+								const ident = `${k.padEnd(20, " ")} ${SourceUtil.getEntitySource(it).padEnd(32, " ")} ${it.name}`;
+								if (isModificationMode) {
+									console.log(`  ${ident}`);
+									const page = rl.questionInt("  - Page = ");
+									if (page) {
+										it.page = page;
+										mods++;
+									}
+								} else {
+									const list = (FILE_MAP[file] = FILE_MAP[file] || []);
+									list.push(ident);
+								}
+							});
+					}
+				});
+
+			if (mods > 0) {
+				let answer = "";
+				while (!["y", "n", "quit"].includes(answer)) {
+					answer = rl.question(`Save file with ${mods} modification${mods === 1 ? "" : "s"}? [y/n/quit]`);
+					if (answer === "y") {
+						console.log(`Saving ${file}...`);
+						fs.writeFileSync(file, CleanUtil.getCleanJson(json), "utf-8");
+					} else if (answer === "quit") {
+						process.exit(1);
+					}
+				}
+			}
+		});
+
+	const filesWithMissingPages = Object.keys(FILE_MAP);
+	if (filesWithMissingPages.length) {
+		console.warn(`##### Files with Missing Page Numbers #####`);
+		filesWithMissingPages.forEach(f => {
+			console.warn(`${f}:`);
+			FILE_MAP[f].forEach(it => console.warn(`\t${it}`));
+		});
+	} else console.log(`Page numbers are as expected.`);
+}
+
+run();