5etools-utils 0.15.17 → 0.16.0

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/bin/lint-js-changed.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import {Command} from "commander";
+import {pDoLintJsChanged} from "../lib/Lint/LintJsChanged.js";
+
+const program = new Command()
+	.option("--additional-root <path...>", "Additional git root to scan for changed files")
+;
+
+program.parse(process.argv);
+const opts = program.opts();
+
+const isSuccess = await pDoLintJsChanged({
+	additionalRoots: opts.additionalRoot?.length ? opts.additionalRoot : null,
+});
+
+if (!isSuccess) process.exit(1);

package/lib/Lint/LintJsChanged.js

@@ -0,0 +1,33 @@
+import fs from "fs";
+import {ESLint} from "eslint";
+import {pGetModifiedFiles} from "../UtilGit.js";
+
+/**
+ * @see https://eslint.org/docs/latest/integrate/nodejs-api
+ */
+export const pDoLintJsChanged = async ({additionalRoots = null} = {}) => {
+	const fileList = (await pGetModifiedFiles({additionalRoots}))
+		.filter(file => /\.(js|cjs|mjs)$/.test(file) && fs.existsSync(file));
+
+	if (!fileList.length) {
+		console.warn(`Nothing to lint!`);
+		return true;
+	}
+
+	console.log(`Linting:\n${fileList.map(it => `\t${it}`).join("\n")}`);
+
+	const eslint = new ESLint({
+		fix: true,
+	});
+
+	const results = await eslint.lintFiles(fileList);
+
+	await ESLint.outputFixes(results);
+
+	const formatter = await eslint.loadFormatter("stylish");
+	const resultText = formatter.format(results);
+
+	if (resultText) console.log(resultText);
+
+	return !results.some(res => res.errorCount);
+};

package/lib/UtilGit.js

@@ -0,0 +1,39 @@
+import fs from "fs";
+import simpleGit from "simple-git";
+
+const pGetDiffSummaryFiles = async ({dir = null} = {}) => {
+	const git = dir ? simpleGit(dir) : simpleGit();
+
+	const filesUnstaged = (await git.diffSummary()).files
+		.map(file => file.file);
+	const filesStaged = (await git.diffSummary(["--staged"])).files
+		.map(file => file.file);
+
+	return Object.keys(
+		Object.fromEntries(
+			[...filesStaged, ...filesUnstaged]
+				.map(file => [dir ? `${dir}/${file}` : file, true]),
+		),
+	);
+};
+
+/**
+ * @param {?Array<string>} additionalRoots
+ */
+export const pGetModifiedFiles = async ({additionalRoots = null} = {}) => {
+	return [
+		...await pGetDiffSummaryFiles(),
+
+		...(
+			await Promise.all(
+				(additionalRoots || [])
+					.map(async altDir => {
+						return fs.existsSync(altDir)
+							? pGetDiffSummaryFiles({dir: altDir})
+							: [];
+					}),
+			)
+		)
+			.flat(),
+	];
+};

package/lib/eslint/eslint-plugin-jquery.js

@@ -0,0 +1,49 @@
+export default {
+	meta: {
+		name: "vet-jquery",
+		version: "1.0.0",
+	},
+
+	rules: {
+		"jquery": {
+			meta: {
+				type: "problem",
+				docs: {
+					description: "likely jQuery usage",
+				},
+				schema: [
+					{
+						type: "object",
+						properties: {
+							isFlagOnly: {
+								type: "boolean",
+							},
+						},
+						additionalProperties: false,
+					},
+				],
+			},
+			create (context) {
+				const [{isFlagOnly = false} = {}] = context.options;
+
+				let isAnyFound = false;
+				return {
+					"Identifier": node => {
+						if (
+							node.name === "jQuery"
+							|| node.name.includes("$")
+						) {
+							if (isAnyFound && isFlagOnly) return;
+							isAnyFound = true;
+
+							context.report({
+								node: node,
+								message: `likely jQuery usage (${node.name})`,
+							});
+						}
+					},
+				};
+			},
+		},
+	},
+};

package/package.json

@@ -1,10 +1,19 @@
 {
 	"name": "5etools-utils",
-	"version": "0.15.17",
+	"version": "0.16.0",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
+	"exports": {
+		".": "./lib/Api.js",
+		"./eslint": "./lib/eslint/eslint-plugin-jquery.js",
+		"./eslint/*": "./lib/eslint/*",
+		"./lib/*": "./lib/*",
+		"./schema/*": "./schema/*",
+		"./package.json": "./package.json"
+	},
 	"files": [
+		"bin",
 		"lib",
 		"schema"
 	],
@@ -23,7 +32,8 @@
 		"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"
+		"test-img-source-names-ua": "bin/test-img-source-names-ua.js",
+		"lint-js-changed": "bin/lint-js-changed.js"
 	},
 	"scripts": {
 		"build:dangerous:sources": "node node/fetch-5etools-sources.js",
@@ -48,16 +58,16 @@
 		"ajv": "^8.18.0",
 		"ajv-formats": "^3.0.1",
 		"commander": "^14.0.3",
+		"eslint": "^10.0.1",
 		"hasha": "^7.0.0",
 		"he": "^1.2.0",
 		"json-source-map": "^0.6.1",
 		"number-precision": "^1.6.0",
-		"sanitize-html": "^2.17.1"
+		"sanitize-html": "^2.17.1",
+		"simple-git": "^3.32.1"
 	},
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
-		"eslint": "^10.0.1",
-		"jest": "^30.2.0",
-		"simple-git": "^3.32.1"
+		"jest": "^30.2.0"
 	}
 }

package/schema/brew/charcreationoptions.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "charcreationoptions.json",
-	"version": "1.2.8",
+	"version": "1.3.0",
 	"title": "Character Creation Options",
 	"type": "object",
 	"$defs": {
@@ -18,7 +18,7 @@
 				"SG"
 			]
 		},
-		"charoption": {
+		"charoptionData": {
 			"type": "object",
 			"properties": {
 				"name": {
@@ -85,16 +85,167 @@
 					"$ref": "util-foundry.json#/$defs/foundryMergeObject"
 				}
 			},
-			"required": [
-				"name",
-				"entries",
-				"source",
-				"optionType"
-			],
 			"additionalProperties": false
+		},
+		"charoption": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"optionType": {
+							"$comment": "Note that this field supports arbitrary strings for homebrew usage.",
+							"type": "array",
+							"items": {
+								"$ref": "#/$defs/optionType"
+							}
+						},
+						"otherSources": {
+							"$ref": "util.json#/$defs/otherSources"
+						},
+						"referenceSources": {
+							"$ref": "util.json#/$defs/referenceSources"
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						},
+						"prerequisite": {
+							"$ref": "util.json#/$defs/prerequisite"
+						},
+						"fluff": {
+							"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source",
+							"$ref": "util.json#/$defs/fluffObject",
+							"markdownDescription": "This is intended to be used for Homebrew only - site data should include a fluff file per source"
+						},
+						"foundrySystem": {
+							"$ref": "util-foundry.json#/$defs/foundrySystemObject"
+						},
+						"foundryActivities": {
+							"$ref": "util-foundry.json#/$defs/foundryActivitiesArray"
+						},
+						"foundryFlags": {
+							"$ref": "util-foundry.json#/$defs/foundryFlagsObject"
+						},
+						"foundryEffects": {
+							"$ref": "util-foundry.json#/$defs/foundryEffectsArray"
+						},
+						"foundryImg": {
+							"$ref": "util-foundry.json#/$defs/foundryImg"
+						},
+						"foundryAdvice": {
+							"$ref": "entry.json"
+						},
+						"_foundryMerge": {
+							"$ref": "util-foundry.json#/$defs/foundryMergeObject"
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"name",
+						"source",
+						"entries",
+						"optionType"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"optionType": {
+							"$comment": "Note that this field supports arbitrary strings for homebrew usage.",
+							"type": "array",
+							"items": {
+								"$ref": "#/$defs/optionType"
+							}
+						},
+						"otherSources": {
+							"$ref": "util.json#/$defs/otherSources"
+						},
+						"referenceSources": {
+							"$ref": "util.json#/$defs/referenceSources"
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						},
+						"prerequisite": {
+							"$ref": "util.json#/$defs/prerequisite"
+						},
+						"fluff": {
+							"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source",
+							"$ref": "util.json#/$defs/fluffObject",
+							"markdownDescription": "This is intended to be used for Homebrew only - site data should include a fluff file per source"
+						},
+						"foundrySystem": {
+							"$ref": "util-foundry.json#/$defs/foundrySystemObject"
+						},
+						"foundryActivities": {
+							"$ref": "util-foundry.json#/$defs/foundryActivitiesArray"
+						},
+						"foundryFlags": {
+							"$ref": "util-foundry.json#/$defs/foundryFlagsObject"
+						},
+						"foundryEffects": {
+							"$ref": "util-foundry.json#/$defs/foundryEffectsArray"
+						},
+						"foundryImg": {
+							"$ref": "util-foundry.json#/$defs/foundryImg"
+						},
+						"foundryAdvice": {
+							"$ref": "entry.json"
+						},
+						"_foundryMerge": {
+							"$ref": "util-foundry.json#/$defs/foundryMergeObject"
+						},
+						"_copy": {
+							"$ref": "util-copy.json#/$defs/copyBlock_copy_generic"
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"_copy"
+					]
+				}
+			]
 		}
 	},
 	"properties": {
+		"_meta": {
+			"$ref": "util.json#/$defs/metaBlock"
+		},
 		"charoption": {
 			"type": "array",
 			"minItems": 1,
@@ -104,5 +255,8 @@
 			}
 		}
 	},
+	"required": [
+		"charoption"
+	],
 	"additionalProperties": false
 }