5etools-utils 0.15.18 → 0.16.1

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.18",
+	"version": "0.16.1",
 	"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/books.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "books.json",
-	"version": "1.2.19",
+	"version": "1.2.20",
 	"type": "object",
 	"properties": {
 		"book": {
@@ -43,6 +43,7 @@
 							"screen",
 							"organized-play",
 							"recipe",
+							"homecraft",
 							"other"
 						],
 						"markdownDescription": "The group under which this book should be listed in the navbar."

package/schema/brew/fluff-homecrafts.json

@@ -0,0 +1,15 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "fluff-homecrafts.json",
+	"version": "1.0.0",
+	"type": "object",
+	"properties": {
+		"_meta": {
+			"$ref": "util.json#/$defs/metaBlock"
+		},
+		"crochetPatternFluff": {
+			"$ref": "util.json#/$defs/genericFluffArray"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.13.0",
+	"version": "1.14.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -769,6 +769,12 @@
 		"foundryOptionalfeature": {
 			"$ref": "foundry-optionalfeatures.json#/properties/optionalfeature"
 		},
+		"crochetPattern": {
+			"$ref": "homecrafts.json#/properties/crochetPattern"
+		},
+		"crochetPatternFluff": {
+			"$ref": "fluff-homecrafts.json#/properties/crochetPatternFluff"
+		},
 		"psionic": {
 			"$ref": "psionics.json#/properties/psionic"
 		},
@@ -870,8 +876,8 @@
 		}
 	},
 	"additionalProperties": false,
+	"markdownDescription": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. spell or class",
 	"required": [
 		"_meta"
-	],
-	"markdownDescription": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. spell or class"
+	]
 }