5etools-mirror-2.github.io/test/test-images.js

import fs from "fs";
import path from "path";
import "../js/parser.js";
import "../js/utils.js";
import * as ut from "../node/util.js";
import {listFiles} from "../node/util.js";

class _TestTokenImages {
	static _IS_CLEAN_EXTRAS = false;
	static _IS_MOVE_EXTRAS = false;
	static _SOURCES_CLEAN_EXTRAS = [
		Parser.SRC_MM,
		Parser.SRC_MPMM,
		Parser.SRC_BAM,
		Parser.SRC_VRGR,
	];

	static _PATH_BASE = `./img/bestiary/tokens`;
	static _EXT = "webp";

	static _IGNORED_PREFIXES = [
		".",
		"_",
	];

	static _expected = new Set();
	static _expectedDirs = {};
	static _existing = new Set();
	static _expectedFromHashToken = {};

	static _existingSourceTokens = null;

	static _isExistingSourceToken ({filename, src}) {
		(this._existingSourceTokens ||= {})[src] ||= fs.readdirSync(`${this._PATH_BASE}/${src}`).mergeMap(it => ({[it]: true}));
		return !!this._existingSourceTokens[src][filename.split("/").last()];
	}

	static _readBestiaryJson () {
		fs.readdirSync("./data/bestiary")
			.filter(file => file.startsWith("bestiary") && file.endsWith(".json"))
			.forEach(file => {
				ut.readJson(`./data/bestiary/${file}`).monster
					.forEach(m => {
						const implicitTokenPath = `${this._PATH_BASE}/${m.source}/${Parser.nameToTokenName(m.name)}.${this._EXT}`;

						if (m.hasToken) this._expectedFromHashToken[implicitTokenPath] = true;

						if (!fs.existsSync(`${this._PATH_BASE}/${m.source}`)) {
							this._expectedDirs[m.source] = true;
							return;
						}

						this._expected.add(implicitTokenPath);

						// add tokens specified as part of variants
						if (m.variant) {
							m.variant
								.filter(it => it.token)
								.forEach(entry => this._expected.add(`${this._PATH_BASE}/${entry.token.source}/${Parser.nameToTokenName(entry.token.name)}.${this._EXT}`));
						}

						// add tokens specified as alt art
						if (m.altArt) {
							m.altArt
								.forEach(alt => this._expected.add(`${this._PATH_BASE}/${alt.source}/${Parser.nameToTokenName(alt.name)}.${this._EXT}`));
						}
					});
			});
	}

	static _readImageDirs () {
		fs.readdirSync(this._PATH_BASE)
			.filter(file => !(this._IGNORED_PREFIXES.some(it => file.startsWith(it))))
			.forEach(dir => {
				fs.readdirSync(`${this._PATH_BASE}/${dir}`)
					.forEach(file => {
						this._existing.add(`${this._PATH_BASE}/${dir.replace("(", "").replace(")", "")}/${file}`);
					});
			});
	}

	static _getIsError () {
		let isError = false;
		const results = [];
		this._expected.forEach((img) => {
			if (!this._existing.has(img)) results.push(`[ MISSING] ${img}`);
		});
		this._existing.forEach((img) => {
			delete this._expectedFromHashToken[img];

			if (!this._expected.has(img)) {
				if (this._IS_CLEAN_EXTRAS) {
					const srcExisting = this._SOURCES_CLEAN_EXTRAS
						.find(src => this._isExistingSourceToken({filename: img, src}));
					if (srcExisting) {
						fs.unlinkSync(img);
						results.push(`[ !DELETE] ${img} (found in "${srcExisting}")`);
						return;
					}
				}

				if (this._IS_MOVE_EXTRAS) {
					const dir = path.join(path.dirname(img), "extras");
					fs.mkdirSync(dir, {recursive: true});
					fs.copyFileSync(img, path.join(dir, path.basename(img)));
					fs.unlinkSync(img);
				}

				results.push(`[   EXTRA] ${img}`);
				isError = true;
			}
		});

		Object.keys(this._expectedDirs).forEach(k => results.push(`Directory ${k} doesn't exist!`));
		results
			.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
			.forEach((img) => console.warn(img));

		if (Object.keys(this._expectedFromHashToken).length) console.warn(`Declared in Bestiary data but not found:`);
		Object.keys(this._expectedFromHashToken).forEach(img => console.warn(`[MISMATCH] ${img}`));

		if (!this._expected.size && !Object.keys(this._expectedFromHashToken).length) console.log("Tokens are as expected.");

		return isError;
	}

	static run () {
		console.log(`##### Reconciling the PNG tokens against the bestiary JSON #####`);

		this._readBestiaryJson();
		this._readImageDirs();

		return this._getIsError();
	}
}

class _TestAdventureBookImages {
	static run () {
		const pathsMissing = [];

		const walker = MiscUtil.getWalker({isNoModification: true});

		const getHandler = (filename, out) => {
			const checkHref = (href) => {
				if (href?.type !== "internal") return;
				if (fs.existsSync(`./img/${href.path}`)) return;
				out.push(`${filename} :: ${href.path}`);
			};

			return (obj) => {
				if (obj.type !== "image") return;
				checkHref(obj.href);
				checkHref(obj.hrefThumbnail);
			};
		};

		listFiles()
			.forEach(filepath => {
				const json = ut.readJson(filepath);
				walker.walk(
					json,
					{
						object: getHandler(filepath, pathsMissing),
					},
				);
			});

		if (pathsMissing.length) {
			console.log(`Missing Images:\n${pathsMissing.map(it => `\t${it}`).join("\n")}`);
			return true;
		}

		console.log(`##### Missing Image Test Passed #####`);
		return false;
	}
}

function main () {
	if (!fs.existsSync("./img")) return true;

	if (_TestTokenImages.run()) return false;
	if (_TestAdventureBookImages.run()) return false;

	return true;
}

export default main();