@schalkneethling/miyagi-core 4.4.2 → 4.4.3

package/lib/cli/run.js

@@ -5,10 +5,10 @@ import mockGenerator from "../generator/mocks.js";
 import getConfig from "../config.js";
 import createCli from "../init/args.js";
 import {
-	lint,
-	component as createComponentViaCli,
-	drupalAssets,
-	doctor,
+  lint,
+  component as createComponentViaCli,
+  drupalAssets,
+  doctor,
 } from "./index.js";
 import { EXIT_CODES, MiyagiError } from "../errors.js";
 
@@ -16,11 +16,11 @@ import { EXIT_CODES, MiyagiError } from "../errors.js";
  * @returns {object}
  */
 function createSuccessResult() {
-	return {
-		success: true,
-		code: EXIT_CODES.SUCCESS,
-		shouldExit: true,
-	};
+  return {
+    success: true,
+    code: EXIT_CODES.SUCCESS,
+    shouldExit: true,
+  };
 }
 
 /**
@@ -29,13 +29,13 @@ function createSuccessResult() {
  * @returns {object}
  */
 function createFailureResult(message, code = EXIT_CODES.GENERAL_ERROR) {
-	log("error", message);
-	return {
-		success: false,
-		code,
-		shouldExit: true,
-		message,
-	};
+  log("error", message);
+  return {
+    success: false,
+    code,
+    shouldExit: true,
+    message,
+  };
 }
 
 /**
@@ -44,15 +44,15 @@ function createFailureResult(message, code = EXIT_CODES.GENERAL_ERROR) {
  * @returns {void}
  */
 function maybeLogDoctorHint(code, argv) {
-	if (code !== EXIT_CODES.CONFIG_ERROR) {
-		return;
-	}
+  if (code !== EXIT_CODES.CONFIG_ERROR) {
+    return;
+  }
 
-	if (argv.includes("doctor")) {
-		return;
-	}
+  if (argv.includes("doctor")) {
+    return;
+  }
 
-	log("info", "Run `miyagi doctor` for a setup check.");
+  log("info", "Run `miyagi doctor` for a setup check.");
 }
 
 /**
@@ -61,20 +61,24 @@ function maybeLogDoctorHint(code, argv) {
  * @param {boolean} [isComponentGenerator]
  * @returns {Promise<object>}
  */
-async function loadCliConfig(args, isBuild = false, isComponentGenerator = false) {
-	global.config = await getConfig(args, isBuild, isComponentGenerator);
+async function loadCliConfig(
+  args,
+  isBuild = false,
+  isComponentGenerator = false,
+) {
+  global.config = await getConfig(args, isBuild, isComponentGenerator);
 
-	if (!global.config.components.folder && !global.config.docs.folder) {
-		return createFailureResult(
-			"Please specify at least either components.folder or docs.folder in your configuration file.",
-			EXIT_CODES.CONFIG_ERROR,
-		);
-	}
+  if (!global.config.components.folder && !global.config.docs.folder) {
+    return createFailureResult(
+      "Please specify at least either components.folder or docs.folder in your configuration file.",
+      EXIT_CODES.CONFIG_ERROR,
+    );
+  }
 
-	return {
-		success: true,
-		config: global.config,
-	};
+  return {
+    success: true,
+    config: global.config,
+  };
 }
 
 /**
@@ -82,9 +86,9 @@ async function loadCliConfig(args, isBuild = false, isComponentGenerator = false
  * @returns {void}
  */
 function applyCliEnv(args) {
-	if (args.verbose) {
-		process.env.VERBOSE = String(args.verbose);
-	}
+  if (args.verbose) {
+    process.env.VERBOSE = String(args.verbose);
+  }
 }
 
 /**
@@ -98,24 +102,24 @@ function applyCliEnv(args) {
  * @returns {Promise<object>}
  */
 async function withCliConfig(args, options = {}, run) {
-	applyCliEnv(args);
+  applyCliEnv(args);
 
-	if (options.forcedNodeEnv) {
-		process.env.NODE_ENV = options.forcedNodeEnv;
-	} else if (options.defaultNodeEnv && !process.env.NODE_ENV) {
-		process.env.NODE_ENV = options.defaultNodeEnv;
-	}
+  if (options.forcedNodeEnv) {
+    process.env.NODE_ENV = options.forcedNodeEnv;
+  } else if (options.defaultNodeEnv && !process.env.NODE_ENV) {
+    process.env.NODE_ENV = options.defaultNodeEnv;
+  }
 
-	const configResult = await loadCliConfig(
-		args,
-		options.isBuild,
-		options.isComponentGenerator,
-	);
-	if (!configResult.success) {
-		return configResult;
-	}
+  const configResult = await loadCliConfig(
+    args,
+    options.isBuild,
+    options.isComponentGenerator,
+  );
+  if (!configResult.success) {
+    return configResult;
+  }
 
-	return await run(configResult.config);
+  return await run(configResult.config);
 }
 
 /**
@@ -123,18 +127,18 @@ async function withCliConfig(args, options = {}, run) {
  * @returns {Promise<object>}
  */
 async function runStartCommand(args) {
-	return await withCliConfig(
-		args,
-		{ defaultNodeEnv: "development" },
-		async (config) => {
-			log(
-				"info",
-				t("serverStarting").replace("{{node_env}}", process.env.NODE_ENV),
-			);
+  return await withCliConfig(
+    args,
+    { defaultNodeEnv: "development" },
+    async (config) => {
+      log(
+        "info",
+        t("serverStarting").replace("{{node_env}}", process.env.NODE_ENV),
+      );
 
-			return await initRendering(config);
-		},
-	);
+      return await initRendering(config);
+    },
+  );
 }
 
 /**
@@ -142,14 +146,14 @@ async function runStartCommand(args) {
  * @returns {Promise<object>}
  */
 async function runBuildCommand(args) {
-	return await withCliConfig(
-		args,
-		{ forcedNodeEnv: "production", isBuild: true },
-		async (config) => {
-			log("info", t("buildStarting"));
-			return await initRendering(config);
-		},
-	);
+  return await withCliConfig(
+    args,
+    { forcedNodeEnv: "production", isBuild: true },
+    async (config) => {
+      log("info", t("buildStarting"));
+      return await initRendering(config);
+    },
+  );
 }
 
 /**
@@ -157,14 +161,14 @@ async function runBuildCommand(args) {
  * @returns {Promise<object>}
  */
 async function runComponentCommand(args) {
-	return await withCliConfig(
-		args,
-		{ defaultNodeEnv: "development", isComponentGenerator: true },
-		async () => {
-			log("info", t("generator.starting"));
-			return await createComponentViaCli(args);
-		},
-	);
+  return await withCliConfig(
+    args,
+    { defaultNodeEnv: "development", isComponentGenerator: true },
+    async () => {
+      log("info", t("generator.starting"));
+      return await createComponentViaCli(args);
+    },
+  );
 }
 
 /**
@@ -172,23 +176,23 @@ async function runComponentCommand(args) {
  * @returns {Promise<object>}
  */
 async function runMocksCommand(args) {
-	return await withCliConfig(
-		args,
-		{ defaultNodeEnv: "development" },
-		async (config) => {
-			const result = await mockGenerator(args.component, config.files);
-			if (result?.message) {
-				log(result.message.type, result.message.text, result.message.verbose);
-			}
+  return await withCliConfig(
+    args,
+    { defaultNodeEnv: "development" },
+    async (config) => {
+      const result = await mockGenerator(args.component, config.files);
+      if (result?.message) {
+        log(result.message.type, result.message.text, result.message.verbose);
+      }
 
-			return {
-				success: result.success,
-				code: result.success ? EXIT_CODES.SUCCESS : EXIT_CODES.GENERAL_ERROR,
-				shouldExit: true,
-				message: result.message?.text,
-			};
-		},
-	);
+      return {
+        success: result.success,
+        code: result.success ? EXIT_CODES.SUCCESS : EXIT_CODES.GENERAL_ERROR,
+        shouldExit: true,
+        message: result.message?.text,
+      };
+    },
+  );
 }
 
 /**
@@ -196,8 +200,8 @@ async function runMocksCommand(args) {
  * @returns {Promise<object>}
  */
 async function runLintCommand(args) {
-	applyCliEnv(args);
-	return await lint(args);
+  applyCliEnv(args);
+  return await lint(args);
 }
 
 /**
@@ -205,11 +209,11 @@ async function runLintCommand(args) {
  * @returns {Promise<object>}
  */
 async function runDrupalAssetsCommand(args) {
-	return await withCliConfig(
-		args,
-		{ forcedNodeEnv: "development" },
-		async () => await drupalAssets(args),
-	);
+  return await withCliConfig(
+    args,
+    { forcedNodeEnv: "development" },
+    async () => await drupalAssets(args),
+  );
 }
 
 /**
@@ -217,8 +221,8 @@ async function runDrupalAssetsCommand(args) {
  * @returns {Promise<object>}
  */
 async function runDoctorCommand(args) {
-	applyCliEnv(args);
-	return await doctor(args);
+  applyCliEnv(args);
+  return await doctor(args);
 }
 
 /**
@@ -227,29 +231,29 @@ async function runDoctorCommand(args) {
  * @returns {object}
  */
 function normalizeCliError(error, argv) {
-	if (error instanceof MiyagiError) {
-		if (!error.logged) {
-			log("error", error.message);
-		}
-		maybeLogDoctorHint(error.code, argv);
+  if (error instanceof MiyagiError) {
+    if (!error.logged) {
+      log("error", error.message);
+    }
+    maybeLogDoctorHint(error.code, argv);
 
-		return {
-			success: false,
-			code: error.code,
-			shouldExit: true,
-			message: error.message,
-		};
-	}
+    return {
+      success: false,
+      code: error.code,
+      shouldExit: true,
+      message: error.message,
+    };
+  }
 
-	const message = error instanceof Error ? error.message : String(error);
-	log("error", message);
-	maybeLogDoctorHint(EXIT_CODES.GENERAL_ERROR, argv);
-	return {
-		success: false,
-		code: EXIT_CODES.GENERAL_ERROR,
-		shouldExit: true,
-		message,
-	};
+  const message = error instanceof Error ? error.message : String(error);
+  log("error", message);
+  maybeLogDoctorHint(EXIT_CODES.GENERAL_ERROR, argv);
+  return {
+    success: false,
+    code: EXIT_CODES.GENERAL_ERROR,
+    shouldExit: true,
+    message,
+  };
 }
 
 /**
@@ -257,25 +261,25 @@ function normalizeCliError(error, argv) {
  * @returns {Promise<object>}
  */
 export async function runCli(argv = process.argv) {
-	const { cli, getResult } = createCli(
-		{
-			start: runStartCommand,
-			build: runBuildCommand,
-			new: runComponentCommand,
-			mocks: runMocksCommand,
-			lint: runLintCommand,
-			drupalAssets: runDrupalAssetsCommand,
-			doctor: runDoctorCommand,
-		},
-		argv,
-	);
+  const { cli, getResult } = createCli(
+    {
+      start: runStartCommand,
+      build: runBuildCommand,
+      new: runComponentCommand,
+      mocks: runMocksCommand,
+      lint: runLintCommand,
+      drupalAssets: runDrupalAssetsCommand,
+      doctor: runDoctorCommand,
+    },
+    argv,
+  );
 
-	try {
-		await cli.parseAsync();
-		const result = getResult() || createSuccessResult();
-		maybeLogDoctorHint(result.code, argv);
-		return result;
-	} catch (error) {
-		return normalizeCliError(error, argv);
-	}
+  try {
+    await cli.parseAsync();
+    const result = getResult() || createSuccessResult();
+    maybeLogDoctorHint(result.code, argv);
+    return result;
+  } catch (error) {
+    return normalizeCliError(error, argv);
+  }
 }

package/lib/config.js

@@ -11,44 +11,44 @@ import log from "./logger.js";
  * @returns {Promise<object>}
  */
 export default async function getConfig(args, isBuild, isComponentGenerator) {
-	let userFile = {};
-	let userFileName;
-
-	try {
-		userFileName = ".miyagi.js";
-		userFile = await import(
-			path.resolve(process.cwd(), `${userFileName}?time=${Date.now()}`)
-		);
-	} catch (e) {
-		log("warn", null, e);
-		try {
-			userFileName = ".miyagi.mjs";
-			userFile = await import(
-				path.resolve(process.cwd(), `${userFileName}?time=${Date.now()}`)
-			);
-		} catch (err) {
-			userFileName = null;
-			log("warn", null, err);
-		}
-	}
-
-	let userConfig =
-		(args ? deepMerge(userFile.default, getCliArgs(args)) : userFile.default) ??
-		{};
-
-	userConfig.userFileName = userFileName;
-	userConfig.isBuild = isBuild;
-	userConfig.isComponentGenerator = isComponentGenerator;
-	userConfig.indexPath = {
-		default: isBuild ? "component-all.html" : "/component?file=all",
-		embedded: isBuild
-			? "component-all-embedded.html"
-			: "/component?file=all&embedded=true",
-	};
-
-	delete userConfig._;
-
-	return getMergedConfig(userConfig);
+  let userFile = {};
+  let userFileName;
+
+  try {
+    userFileName = ".miyagi.js";
+    userFile = await import(
+      path.resolve(process.cwd(), `${userFileName}?time=${Date.now()}`)
+    );
+  } catch (e) {
+    log("warn", null, e);
+    try {
+      userFileName = ".miyagi.mjs";
+      userFile = await import(
+        path.resolve(process.cwd(), `${userFileName}?time=${Date.now()}`)
+      );
+    } catch (err) {
+      userFileName = null;
+      log("warn", null, err);
+    }
+  }
+
+  let userConfig =
+    (args ? deepMerge(userFile.default, getCliArgs(args)) : userFile.default) ??
+    {};
+
+  userConfig.userFileName = userFileName;
+  userConfig.isBuild = isBuild;
+  userConfig.isComponentGenerator = isComponentGenerator;
+  userConfig.indexPath = {
+    default: isBuild ? "component-all.html" : "/component?file=all",
+    embedded: isBuild
+      ? "component-all-embedded.html"
+      : "/component?file=all&embedded=true",
+  };
+
+  delete userConfig._;
+
+  return getMergedConfig(userConfig);
 }
 
 /**
@@ -57,52 +57,52 @@ export default async function getConfig(args, isBuild, isComponentGenerator) {
  * @returns {object} configuration object based on cli args
  */
 function getCliArgs(args) {
-	const cliArgs = { ...args };
-	const buildArgs = {};
-
-	delete cliArgs._;
-	delete cliArgs.$0;
-	delete cliArgs.component;
-	delete cliArgs.verbose;
-	delete cliArgs.skip;
-	delete cliArgs.only;
-	delete cliArgs.engine;
-	delete cliArgs.config;
-	delete cliArgs.libraries;
-	delete cliArgs.components;
-	delete cliArgs.ignorePrefixes;
-	delete cliArgs.dryRun;
-
-	if (cliArgs.folder) {
-		buildArgs.folder = cliArgs.folder;
-		delete cliArgs.folder;
-	}
-
-	cliArgs.build = buildArgs;
-
-	if (
-		cliArgs.watchReport !== undefined ||
-		cliArgs.watchReportFormat !== undefined ||
-		cliArgs.watchReportNoColor !== undefined
-	) {
-		cliArgs.watch = cliArgs.watch || {};
-		cliArgs.watch.report = cliArgs.watch.report || {};
-
-		if (cliArgs.watchReport !== undefined) {
-			cliArgs.watch.report.enabled = cliArgs.watchReport;
-			delete cliArgs.watchReport;
-		}
-
-		if (cliArgs.watchReportFormat !== undefined) {
-			cliArgs.watch.report.format = cliArgs.watchReportFormat;
-			delete cliArgs.watchReportFormat;
-		}
-
-		if (cliArgs.watchReportNoColor !== undefined) {
-			cliArgs.watch.report.useColors = !cliArgs.watchReportNoColor;
-			delete cliArgs.watchReportNoColor;
-		}
-	}
-
-	return cliArgs;
+  const cliArgs = { ...args };
+  const buildArgs = {};
+
+  delete cliArgs._;
+  delete cliArgs.$0;
+  delete cliArgs.component;
+  delete cliArgs.verbose;
+  delete cliArgs.skip;
+  delete cliArgs.only;
+  delete cliArgs.engine;
+  delete cliArgs.config;
+  delete cliArgs.libraries;
+  delete cliArgs.components;
+  delete cliArgs.ignorePrefixes;
+  delete cliArgs.dryRun;
+
+  if (cliArgs.folder) {
+    buildArgs.folder = cliArgs.folder;
+    delete cliArgs.folder;
+  }
+
+  cliArgs.build = buildArgs;
+
+  if (
+    cliArgs.watchReport !== undefined ||
+    cliArgs.watchReportFormat !== undefined ||
+    cliArgs.watchReportNoColor !== undefined
+  ) {
+    cliArgs.watch = cliArgs.watch || {};
+    cliArgs.watch.report = cliArgs.watch.report || {};
+
+    if (cliArgs.watchReport !== undefined) {
+      cliArgs.watch.report.enabled = cliArgs.watchReport;
+      delete cliArgs.watchReport;
+    }
+
+    if (cliArgs.watchReportFormat !== undefined) {
+      cliArgs.watch.report.format = cliArgs.watchReportFormat;
+      delete cliArgs.watchReportFormat;
+    }
+
+    if (cliArgs.watchReportNoColor !== undefined) {
+      cliArgs.watch.report.useColors = !cliArgs.watchReportNoColor;
+      delete cliArgs.watchReportNoColor;
+    }
+  }
+
+  return cliArgs;
 }

package/lib/constants/lint-log-levels.js

@@ -1,11 +1,11 @@
 export const LINT_LOG_LEVELS = Object.freeze({
-	ERROR: "error",
-	WARN: "warn",
-	INFO: "info",
+  ERROR: "error",
+  WARN: "warn",
+  INFO: "info",
 });
 
 export const LINT_LOG_LEVEL_ORDER = Object.freeze({
-	[LINT_LOG_LEVELS.ERROR]: 0,
-	[LINT_LOG_LEVELS.WARN]: 1,
-	[LINT_LOG_LEVELS.INFO]: 2,
+  [LINT_LOG_LEVELS.ERROR]: 0,
+  [LINT_LOG_LEVELS.WARN]: 1,
+  [LINT_LOG_LEVELS.INFO]: 2,
 });