5etools-utils 0.15.8 → 0.15.10

package/README.md

@@ -1,13 +1,13 @@
-# 5etools Utils
-
-Available commands:
-
-```
-npx clean-html
-npx test-file-names [--name-regex <regex>]
-npx test-file-contents --img-repo-name <repo> --url-prefix-expected <prefix>
-npx test-json-brew [file] [--dir <dir>]
-npx test-json-ua [file] [--dir <dir>]
-```
-
-And more; see `bin/`.
+# 5etools Utils
+
+Available commands:
+
+```
+npx clean-html
+npx test-file-names [--name-regex <regex>]
+npx test-file-contents --img-repo-name <repo> --url-prefix-expected <prefix>
+npx test-json-brew [file] [--dir <dir>]
+npx test-json-ua [file] [--dir <dir>]
+```
+
+And more; see `bin/`.

package/lib/BrewCleanerHtml.js

@@ -1,13 +1,12 @@
 import {Worker} from "node:worker_threads";
 import fs from "node:fs";
-import os from "node:os";
 import he from "he";
 import sanitizeHtml from "sanitize-html";
 import {getCleanJson} from "./UtilClean.js";
 import {ObjectWalker} from "./ObjectWalker.js";
 import * as Uf from "./UtilFs.js";
 import Um from "./UtilMisc.js";
-import {Deferred, WorkerList} from "./WorkerList.js";
+import {Deferred, WorkerList, getCntWorkers} from "./WorkerList.js";
 
 export class BrewCleanerHtml {
 	static _LOG_TAG = `HTML`;
@@ -107,7 +106,7 @@ export class BrewCleanerHtml {
 	static async pGetErrorsOnDirsWorkers ({isFailFast = false} = {}) {
 		Um.info(this._LOG_TAG, `Testing for HTML...`);
 
-		const cntWorkers = Math.max(1, os.cpus().length - 1);
+		const cntWorkers = getCntWorkers();
 
 		const messages = [];
 

package/lib/TestJson.js

@@ -1,4 +1,3 @@
-import * as os from "os";
 import * as path from "path";
 import * as url from "url";
 import {Worker} from "worker_threads";
@@ -7,7 +6,7 @@ import * as jsonSourceMap from "json-source-map";
 
 import * as Uf from "./UtilFs.js";
 import Um from "./UtilMisc.js";
-import {WorkerList, Deferred} from "./WorkerList.js";
+import {WorkerList, Deferred, getCntWorkers} from "./WorkerList.js";
 import {ObjectWalker} from "./ObjectWalker.js";
 import {UrlUtil} from "./UrlUtil.js";
 import {UtilAjv} from "./UtilAjv.js";
@@ -211,7 +210,7 @@ class JsonTester {
 	async pGetErrorsOnDirsWorkers ({isFailFast = false, fileList = null} = {}) {
 		Um.info(this._tagLog, `Validating JSON against schemas in dir: ${this._dirSchema}`);
 
-		const cntWorkers = Math.max(1, os.cpus().length - 1);
+		const cntWorkers = getCntWorkers();
 
 		const errors = [];
 		const errorsFull = [];

package/lib/WorkerList.js

@@ -1,4 +1,6 @@
-class Deferred {
+import os from "node:os";
+
+export class Deferred {
 	constructor () {
 		this._resolve = null;
 		this._reject = null;
@@ -13,7 +15,7 @@ class Deferred {
 	get promise () { return this._promise; }
 }
 
-class WorkerList {
+export class WorkerList {
 	/**
 	 * @param {Array} workers
 	 */
@@ -44,4 +46,4 @@ class WorkerList {
 	get cntAvailableWorkers () { return this._workers.length; }
 }
 
-export {Deferred, WorkerList};
+export const getCntWorkers = () => Math.max(1, os.cpus().length - 1);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.15.8",
+	"version": "0.15.10",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",

package/schema/brew/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,16 +315,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -381,6 +371,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/brew/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/brew-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,16 +313,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -379,6 +369,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/brew-fast/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/site/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,16 +315,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -381,6 +371,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/site/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/site-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,16 +313,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -379,6 +369,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/site-fast/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/ua/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,16 +315,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -381,6 +371,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/ua/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/ua-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,16 +313,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -379,6 +369,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/ua-fast/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [