@schalkneethling/miyagi-core 4.4.2 → 4.4.4

package/lib/drupal/load-assets-config.js

@@ -2,26 +2,26 @@ import path from "node:path";
 import * as v from "valibot";
 
 const DrupalBlockSchema = v.object({
-	libraries: v.string(),
-	ignorePrefixes: v.optional(v.array(v.string())),
-	mapping: v.optional(v.record(v.string(), v.string())),
-	autoDiscoveryPrefixes: v.optional(v.nullable(v.array(v.string()))),
-	components: v.optional(v.nullable(v.array(v.string()))),
+  libraries: v.string(),
+  ignorePrefixes: v.optional(v.array(v.string())),
+  mapping: v.optional(v.record(v.string(), v.string())),
+  autoDiscoveryPrefixes: v.optional(v.nullable(v.array(v.string()))),
+  components: v.optional(v.nullable(v.array(v.string()))),
 });
 
 const ConfigSchema = v.object({
-	engine: v.picklist(["drupal"]),
-	drupal: DrupalBlockSchema,
+  engine: v.picklist(["drupal"]),
+  drupal: DrupalBlockSchema,
 });
 
 export const NormalizedConfigSchema = v.object({
-	engine: v.string(),
-	libraries: v.optional(v.string()),
-	ignorePrefixes: v.array(v.string()),
-	mapping: v.record(v.string(), v.string()),
-	autoDiscoveryPrefixes: v.nullable(v.array(v.string())),
-	components: v.nullable(v.array(v.string())),
-	dryRun: v.boolean(),
+  engine: v.string(),
+  libraries: v.optional(v.string()),
+  ignorePrefixes: v.array(v.string()),
+  mapping: v.record(v.string(), v.string()),
+  autoDiscoveryPrefixes: v.nullable(v.array(v.string())),
+  components: v.nullable(v.array(v.string())),
+  dryRun: v.boolean(),
 });
 
 /** @typedef {v.InferOutput<typeof NormalizedConfigSchema>} NormalizedConfig */
@@ -38,57 +38,56 @@ export const NormalizedConfigSchema = v.object({
  * @returns {Promise<NormalizedConfig>} normalized config
  */
 export async function loadAssetsConfig(cliArgs) {
-	let fileConfig = null;
+  let fileConfig = null;
 
-	const configPath = cliArgs.config || ".miyagi-assets.js";
+  const configPath = cliArgs.config || ".miyagi-assets.js";
 
-	try {
-		const resolved = path.resolve(configPath);
-		const mod = await import(resolved);
-		fileConfig = mod.default || mod;
-	} catch {
-		if (!cliArgs.libraries) {
-			throw new Error(
-				`Could not load config file "${configPath}" and no --libraries flag provided.`,
-			);
-		}
-	}
+  try {
+    const resolved = path.resolve(configPath);
+    const mod = await import(resolved);
+    fileConfig = mod.default || mod;
+  } catch {
+    if (!cliArgs.libraries) {
+      throw new Error(
+        `Could not load config file "${configPath}" and no --libraries flag provided.`,
+      );
+    }
+  }
 
-	if (fileConfig) {
-		const result = v.safeParse(ConfigSchema, fileConfig);
+  if (fileConfig) {
+    const result = v.safeParse(ConfigSchema, fileConfig);
 
-		if (!result.success) {
-			const messages = result.issues.map((issue) => {
-				const issuePath =
-					issue.path?.map((path) => path.key).join(".") || "root";
-				return `${issuePath}: ${issue.message}`;
-			});
-			throw new Error(`Invalid config: ${messages.join("; ")}`);
-		}
+    if (!result.success) {
+      const messages = result.issues.map((issue) => {
+        const issuePath =
+          issue.path?.map((path) => path.key).join(".") || "root";
+        return `${issuePath}: ${issue.message}`;
+      });
+      throw new Error(`Invalid config: ${messages.join("; ")}`);
+    }
 
-		const { engine } = result.output;
-		const engineBlock = result.output[engine];
+    const { engine } = result.output;
+    const engineBlock = result.output[engine];
 
-		return {
-			engine,
-			libraries: cliArgs.libraries || engineBlock.libraries,
-			ignorePrefixes:
-				cliArgs.ignorePrefixes || engineBlock.ignorePrefixes || [],
-			mapping: engineBlock.mapping || {},
-			autoDiscoveryPrefixes: engineBlock.autoDiscoveryPrefixes ?? null,
-			components:
-				cliArgs.components || engineBlock.components || null,
-			dryRun: cliArgs.dryRun || false,
-		};
-	}
+    return {
+      engine,
+      libraries: cliArgs.libraries || engineBlock.libraries,
+      ignorePrefixes:
+        cliArgs.ignorePrefixes || engineBlock.ignorePrefixes || [],
+      mapping: engineBlock.mapping || {},
+      autoDiscoveryPrefixes: engineBlock.autoDiscoveryPrefixes ?? null,
+      components: cliArgs.components || engineBlock.components || null,
+      dryRun: cliArgs.dryRun || false,
+    };
+  }
 
-	return {
-		engine: cliArgs.engine || "drupal",
-		libraries: cliArgs.libraries,
-		ignorePrefixes: cliArgs.ignorePrefixes || [],
-		mapping: {},
-		autoDiscoveryPrefixes: null,
-		components: cliArgs.components || null,
-		dryRun: cliArgs.dryRun || false,
-	};
+  return {
+    engine: cliArgs.engine || "drupal",
+    libraries: cliArgs.libraries,
+    ignorePrefixes: cliArgs.ignorePrefixes || [],
+    mapping: {},
+    autoDiscoveryPrefixes: null,
+    components: cliArgs.components || null,
+    dryRun: cliArgs.dryRun || false,
+  };
 }

package/lib/drupal/resolve-library-assets.js

@@ -16,41 +16,39 @@ import yaml from "js-yaml";
  * @returns {Record<string, LibraryEntry>}
  */
 export function parseLibrariesYaml(yamlContent) {
-	/**
-	 * @type {Record<string, {
-	 *   css?: Record<string, Record<string, object>>,
-	 *   js?: Record<string, {attributes?: {type?: string}}>,
-	 *   dependencies?: string[]
-	 * }>}
-	 */
-	const raw = /** @type {never} */ (yaml.load(yamlContent));
-	/** @type {Record<string, LibraryEntry>} */
-	const map = {};
-
-	for (const [name, entry] of Object.entries(raw)) {
-		const css = entry.css
-			? Object.values(entry.css).flatMap(Object.keys)
-			: [];
-
-		const js = entry.js
-			? Object.entries(entry.js).map(([src, opts]) =>
-				opts?.attributes?.type
-					? { src, type: opts.attributes.type }
-					: { src },
-			)
-			: [];
-
-		const dependencies = (entry.dependencies || [])
-			.filter((dep) => dep.includes("/"))
-			.map((dep) => ({
-				prefix: dep.slice(0, dep.indexOf("/")),
-				name: dep.slice(dep.indexOf("/") + 1),
-			}));
-
-		map[name] = { css, js, dependencies };
-	}
-
-	return map;
+  /**
+   * @type {Record<string, {
+   *   css?: Record<string, Record<string, object>>,
+   *   js?: Record<string, {attributes?: {type?: string}}>,
+   *   dependencies?: string[]
+   * }>}
+   */
+  const raw = /** @type {never} */ (yaml.load(yamlContent));
+  /** @type {Record<string, LibraryEntry>} */
+  const map = {};
+
+  for (const [name, entry] of Object.entries(raw)) {
+    const css = entry.css ? Object.values(entry.css).flatMap(Object.keys) : [];
+
+    const js = entry.js
+      ? Object.entries(entry.js).map(([src, opts]) =>
+          opts?.attributes?.type
+            ? { src, type: opts.attributes.type }
+            : { src },
+        )
+      : [];
+
+    const dependencies = (entry.dependencies || [])
+      .filter((dep) => dep.includes("/"))
+      .map((dep) => ({
+        prefix: dep.slice(0, dep.indexOf("/")),
+        name: dep.slice(dep.indexOf("/") + 1),
+      }));
+
+    map[name] = { css, js, dependencies };
+  }
+
+  return map;
 }
 
 /**
@@ -64,65 +62,61 @@ export function parseLibrariesYaml(yamlContent) {
  * @returns {{css: string[], js: JsEntry[]}}
  */
 export function resolveComponentAssets(
-	libraryName,
-	librariesMap,
-	ignorePrefixes,
+  libraryName,
+  librariesMap,
+  ignorePrefixes,
 ) {
-	const cssSet = [];
-	const jsSet = [];
-	const resolved = new Set();
-
-	/**
-	 * @param {string} name
-	 * @param {Set<string>} ancestors
-	 */
-	function walk(name, ancestors) {
-		if (ancestors.has(name)) {
-			console.warn(
-				`Circular dependency detected: "${name}" already in chain.`,
-			);
-			return;
-		}
-
-		if (resolved.has(name)) {
-			return;
-		}
-
-		const lib = librariesMap[name];
-		if (!lib) {
-			console.warn(
-				`Dependency "${name}" not found in libraries — skipping.`,
-			);
-			return;
-		}
-
-		const chain = new Set(ancestors);
-		chain.add(name);
-
-		for (const dep of lib.dependencies) {
-			if (ignorePrefixes.includes(dep.prefix)) {
-				continue;
-			}
-			walk(dep.name, chain);
-		}
-
-		for (const cssFile of lib.css) {
-			if (!cssSet.includes(cssFile)) {
-				cssSet.push(cssFile);
-			}
-		}
-
-		for (const jsEntry of lib.js) {
-			if (!jsSet.some((entry) => entry.src === jsEntry.src)) {
-				jsSet.push(jsEntry);
-			}
-		}
-
-		resolved.add(name);
-	}
-
-	walk(libraryName, new Set());
-	return { css: cssSet, js: jsSet };
+  const cssSet = [];
+  const jsSet = [];
+  const resolved = new Set();
+
+  /**
+   * @param {string} name
+   * @param {Set<string>} ancestors
+   */
+  function walk(name, ancestors) {
+    if (ancestors.has(name)) {
+      console.warn(`Circular dependency detected: "${name}" already in chain.`);
+      return;
+    }
+
+    if (resolved.has(name)) {
+      return;
+    }
+
+    const lib = librariesMap[name];
+    if (!lib) {
+      console.warn(`Dependency "${name}" not found in libraries — skipping.`);
+      return;
+    }
+
+    const chain = new Set(ancestors);
+    chain.add(name);
+
+    for (const dep of lib.dependencies) {
+      if (ignorePrefixes.includes(dep.prefix)) {
+        continue;
+      }
+      walk(dep.name, chain);
+    }
+
+    for (const cssFile of lib.css) {
+      if (!cssSet.includes(cssFile)) {
+        cssSet.push(cssFile);
+      }
+    }
+
+    for (const jsEntry of lib.js) {
+      if (!jsSet.some((entry) => entry.src === jsEntry.src)) {
+        jsSet.push(jsEntry);
+      }
+    }
+
+    resolved.add(name);
+  }
+
+  walk(libraryName, new Set());
+  return { css: cssSet, js: jsSet };
 }
 
 const DEFAULT_PREFIXES = ["element-", "pattern-", "template-", "component-"];
@@ -137,53 +131,50 @@ const DEFAULT_PREFIXES = ["element-", "pattern-", "template-", "component-"];
  * @returns {string|null} component folder relative path, or null if not found
  */
 export function mapLibraryToComponent(
-	libraryName,
-	mapping,
-	componentsFolder,
-	autoDiscoveryPrefixes = DEFAULT_PREFIXES,
+  libraryName,
+  mapping,
+  componentsFolder,
+  autoDiscoveryPrefixes = DEFAULT_PREFIXES,
 ) {
-	if (mapping[libraryName]) {
-		return mapping[libraryName];
-	}
-
-	const candidates = [libraryName];
-
-	for (const prefix of autoDiscoveryPrefixes) {
-		if (libraryName.startsWith(prefix)) {
-			candidates.push(libraryName.slice(prefix.length));
-		}
-	}
-
-	try {
-		/** @type {string[]} */
-		const searchDirs = [componentsFolder];
-		while (searchDirs.length > 0) {
-			const dir = /** @type {string} */ (searchDirs.pop());
-
-			if (!fs.existsSync(dir)) {
-				continue;
-			}
-
-			const entries = fs.readdirSync(dir, { withFileTypes: true });
-
-			for (const entry of entries) {
-				if (!entry.isDirectory()) {
-					continue;
-				}
-
-				if (candidates.includes(entry.name)) {
-					return path.relative(
-						componentsFolder,
-						path.join(dir, entry.name),
-					);
-				}
-				searchDirs.push(path.join(dir, entry.name));
-			}
-		}
-	} catch {
-		// Swallow filesystem errors (missing/unreadable dirs) intentionally.
-		// Caller handles null return with a user-facing warning.
-	}
-
-	return null;
+  if (mapping[libraryName]) {
+    return mapping[libraryName];
+  }
+
+  const candidates = [libraryName];
+
+  for (const prefix of autoDiscoveryPrefixes) {
+    if (libraryName.startsWith(prefix)) {
+      candidates.push(libraryName.slice(prefix.length));
+    }
+  }
+
+  try {
+    /** @type {string[]} */
+    const searchDirs = [componentsFolder];
+    while (searchDirs.length > 0) {
+      const dir = /** @type {string} */ (searchDirs.pop());
+
+      if (!fs.existsSync(dir)) {
+        continue;
+      }
+
+      const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+      for (const entry of entries) {
+        if (!entry.isDirectory()) {
+          continue;
+        }
+
+        if (candidates.includes(entry.name)) {
+          return path.relative(componentsFolder, path.join(dir, entry.name));
+        }
+        searchDirs.push(path.join(dir, entry.name));
+      }
+    }
+  } catch {
+    // Swallow filesystem errors (missing/unreadable dirs) intentionally.
+    // Caller handles null return with a user-facing warning.
+  }
+
+  return null;
 }

package/lib/errors.js

@@ -5,27 +5,27 @@
  * not a unique code for every possible failure.
  */
 export const EXIT_CODES = Object.freeze({
-	SUCCESS: 0,
-	GENERAL_ERROR: 1,
-	CLI_USAGE_ERROR: 2,
-	CONFIG_ERROR: 3,
-	VALIDATION_ERROR: 4,
+  SUCCESS: 0,
+  GENERAL_ERROR: 1,
+  CLI_USAGE_ERROR: 2,
+  CONFIG_ERROR: 3,
+  VALIDATION_ERROR: 4,
 });
 
 export class MiyagiError extends Error {
-	/**
-	 * @param {string} message
-	 * @param {object} [options]
-	 * @param {number} [options.code] Exit code from `EXIT_CODES`.
-	 * @param {boolean} [options.logged] True if this error was already sent to the logger and should not be logged again at the CLI boundary.
-	 */
-	constructor(
-		message,
-		{ code = EXIT_CODES.GENERAL_ERROR, logged = false } = {},
-	) {
-		super(message);
-		this.name = "MiyagiError";
-		this.code = code;
-		this.logged = logged;
-	}
+  /**
+   * @param {string} message
+   * @param {object} [options]
+   * @param {number} [options.code] Exit code from `EXIT_CODES`.
+   * @param {boolean} [options.logged] True if this error was already sent to the logger and should not be logged again at the CLI boundary.
+   */
+  constructor(
+    message,
+    { code = EXIT_CODES.GENERAL_ERROR, logged = false } = {},
+  ) {
+    super(message);
+    this.name = "MiyagiError";
+    this.code = code;
+    this.logged = logged;
+  }
 }