@getvitops/utils 0.9.0 → 2.0.0

package/dist/index.mjs

@@ -1,4 +1,6 @@
 import { faviconLinks, faviconManifest, generateFavicons, writeFaviconManifest } from "./favicon.mjs";
+import { readFileSync, readdirSync } from "node:fs";
+import { extname, join } from "node:path";
 import { parseFragment, serialize as serialize$1 } from "parse5";
 
 //#region src/content.ts
@@ -327,8 +329,26 @@ const prefixToMapKey = {
 	"fa7-brands": "fa7-brands",
 	"simple-icons": "simple-icons",
 	"material-symbols": "material-symbols",
-	lucide: "lucide"
+	lucide: "lucide",
+	ph: "ph"
 };
+/**
+* Sets whose weights are a name SUFFIX inside one collection rather than
+* separate prefixed collections. Phosphor is the case that forced this:
+* `ph:lightning`, `ph:lightning-bold`, `ph:lightning-fill` all live in `ph`,
+* whereas Font Awesome splits the same idea across `fa7-solid`/`fa7-regular`/…
+* (which is what `prefixToMapKey` collapses).
+*
+* The first entry is the unsuffixed default — asking for it adds nothing.
+*/
+const WEIGHTED_SETS = { ph: [
+	"regular",
+	"bold",
+	"duotone",
+	"fill",
+	"light",
+	"thin"
+] };
 const iconMap = {
 	fa7: {
 		menu: "bars",
@@ -336,12 +356,14 @@ const iconMap = {
 		home: "home",
 		settings: "gear",
 		search: "magnifying-glass",
-		"expand-more": "chevron-down",
-		"expand-less": "chevron-up",
-		"chevron-right": "chevron-right",
 		"chevron-left": "chevron-left",
-		"arrow-back": "arrow-left",
-		"arrow-forward": "arrow-right",
+		"chevron-right": "chevron-right",
+		"chevron-up": "chevron-up",
+		"chevron-down": "chevron-down",
+		"arrow-left": "arrow-left",
+		"arrow-right": "arrow-right",
+		"arrow-up": "arrow-up",
+		"arrow-down": "arrow-down",
 		"external-link": "arrow-up-right-from-square",
 		"more-vert": "ellipsis-vertical",
 		"more-horiz": "ellipsis",
@@ -359,8 +381,8 @@ const iconMap = {
 		bookmark: "bookmark",
 		favorite: "heart",
 		star: "star",
-		login: "login",
-		logout: "logout",
+		login: "right-to-bracket",
+		logout: "right-from-bracket",
 		email: "envelope",
 		phone: "phone",
 		location: "location-dot",
@@ -379,7 +401,7 @@ const iconMap = {
 		image: "image",
 		export: "file-export",
 		import: "file-import",
-		backup: "backup",
+		backup: "cloud-arrow-up",
 		compress: "compress",
 		check: "check",
 		error: "circle-exclamation",
@@ -413,7 +435,8 @@ const iconMap = {
 		print: "print",
 		code: "code",
 		palette: "palette",
-		lightbulb: "lightbulb"
+		lightbulb: "lightbulb",
+		lightning: "bolt"
 	},
 	"fa7-brands": {
 		facebook: "facebook",
@@ -504,12 +527,14 @@ const iconMap = {
 		home: "home",
 		settings: "settings",
 		search: "search",
-		"expand-more": "expand-more",
-		"expand-less": "expand-less",
-		"chevron-right": "chevron-right",
 		"chevron-left": "chevron-left",
-		"arrow-back": "arrow-back",
-		"arrow-forward": "arrow-forward",
+		"chevron-right": "chevron-right",
+		"chevron-up": "expand-less",
+		"chevron-down": "expand-more",
+		"arrow-left": "arrow-back",
+		"arrow-right": "arrow-forward",
+		"arrow-up": "arrow-upward",
+		"arrow-down": "arrow-downward",
 		"external-link": "open-in-new",
 		"more-vert": "more-vert",
 		"more-horiz": "more-horiz",
@@ -581,7 +606,8 @@ const iconMap = {
 		print: "print",
 		code: "code",
 		palette: "palette",
-		lightbulb: "lightbulb"
+		lightbulb: "lightbulb",
+		lightning: "bolt"
 	},
 	lucide: {
 		menu: "menu",
@@ -589,12 +615,14 @@ const iconMap = {
 		home: "house",
 		settings: "settings",
 		search: "search",
-		"expand-more": "chevron-down",
-		"expand-less": "chevron-up",
-		"chevron-right": "chevron-right",
 		"chevron-left": "chevron-left",
-		"arrow-back": "arrow-left",
-		"arrow-forward": "arrow-right",
+		"chevron-right": "chevron-right",
+		"chevron-up": "chevron-up",
+		"chevron-down": "chevron-down",
+		"arrow-left": "arrow-left",
+		"arrow-right": "arrow-right",
+		"arrow-up": "arrow-up",
+		"arrow-down": "arrow-down",
 		"external-link": "external-link",
 		"more-vert": "ellipsis-vertical",
 		"more-horiz": "ellipsis",
@@ -666,7 +694,96 @@ const iconMap = {
 		print: "printer",
 		code: "code",
 		palette: "palette",
-		lightbulb: "lightbulb"
+		lightbulb: "lightbulb",
+		lightning: "zap"
+	},
+	ph: {
+		menu: "list",
+		close: "x",
+		home: "house",
+		settings: "gear",
+		search: "magnifying-glass",
+		"chevron-left": "caret-left",
+		"chevron-right": "caret-right",
+		"chevron-up": "caret-up",
+		"chevron-down": "caret-down",
+		"arrow-left": "arrow-left",
+		"arrow-right": "arrow-right",
+		"arrow-up": "arrow-up",
+		"arrow-down": "arrow-down",
+		"external-link": "arrow-square-out",
+		"more-vert": "dots-three-vertical",
+		"more-horiz": "dots-three",
+		add: "plus",
+		remove: "minus",
+		delete: "trash",
+		edit: "pencil",
+		save: "floppy-disk",
+		copy: "copy",
+		paste: "clipboard",
+		attach: "paperclip",
+		upload: "upload",
+		download: "download",
+		share: "share",
+		bookmark: "bookmark",
+		favorite: "heart",
+		star: "star",
+		login: "sign-in",
+		logout: "sign-out",
+		email: "envelope",
+		phone: "phone",
+		location: "map-pin",
+		globe: "globe",
+		link: "link",
+		clock: "clock",
+		calendar: "calendar",
+		schedule: "calendar-dots",
+		person: "person",
+		group: "users",
+		file: "file",
+		"file-add": "file-plus",
+		folder: "folder",
+		"folder-open": "folder-open",
+		"folder-add": "folder-plus",
+		image: "image",
+		export: "upload-simple",
+		import: "download-simple",
+		backup: "cloud-arrow-up",
+		compress: "arrows-in",
+		check: "check",
+		error: "warning-circle",
+		warning: "warning",
+		info: "info",
+		help: "question",
+		cart: "shopping-cart",
+		tag: "tag",
+		"credit-card": "credit-card",
+		receipt: "receipt",
+		leaf: "leaf",
+		tree: "tree",
+		seedling: "plant",
+		trowel: "shovel",
+		droplet: "drop",
+		snowflake: "snowflake",
+		sun: "sun",
+		cloud: "cloud",
+		grid: "squares-four",
+		list: "list",
+		filter: "funnel",
+		sort: "arrows-down-up",
+		fullscreen: "corners-out",
+		collapse: "corners-in",
+		building: "building",
+		video: "video",
+		lock: "lock",
+		unlock: "lock-open",
+		eye: "eye",
+		"eye-off": "eye-slash",
+		print: "printer",
+		code: "code",
+		palette: "palette",
+		lightbulb: "lightbulb",
+		lightning: "lightning"
 	}
 };
 /**
@@ -674,15 +791,27 @@ const iconMap = {
 * Names containing ':' are returned as-is (pass-through for fully-qualified names).
 *
 * @param name - Semantic name ('email') or fully-qualified ('fa7-solid:envelope')
-* @param prefix - astro-icon prefix, e.g. 'fa7-solid', 'material-symbols', 'lucide'
+* @param prefix - astro-icon prefix, e.g. 'fa7-solid', 'material-symbols', 'lucide', 'ph'
+* @param opts.weight - Weight for suffix-weighted sets (see `WEIGHTED_SETS`), e.g.
+*   `resolveIcon('menu', 'ph', { weight: 'bold' })` → `'ph:list-bold'`. Ignored for
+*   sets that aren't suffix-weighted; an unknown weight throws rather than silently
+*   resolving to the regular glyph, which would be indistinguishable from a typo.
 */
-function resolveIcon(name, prefix) {
+function resolveIcon(name, prefix, opts) {
 	if (name.includes(":")) return name;
 	const mapKey = prefixToMapKey[prefix];
 	if (!mapKey) throw new Error(`Unknown icon prefix "${prefix}". Valid: ${Object.keys(prefixToMapKey).join(", ")}`);
 	const resolved = iconMap[mapKey][name];
 	if (!resolved) throw new Error(`Icon "${name}" not found in set "${prefix}" (map key: "${mapKey}")`);
-	return `${prefix}:${resolved}`;
+	return `${prefix}:${applyWeight(resolved, prefix, opts?.weight)}`;
+}
+/** Append a weight suffix for suffix-weighted sets. The first weight is the bare default. */
+function applyWeight(name, prefix, weight) {
+	if (!weight) return name;
+	const weights = WEIGHTED_SETS[prefix];
+	if (!weights) return name;
+	if (!weights.includes(weight)) throw new Error(`Unknown weight "${weight}" for icon set "${prefix}". Valid: ${weights.join(", ")}.`);
+	return weight === weights[0] ? name : `${name}-${weight}`;
 }
 /**
 * Resolve a brand icon name to a fully-qualified astro-icon string.
@@ -719,7 +848,7 @@ function generateIconInclude(iconsConfig) {
 	const addToInclude = (prefix, names) => {
 		include[prefix] = [...new Set([...include[prefix] ?? [], ...names])];
 	};
-	for (const [key, val] of Object.entries(iconsConfig ?? {})) if (key !== "ui" && key !== "brand" && key !== "semantic" && Array.isArray(val)) addToInclude(key, val);
+	for (const [key, val] of Object.entries(iconsConfig ?? {})) if (key !== "ui" && key !== "brand" && key !== "weight" && key !== "semantic" && Array.isArray(val)) addToInclude(key, val);
 	const uiMapKey = prefixToMapKey[uiPrefix];
 	const brandMapKey = prefixToMapKey[brandPrefix];
 	const unknownPrefix = [];
@@ -730,8 +859,8 @@ function generateIconInclude(iconsConfig) {
 	for (const name of iconsConfig?.semantic ?? []) {
 		const ui = iconMap[uiMapKey][name];
 		const brand = iconMap[brandMapKey][name];
-		if (ui) addToInclude(uiPrefix, [ui]);
-		if (brand) addToInclude(brandPrefix, [brand]);
+		if (ui) addToInclude(uiPrefix, [applyWeight(ui, uiPrefix, iconsConfig?.weight)]);
+		if (brand) addToInclude(brandPrefix, [applyWeight(brand, brandPrefix, iconsConfig?.weight)]);
 		if (!ui && !brand) unresolved.push(name);
 	}
 	if (unresolved.length) throw new Error(`[vitops icons] ${unresolved.length} semantic icon name(s) not found in ui set '${uiPrefix}' or brand set '${brandPrefix}': ${unresolved.join(", ")}.\nEither add them to iconMap in @getvitops/core, or drop them from the \`semantic\` list. Available in '${uiPrefix}': ${Object.keys(iconMap[uiMapKey]).slice(0, 12).join(", ")}…`);
@@ -739,5 +868,216 @@ function generateIconInclude(iconsConfig) {
 }
 
 //#endregion
-export { articleGraph, breadcrumbGraph, faqGraph, faviconLinks, faviconManifest, generateFavicons, generateIconInclude, getAttribute, iconMap, isElmnt, isImageLink, isLink, isTextLink, nodesToHtml, organizationGraph, parseRenderedSlots, partAttrs, prefixToMapKey, resolveBrandIcon, resolveIcon, serialize, styleList, t, toHtml, writeFaviconManifest };
+//#region src/scan.ts
+/**
+* Consumer source discovery.
+*
+* Lifted verbatim out of `@getvitops/cli`, where it was a private helper behind
+* `vitops lint`. It lives here now because a second caller needs it: the Astro
+* integration scans for icon usage during `astro:config:setup`, and it cannot
+* import the CLI — `@getvitops/cli` exposes only a `bin`, and its entry calls
+* `main()` at module scope, so importing it would run the CLI.
+*
+* Deliberately hand-rolled rather than a glob dependency: the whole job is one
+* `readdirSync` recursion with two allow/deny sets, and it runs synchronously
+* inside a config hook where an async glob would have to be awaited anyway.
+*/
+/**
+* Extensions worth scanning: every template language the framework's classes
+* and icon names can appear in, plus the markdown that can embed them.
+*/
+const SCAN_EXT = new Set([
+	".astro",
+	".html",
+	".htm",
+	".js",
+	".jsx",
+	".ts",
+	".tsx",
+	".vue",
+	".svelte",
+	".php",
+	".md",
+	".mdx"
+]);
+/** Directories that only ever hold dependencies or build output. */
+const SCAN_SKIP = new Set([
+	"node_modules",
+	"dist",
+	".git",
+	".astro",
+	"build",
+	"coverage"
+]);
+/**
+* Recursively read every scannable file under `dir`.
+*
+* Dotfiles and dot-directories are skipped wholesale — they hold tooling config,
+* not templates, and `.astro`/`.git` would otherwise be walked twice over.
+*/
+function scanFiles(dir, opts) {
+	const exts = opts?.exts ? new Set(opts.exts) : SCAN_EXT;
+	const skip = opts?.skipDirs ? new Set(opts.skipDirs) : SCAN_SKIP;
+	const acc = [];
+	walk(dir, exts, skip, acc);
+	return acc;
+}
+function walk(dir, exts, skip, acc) {
+	for (const e of readdirSync(dir, { withFileTypes: true })) {
+		if (e.name.startsWith(".") && e.name !== ".") continue;
+		const p = join(dir, e.name);
+		if (e.isDirectory()) {
+			if (!skip.has(e.name)) walk(p, exts, skip, acc);
+		} else if (exts.has(extname(e.name))) acc.push({
+			path: p,
+			text: readFileSync(p, "utf8")
+		});
+	}
+}
+
+//#endregion
+//#region src/icons-scan.ts
+/**
+* Props that carry an icon name. `icon` covers the component convention
+* (`Popover`/`Drawer`/`Details` triggers); the start/end pair covers adornments
+* on links and buttons.
+*/
+const DEFAULT_PROPS = [
+	"icon",
+	"startIcon",
+	"endIcon",
+	"leadingIcon",
+	"trailingIcon"
+];
+/**
+* `<Icon …>` and any capitalised component whose name ends in `Icon`.
+* Requires a capital or the literal `Icon`, so `<iconButton>` and plain HTML
+* never match.
+*/
+const COMPONENT = /<([A-Z][\w.]*Icon|Icon)\b([^>]*?)\/?>/g;
+/** Sprite references: `<use href="…/icons.svg#menu">`, incl. legacy `xlink:href`. */
+const SPRITE_USE = /<use\b[^>]*?\b(?:xlink:)?href\s*=\s*(?:"([^"#]*)#([^"]*)"|'([^'#]*)#([^']*)')/g;
+/**
+* An attribute value: a quoted literal, a braced single literal, or a braced
+* expression. The final alternative is what marks a value as dynamic — it is
+* matched on purpose so the reference can be REPORTED rather than skipped.
+*
+* That last alternative stops at the first `}`, so a reported expression
+* containing its own braces (`{\`a:${b}\`}`) is truncated in the warning text.
+* Deliberate: balancing braces with a regex buys nothing here, because the
+* actionable part of the report is the file and line, not the expression.
+*/
+const VALUE = String.raw`(?:"([^"]*)"|'([^']*)'|\{\s*(?:"([^"]*)"|'([^']*)'|\`([^\`$]*)\`)\s*\}|(\{[^}]*\}))`;
+/**
+* `\b` is not enough of a left boundary here: `-` is a non-word character, so
+* `\bicon` happily matches inside `data-icon=` and `aria-icon=`. Requiring that
+* the previous character be neither a word character nor a hyphen keeps the
+* match to a genuine standalone prop.
+*/
+const LEFT = String.raw`(?<![\w-])`;
+const nameAttr = () => new RegExp(String.raw`${LEFT}name\s*=\s*${VALUE}`);
+const iconProp = (props) => new RegExp(String.raw`${LEFT}(${props.join("|")})\s*=\s*${VALUE}`, "g");
+/** Object-literal form: `trigger={{ icon: 'bars' }}`, or a data array of `{ icon: '…' }`. */
+const iconKey = (props) => new RegExp(String.raw`${LEFT}(${props.join("|")})\s*:\s*(?:"([^"]*)"|'([^']*)'|\`([^\`$]*)\`)`, "g");
+const lineOf = (src, index) => src.slice(0, index).split("\n").length;
+/**
+* Pull the literal out of a VALUE match, or report it as dynamic.
+* Groups run: "double", 'single', {"double"}, {'single'}, {`template`}, {expr}.
+*/
+function readValue(groups) {
+	const [dq, sq, bdq, bsq, btpl, expr] = groups;
+	if (expr !== void 0) return { expr };
+	const literal = dq ?? sq ?? bdq ?? bsq ?? btpl;
+	if (literal === void 0) return {};
+	if (literal.includes("${")) return { expr: literal };
+	return { literal };
+}
+/** Extract every icon reference from one file's text. */
+function extractIconRefs(src, file = "<source>", opts) {
+	const props = [...new Set([...DEFAULT_PROPS, ...opts?.props ?? []])];
+	const refs = [];
+	const dynamic = [];
+	const NAME = nameAttr();
+	for (const m of src.matchAll(COMPONENT)) {
+		const attrs = m[2] ?? "";
+		const hit = NAME.exec(attrs);
+		if (!hit) continue;
+		const line = lineOf(src, m.index);
+		const { literal, expr } = readValue(hit.slice(1));
+		if (literal) refs.push({
+			name: literal,
+			kind: "component",
+			attr: "name",
+			file,
+			line
+		});
+		else if (expr) dynamic.push({
+			expr,
+			attr: "name",
+			file,
+			line
+		});
+	}
+	for (const m of src.matchAll(iconProp(props))) {
+		const line = lineOf(src, m.index);
+		const { literal, expr } = readValue(m.slice(2));
+		if (literal) refs.push({
+			name: literal,
+			kind: "prop",
+			attr: m[1],
+			file,
+			line
+		});
+		else if (expr) dynamic.push({
+			expr,
+			attr: m[1],
+			file,
+			line
+		});
+	}
+	for (const m of src.matchAll(iconKey(props))) {
+		const literal = m[2] ?? m[3] ?? m[4];
+		if (!literal || literal.includes("${")) continue;
+		refs.push({
+			name: literal,
+			kind: "object",
+			attr: m[1],
+			file,
+			line: lineOf(src, m.index)
+		});
+	}
+	for (const m of src.matchAll(SPRITE_USE)) {
+		const id = m[2] ?? m[4];
+		if (!id) continue;
+		refs.push({
+			name: id,
+			kind: "sprite",
+			attr: "href",
+			file,
+			line: lineOf(src, m.index)
+		});
+	}
+	return {
+		refs,
+		dynamic
+	};
+}
+/** Run `extractIconRefs` across a file set and collect unique names. */
+function collectIconRefs(files, opts) {
+	const refs = [];
+	const dynamic = [];
+	for (const f of files) {
+		const r = extractIconRefs(f.text, f.path, opts);
+		refs.push(...r.refs);
+		dynamic.push(...r.dynamic);
+	}
+	return {
+		refs,
+		dynamic,
+		names: [...new Set(refs.map((r) => r.name))]
+	};
+}
+
+//#endregion
+export { SCAN_EXT, SCAN_SKIP, WEIGHTED_SETS, articleGraph, breadcrumbGraph, collectIconRefs, extractIconRefs, faqGraph, faviconLinks, faviconManifest, generateFavicons, generateIconInclude, getAttribute, iconMap, isElmnt, isImageLink, isLink, isTextLink, nodesToHtml, organizationGraph, parseRenderedSlots, partAttrs, prefixToMapKey, resolveBrandIcon, resolveIcon, scanFiles, serialize, styleList, t, toHtml, writeFaviconManifest };
 //# sourceMappingURL=index.mjs.map