5etools-utils 0.15.5 → 0.15.7

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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.15.5",
+	"version": "0.15.7",
 	"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.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,6 +315,16 @@
 					},
 					"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",

package/schema/brew-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,6 +313,16 @@
 					},
 					"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",

package/schema/site/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,6 +315,16 @@
 					},
 					"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",

package/schema/site-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,6 +313,16 @@
 					},
 					"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",

package/schema/ua/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,6 +315,16 @@
 					},
 					"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",

package/schema/ua-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.6",
+	"version": "1.11.7",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,6 +313,16 @@
 					},
 					"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",