5etools-utils 0.15.1 → 0.15.3

package/lib/BrewCleaner.js

@@ -131,12 +131,12 @@ export class BrewCleaner {
 	//  - Characters which have significance in a URL
 	static _RE_INVALID_CHARS = /[<>:"/\\|?*#%@]/;
 
-	static _cleanFolder (folder) {
+	static _cleanFolder ({dir, isDry = false}) {
 		const ALL_ERRORS = [];
 
-		const files = Uf.listJsonFiles(folder);
+		const files = Uf.listJsonFiles(dir);
 		for (const file of files) {
-			let contents = Uf.readJsonSync(file);
+			const {raw, json} = Uf.readJsonSync(file, {isIncludeRaw: true});
 
 			if (this._RE_INVALID_CHARS.test(file.split("/").slice(1).join("/"))) {
 				ALL_ERRORS.push(`${file} contained invalid characters!`);
@@ -148,15 +148,21 @@ export class BrewCleaner {
 				if (!this._IS_FAIL_SLOW) break;
 			}
 
-			contents = _BrewFileCleaner.cleanFile({file, contents});
-			_BrewFileTester.testFile({ALL_ERRORS, file, contents});
+			let jsonOut = _BrewFileCleaner.cleanFile({file, contents: json});
+			_BrewFileTester.testFile({ALL_ERRORS, file, contents: jsonOut});
 
 			if (!this._IS_FAIL_SLOW && ALL_ERRORS.length) break;
 
 			Um.info(`CLEANER`, `\t- "${file}"...`);
-			contents = getCleanJson(contents);
 
-			fs.writeFileSync(file, contents);
+			jsonOut = getCleanJson(jsonOut);
+
+			if (isDry) {
+				if (jsonOut !== raw) ALL_ERRORS.push(`${file} would be reformatted!`);
+				continue;
+			}
+
+			fs.writeFileSync(file, jsonOut);
 		}
 
 		if (ALL_ERRORS.length) {
@@ -164,19 +170,27 @@ export class BrewCleaner {
 			throw new Error(`Errors were found. See above.`);
 		}
 
-		return files.length;
+		return {cntFiles: files.length, cntErrors: ALL_ERRORS.length};
 	}
 
-	static run () {
+	static run ({isDry = false} = {}) {
 		const tStart = Date.now();
 
-		let totalFiles = 0;
+		let ttlFiles = 0;
+		let ttlErrors = 0;
 
 		Uf.runOnDirs((dir) => {
-			Um.info(`CLEANER`, `Cleaning dir "${dir}"...`);
-			totalFiles += this._cleanFolder(dir);
+			Um.info(`CLEANER`, `${isDry ? "Checking" : "Cleaning"} dir "${dir}"...`);
+			const {cntFiles, cntErrors} = this._cleanFolder({dir, isDry});
+			ttlFiles += cntFiles;
+			ttlErrors += cntErrors;
 		});
 
-		Um.info(`CLEANER`, `Cleaning complete. Cleaned ${totalFiles} file${totalFiles === 1 ? "" : "s"}. Ran in ${((Date.now() - tStart) / 1000).toFixed(2)}s.`);
+		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.1",
+	"version": "0.15.3",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -39,16 +39,17 @@
 	},
 	"homepage": "https://github.com/TheGiddyLimit/5etools-utils#readme",
 	"dependencies": {
-		"ajv": "^8.12.0",
-		"ajv-formats": "^2.1.1",
-		"commander": "^12.0.0",
-		"hasha": "^6.0.0",
+		"ajv": "^8.18.0",
+		"ajv-formats": "^3.0.1",
+		"commander": "^14.0.3",
+		"hasha": "^7.0.0",
 		"json-source-map": "^0.6.1",
 		"number-precision": "^1.6.0"
 	},
 	"devDependencies": {
-		"eslint": "^8.56.0",
-		"jest": "^29.7.0",
-		"simple-git": "^3.24.0"
+		"@eslint/js": "^10.0.1",
+		"eslint": "^10.0.1",
+		"jest": "^30.2.0",
+		"simple-git": "^3.32.1"
 	}
 }