5etools-utils 0.15.4 → 0.15.6

package/README.md

@@ -10,4 +10,4 @@ npx test-json-brew [file] [--dir <dir>]
 npx test-json-ua [file] [--dir <dir>]
 ```
 
-Programmatic: `BrewTester` includes helpers such as `pTestImgDirectories({dirAllowlist, pathImgDir})`.
+And more; see `bin/`.

package/bin/test-img-file-extensions.js

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

package/bin/test-img-file-sizes.js

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

package/bin/test-img-source-names-brew.js

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

package/bin/test-img-source-names-ua.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {BrewTesterImg} from "../lib/BrewTesterImg.js";
+
+await BrewTesterImg.pTestSourceNames({isPrerelease: true});

package/lib/Api.js

@@ -6,6 +6,7 @@ import {BrewCleaner} from "./BrewCleaner.js";
 import {BrewCleanerHtml} from "./BrewCleanerHtml.js";
 import {BrewTimestamper} from "./BrewTimestamper.js";
 import {BrewTester} from "./BrewTester.js";
+import {BrewTesterImg} from "./BrewTesterImg.js";
 import {getCleanJson, getCleanString} from "./UtilClean.js";
 import {DataTester, DataTesterBase, BraceCheck, EscapeCharacterCheck} from "./TestData.js";
 import {ObjectWalker, SymObjectWalkerBreak} from "./ObjectWalker.js";
@@ -20,6 +21,7 @@ export {
 	BrewCleanerHtml,
 	BrewTimestamper,
 	BrewTester,
+	BrewTesterImg,
 	getCleanJson,
 	getCleanString,
 	DataTester,

package/lib/BrewCleaner.js

@@ -158,7 +158,7 @@ export class BrewCleaner {
 			jsonOut = getCleanJson(jsonOut);
 
 			if (isDry) {
-				if (jsonOut !== raw) ALL_ERRORS.push(`${file} would be reformatted!`);
+				if (jsonOut !== raw) Um.warn(`CLEANER`, `"${file}" would be reformatted!`);
 				continue;
 			}
 
@@ -170,27 +170,19 @@ export class BrewCleaner {
 			throw new Error(`Errors were found. See above.`);
 		}
 
-		return {cntFiles: files.length, cntErrors: ALL_ERRORS.length};
+		return files.length;
 	}
 
 	static run ({isDry = false} = {}) {
 		const tStart = Date.now();
 
 		let ttlFiles = 0;
-		let ttlErrors = 0;
 
 		Uf.runOnDirs((dir) => {
 			Um.info(`CLEANER`, `${isDry ? "Checking" : "Cleaning"} dir "${dir}"...`);
-			const {cntFiles, cntErrors} = this._cleanFolder({dir, isDry});
-			ttlFiles += cntFiles;
-			ttlErrors += cntErrors;
+			ttlFiles += this._cleanFolder({dir, isDry});
 		});
 
 		Um.info(`CLEANER`, `${isDry ? "Check" : "Cleaning"} complete. ${isDry ? "Checked" : "Cleaned"} ${ttlFiles} file${ttlFiles === 1 ? "" : "s"}. Ran in ${((Date.now() - tStart) / 1000).toFixed(2)}s.`);
-
-		if (ttlErrors && isDry) {
-			Um.info(`CLEANER`, `Found ${ttlErrors} error${ttlErrors === 1 ? "" : "s"}!`);
-			process.exit(1);
-		}
 	}
 }

package/lib/BrewTesterImg/BrewTesterImgConsts.js

@@ -0,0 +1,31 @@
+export const IMG_SOURCE_DIRS = [
+	"font",
+	"img",
+	"pdf",
+];
+
+export const IMG_ALLOWED_EXTENSIONS = {
+	"audio": new Set([
+		"mp3",
+		"wav",
+	]),
+	"font": new Set([
+		"otf",
+		"ttf",
+		"woff",
+		"woff2",
+	]),
+	"img": new Set([
+		"gif",
+		"jpeg",
+		"jpg",
+		"png",
+		"svg",
+		"webp",
+	]),
+	"pdf": new Set([
+		"pdf",
+	]),
+};
+
+export const MAX_IMG_FILE_SIZE_BYTES = 25 * 1024 * 1024;

package/lib/BrewTesterImg/BrewTesterImgFileExtensions.js

@@ -0,0 +1,34 @@
+import fs from "node:fs";
+import {lsRecursiveSync} from "../UtilFs.js";
+import Um from "../UtilMisc.js";
+import {BrewTesterBase} from "../BrewTester/BrewTesterBase.js";
+import {IMG_ALLOWED_EXTENSIONS} from "./BrewTesterImgConsts.js";
+
+export class BrewTesterImgFileExtensions extends BrewTesterBase {
+	_LOG_TAG = "FILE_EXT";
+
+	constructor ({allowedExtensions = null} = {}) {
+		super();
+		this._allowedExtensions = allowedExtensions || IMG_ALLOWED_EXTENSIONS;
+	}
+
+	async _pRun () {
+		Um.info(this._LOG_TAG, `Testing for incorrect file extensions...`);
+
+		const badPaths = Object.entries(this._allowedExtensions)
+			.flatMap(([dirName, allowedExts]) => {
+				if (!fs.existsSync(dirName) || !fs.statSync(dirName).isDirectory()) return [];
+
+				return lsRecursiveSync(dirName)
+					.filter(filePath => {
+						const ext = filePath.split(".").at(-1).toLowerCase();
+						return !allowedExts.has(ext);
+					});
+			});
+
+		if (!badPaths.length) return Um.info(this._LOG_TAG, `Files had expected extensions.`);
+
+		badPaths.forEach(filePath => Um.error(this._LOG_TAG, `File extension not in allowlist: ${filePath}`));
+		throw new Error(`Test failed! See above for more info`);
+	}
+}

package/lib/BrewTesterImg/BrewTesterImgFileSizes.js

@@ -0,0 +1,33 @@
+import fs from "node:fs";
+import {lsRecursiveSync} from "../UtilFs.js";
+import Um from "../UtilMisc.js";
+import {BrewTesterBase} from "../BrewTester/BrewTesterBase.js";
+import {IMG_SOURCE_DIRS, MAX_IMG_FILE_SIZE_BYTES} from "./BrewTesterImgConsts.js";
+
+export class BrewTesterImgFileSizes extends BrewTesterBase {
+	_LOG_TAG = "FILE_SIZE";
+
+	constructor ({dirsSource = null, maxSizeBytes = null} = {}) {
+		super();
+		this._dirsSource = dirsSource || IMG_SOURCE_DIRS;
+		this._maxSizeBytes = maxSizeBytes || MAX_IMG_FILE_SIZE_BYTES;
+	}
+
+	async _pRun () {
+		const maxSizeMb = this._maxSizeBytes / (1024 * 1024);
+		Um.info(this._LOG_TAG, `Testing for file sizes <= ${maxSizeMb} MiB...`);
+
+		const badPaths = this._dirsSource
+			.flatMap(dirName => {
+				if (!fs.existsSync(dirName) || !fs.statSync(dirName).isDirectory()) return [];
+
+				return lsRecursiveSync(dirName)
+					.filter(filePath => fs.statSync(filePath).size > this._maxSizeBytes);
+			});
+
+		if (!badPaths.length) return Um.info(this._LOG_TAG, `Files had expected sizes.`);
+
+		badPaths.forEach(filePath => Um.error(this._LOG_TAG, `File larger than ${maxSizeMb} MiB: ${filePath}`));
+		throw new Error(`Test failed! See above for more info`);
+	}
+}

package/lib/BrewTesterImg/BrewTesterImgSourceNames.js

@@ -0,0 +1,38 @@
+import fs from "node:fs";
+import Um from "../UtilMisc.js";
+import {BrewTesterBase} from "../BrewTester/BrewTesterBase.js";
+import {IMG_SOURCE_DIRS} from "./BrewTesterImgConsts.js";
+import {UtilSource} from "../UtilSource.js";
+
+export class BrewTesterImgSourceNames extends BrewTesterBase {
+	_LOG_TAG = "SRC_NAME";
+
+	constructor ({dirsSource = null, isPrerelease = false} = {}) {
+		super();
+		this._dirsSource = dirsSource || IMG_SOURCE_DIRS;
+		this._isPrerelease = isPrerelease;
+	}
+
+	async _pRun () {
+		const sourceType = this._isPrerelease ? "prerelease" : "homebrew";
+		Um.info(this._LOG_TAG, `Testing for valid ${sourceType} source names...`);
+
+		const fnIsValidSource = this._isPrerelease
+			? UtilSource.isValidPrereleaseSource.bind(UtilSource)
+			: UtilSource.isValidHomebrewSource.bind(UtilSource);
+
+		const badNames = this._dirsSource
+			.flatMap(dirName => {
+				if (!fs.existsSync(dirName) || !fs.statSync(dirName).isDirectory()) return [];
+
+				return fs.readdirSync(dirName)
+					.filter(name => fs.statSync(`${dirName}/${name}`).isDirectory())
+					.filter(name => !fnIsValidSource(name));
+			});
+
+		if (!badNames.length) return Um.info(this._LOG_TAG, `Directory names had expected sources.`);
+
+		badNames.forEach(name => Um.error(this._LOG_TAG, `Invalid ${sourceType} source directory name: ${name}`));
+		throw new Error(`Test failed! See above for more info`);
+	}
+}

package/lib/BrewTesterImg.js

@@ -0,0 +1,9 @@
+import {BrewTesterImgFileExtensions} from "./BrewTesterImg/BrewTesterImgFileExtensions.js";
+import {BrewTesterImgFileSizes} from "./BrewTesterImg/BrewTesterImgFileSizes.js";
+import {BrewTesterImgSourceNames} from "./BrewTesterImg/BrewTesterImgSourceNames.js";
+
+export class BrewTesterImg {
+	static pTestFileExtensions ({allowedExtensions} = {}) { return (new BrewTesterImgFileExtensions({allowedExtensions})).pRun(); }
+	static pTestFileSizes ({dirsSource, maxSizeBytes} = {}) { return (new BrewTesterImgFileSizes({dirsSource, maxSizeBytes})).pRun(); }
+	static pTestSourceNames ({dirsSource, isPrerelease} = {}) { return (new BrewTesterImgSourceNames({dirsSource, isPrerelease})).pRun(); }
+}

package/lib/UtilSource.js

@@ -23,31 +23,76 @@ export class UtilSource {
 	/* -------------------------------------------- */
 
 	static _HOMEBREW_SOURCE_VALIDATOR = null;
+	static _PRERELEASE_SOURCE_VALIDATOR = null;
 
-	static isValidHomebrewSorce (source) {
-		if (!this._HOMEBREW_SOURCE_VALIDATOR) {
-			this._HOMEBREW_SOURCE_VALIDATOR = UtilAjv.getValidator();
-
-			[
-				"util.json",
-				"sources-homebrew-legacy.json",
-				"sources-5etools.json",
-			]
-				.forEach(fname => {
-					this._HOMEBREW_SOURCE_VALIDATOR.addSchema(
-						Uf.readJsonSync(path.join(path.join(__dirname, "..", "schema", "brew", fname))),
-						fname,
-					);
-				});
-
-			this._HOMEBREW_SOURCE_VALIDATOR.addSchema(
-				{
-					"$ref": "util.json#/$defs/sourceJson",
-				},
-				"homebrewSource",
-			);
-		}
-
-		return this._HOMEBREW_SOURCE_VALIDATOR.validate("homebrewSource", source);
+	static _getHomebrewSourceValidator () {
+		if (this._HOMEBREW_SOURCE_VALIDATOR) return this._HOMEBREW_SOURCE_VALIDATOR;
+
+		this._HOMEBREW_SOURCE_VALIDATOR = UtilAjv.getValidator();
+
+		[
+			"util.json",
+			"sources-homebrew-legacy.json",
+			"sources-5etools.json",
+		]
+			.forEach(fname => {
+				this._HOMEBREW_SOURCE_VALIDATOR.addSchema(
+					Uf.readJsonSync(path.join(path.join(__dirname, "..", "schema", "brew", fname))),
+					fname,
+				);
+			});
+
+		this._HOMEBREW_SOURCE_VALIDATOR.addSchema(
+			{
+				"$ref": "util.json#/$defs/sourceJson",
+			},
+			"homebrewSource",
+		);
+
+		return this._HOMEBREW_SOURCE_VALIDATOR;
+	}
+
+	static _getPrereleaseSourceValidator () {
+		if (this._PRERELEASE_SOURCE_VALIDATOR) return this._PRERELEASE_SOURCE_VALIDATOR;
+
+		this._PRERELEASE_SOURCE_VALIDATOR = UtilAjv.getValidator();
+
+		[
+			"util.json",
+		]
+			.forEach(fname => {
+				this._PRERELEASE_SOURCE_VALIDATOR.addSchema(
+					Uf.readJsonSync(path.join(path.join(__dirname, "..", "schema", "brew", fname))),
+					fname,
+				);
+			});
+
+		this._PRERELEASE_SOURCE_VALIDATOR.addSchema(
+			{
+				"type": "string",
+				"allOf": [
+					{
+						"$ref": "util.json#/$defs/_sourceString",
+					},
+					{
+						"minLength": 6,
+					},
+					{
+						"pattern": "^(?:UA|XUA)[-a-zA-Z0-9&+!]+$",
+					},
+				],
+			},
+			"prereleaseSource",
+		);
+
+		return this._PRERELEASE_SOURCE_VALIDATOR;
+	}
+
+	static isValidHomebrewSource (source) {
+		return this._getHomebrewSourceValidator().validate("homebrewSource", source);
+	}
+
+	static isValidPrereleaseSource (source) {
+		return this._getPrereleaseSourceValidator().validate("prereleaseSource", source);
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.15.4",
+	"version": "0.15.6",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -19,7 +19,11 @@
 		"test-file-names": "bin/test-file-names.js",
 		"test-file-locations": "bin/test-file-locations.js",
 		"test-file-props": "bin/test-file-props.js",
-		"test-edition-sources": "bin/test-edition-sources.js"
+		"test-edition-sources": "bin/test-edition-sources.js",
+		"test-img-file-extensions": "bin/test-img-file-extensions.js",
+		"test-img-file-sizes": "bin/test-img-file-sizes.js",
+		"test-img-source-names-brew": "bin/test-img-source-names-brew.js",
+		"test-img-source-names-ua": "bin/test-img-source-names-ua.js"
 	},
 	"scripts": {
 		"build:dangerous:sources": "node node/fetch-5etools-sources.js",