@schalkneethling/miyagi-core 4.4.2 → 4.4.3

package/lib/cli/app.js

@@ -16,23 +16,23 @@ import setViews from "../init/views.js";
  * @returns {Promise<object>}
  */
 export default async function init(mergedConfig) {
-	global.app = express();
-	global.config = mergedConfig;
-	global.app.set("view cache", false);
-	global.app.set("cache", false);
+  global.app = express();
+  global.config = mergedConfig;
+  global.app.set("view cache", false);
+  global.app.set("cache", false);
 
-	await setEngines();
-	await setState({
-		sourceTree: true,
-		menu: true,
-		partials: true,
-		fileContents: true,
-		css: true,
-	});
+  await setEngines();
+  await setState({
+    sourceTree: true,
+    menu: true,
+    partials: true,
+    fileContents: true,
+    css: true,
+  });
 
-	setStatic();
-	setRouter();
-	setViews();
+  setStatic();
+  setRouter();
+  setViews();
 
-	return global.app;
+  return global.app;
 }

package/lib/cli/component.js

@@ -9,43 +9,43 @@ import { EXIT_CODES } from "../errors.js";
  * @returns {Promise<object>}
  */
 export default async function createComponentViaCli(cliParams) {
-	const commands = [cliParams.component].filter(Boolean);
+  const commands = [cliParams.component].filter(Boolean);
 
-	if (commands.length === 0) {
-		const message = t("generator.noComponentNameDefined");
-		log("error", message);
-		return {
-			success: false,
-			code: EXIT_CODES.CLI_USAGE_ERROR,
-			shouldExit: true,
-			message,
-		};
-	}
+  if (commands.length === 0) {
+    const message = t("generator.noComponentNameDefined");
+    log("error", message);
+    return {
+      success: false,
+      code: EXIT_CODES.CLI_USAGE_ERROR,
+      shouldExit: true,
+      message,
+    };
+  }
 
-	const [component] = commands;
-	const fileTypes = getFileTypesFromCliArgs(
-		cliParams,
-		Object.values(appConfig.defaultUserConfig.files).map((file) => file.abbr),
-	);
+  const [component] = commands;
+  const fileTypes = getFileTypesFromCliArgs(
+    cliParams,
+    Object.values(appConfig.defaultUserConfig.files).map((file) => file.abbr),
+  );
 
-	try {
-		const result = await generateComponent({ component, fileTypes });
-		log("success", result);
-		return {
-			success: true,
-			code: EXIT_CODES.SUCCESS,
-			shouldExit: true,
-			message: result,
-		};
-	} catch (message) {
-		log("error", message);
-		return {
-			success: false,
-			code: EXIT_CODES.GENERAL_ERROR,
-			shouldExit: true,
-			message: String(message),
-		};
-	}
+  try {
+    const result = await generateComponent({ component, fileTypes });
+    log("success", result);
+    return {
+      success: true,
+      code: EXIT_CODES.SUCCESS,
+      shouldExit: true,
+      message: result,
+    };
+  } catch (message) {
+    log("error", message);
+    return {
+      success: false,
+      code: EXIT_CODES.GENERAL_ERROR,
+      shouldExit: true,
+      message: String(message),
+    };
+  }
 }
 
 /**
@@ -55,20 +55,20 @@ export default async function createComponentViaCli(cliParams) {
  * @returns {Array} all file paths that should be created
  */
 function getFileTypesFromCliArgs(args, fileTypes) {
-	if (args) {
-		if (args.skip) {
-			const files = [];
-			for (const fileType of fileTypes) {
-				if (!args.skip.includes(fileType)) {
-					files.push(fileType);
-				}
-			}
-			return files;
-		}
-		if (args.only) {
-			return args.only;
-		}
-		return fileTypes;
-	}
-	return fileTypes;
+  if (args) {
+    if (args.skip) {
+      const files = [];
+      for (const fileType of fileTypes) {
+        if (!args.skip.includes(fileType)) {
+          files.push(fileType);
+        }
+      }
+      return files;
+    }
+    if (args.only) {
+      return args.only;
+    }
+    return fileTypes;
+  }
+  return fileTypes;
 }

package/lib/cli/doctor.js

@@ -10,102 +10,111 @@ const CONFIG_FILES = [".miyagi.js", ".miyagi.mjs"];
  * @returns {Promise<object>}
  */
 export default async function doctor() {
-	let success = true;
-
-	if (checkNodeVersion()) {
-		log("success", `Node.js ${process.versions.node} satisfies ${pkgJson.engines.node}.`);
-	} else {
-		success = false;
-		log(
-			"error",
-			`Node.js ${process.versions.node} does not satisfy ${pkgJson.engines.node}.`,
-		);
-	}
-
-	const configResult = await loadUserConfig();
-
-	if (!configResult.userFileName) {
-		success = false;
-		log(
-			"error",
-			"No miyagi config found. Create .miyagi.js or .miyagi.mjs in your project root.",
-		);
-		return {
-			success,
-			code: EXIT_CODES.CONFIG_ERROR,
-			shouldExit: true,
-		};
-	}
-
-	if (configResult.error) {
-		success = false;
-		log(
-			"error",
-			`Could not parse ${configResult.userFileName}. Check its syntax and exports.`,
-		);
-		log("error", configResult.error.message, configResult.error);
-		return {
-			success,
-			code: EXIT_CODES.CONFIG_ERROR,
-			shouldExit: true,
-		};
-	}
-
-	log("success", `Loaded config from ${configResult.userFileName}.`);
-
-	const config = configResult.config || {};
-
-	if (typeof config.engine?.render === "function") {
-		log("success", "engine.render is defined.");
-	} else {
-		success = false;
-		log("error", "engine.render is missing.");
-	}
-
-	if (config.components?.folder || config.docs?.folder) {
-		log("success", "At least one source folder is configured.");
-	} else {
-		success = false;
-		log(
-			"error",
-			"Set at least one of components.folder or docs.folder in your miyagi config.",
-		);
-	}
-
-	if (config.components?.folder) {
-		if (await pathExists(config.components.folder)) {
-			log("success", `components.folder exists: ${config.components.folder}`);
-		} else {
-			success = false;
-			log("error", `components.folder does not exist: ${config.components.folder}`);
-		}
-	}
-
-	if (config.docs?.folder) {
-		if (await pathExists(config.docs.folder)) {
-			log("success", `docs.folder exists: ${config.docs.folder}`);
-		} else {
-			success = false;
-			log("error", `docs.folder does not exist: ${config.docs.folder}`);
-		}
-	}
-
-	log(success ? "success" : "error", success ? "Doctor checks passed." : "Doctor found issues.");
-
-	return {
-		success,
-		code: success ? EXIT_CODES.SUCCESS : EXIT_CODES.CONFIG_ERROR,
-		shouldExit: true,
-	};
+  let success = true;
+
+  if (checkNodeVersion()) {
+    log(
+      "success",
+      `Node.js ${process.versions.node} satisfies ${pkgJson.engines.node}.`,
+    );
+  } else {
+    success = false;
+    log(
+      "error",
+      `Node.js ${process.versions.node} does not satisfy ${pkgJson.engines.node}.`,
+    );
+  }
+
+  const configResult = await loadUserConfig();
+
+  if (!configResult.userFileName) {
+    success = false;
+    log(
+      "error",
+      "No miyagi config found. Create .miyagi.js or .miyagi.mjs in your project root.",
+    );
+    return {
+      success,
+      code: EXIT_CODES.CONFIG_ERROR,
+      shouldExit: true,
+    };
+  }
+
+  if (configResult.error) {
+    success = false;
+    log(
+      "error",
+      `Could not parse ${configResult.userFileName}. Check its syntax and exports.`,
+    );
+    log("error", configResult.error.message, configResult.error);
+    return {
+      success,
+      code: EXIT_CODES.CONFIG_ERROR,
+      shouldExit: true,
+    };
+  }
+
+  log("success", `Loaded config from ${configResult.userFileName}.`);
+
+  const config = configResult.config || {};
+
+  if (typeof config.engine?.render === "function") {
+    log("success", "engine.render is defined.");
+  } else {
+    success = false;
+    log("error", "engine.render is missing.");
+  }
+
+  if (config.components?.folder || config.docs?.folder) {
+    log("success", "At least one source folder is configured.");
+  } else {
+    success = false;
+    log(
+      "error",
+      "Set at least one of components.folder or docs.folder in your miyagi config.",
+    );
+  }
+
+  if (config.components?.folder) {
+    if (await pathExists(config.components.folder)) {
+      log("success", `components.folder exists: ${config.components.folder}`);
+    } else {
+      success = false;
+      log(
+        "error",
+        `components.folder does not exist: ${config.components.folder}`,
+      );
+    }
+  }
+
+  if (config.docs?.folder) {
+    if (await pathExists(config.docs.folder)) {
+      log("success", `docs.folder exists: ${config.docs.folder}`);
+    } else {
+      success = false;
+      log("error", `docs.folder does not exist: ${config.docs.folder}`);
+    }
+  }
+
+  log(
+    success ? "success" : "error",
+    success ? "Doctor checks passed." : "Doctor found issues.",
+  );
+
+  return {
+    success,
+    code: success ? EXIT_CODES.SUCCESS : EXIT_CODES.CONFIG_ERROR,
+    shouldExit: true,
+  };
 }
 
 /**
  * @returns {boolean}
  */
 function checkNodeVersion() {
-	const minimumMajor = Number(pkgJson.engines.node.match(/\d+/)?.[0] || 0);
-	const currentMajor = Number(process.versions.node.split(".")[0]);
-	return currentMajor >= minimumMajor;
+  const minimumMajor = Number(pkgJson.engines.node.match(/\d+/)?.[0] || 0);
+  const currentMajor = Number(process.versions.node.split(".")[0]);
+  return currentMajor >= minimumMajor;
 }
 
 /**
@@ -113,41 +122,41 @@ function checkNodeVersion() {
  * @returns {Promise<boolean>}
  */
 async function pathExists(relativePath) {
-	try {
-		await stat(path.resolve(process.cwd(), relativePath));
-		return true;
-	} catch {
-		return false;
-	}
+  try {
+    await stat(path.resolve(process.cwd(), relativePath));
+    return true;
+  } catch {
+    return false;
+  }
 }
 
 /**
  * @returns {Promise<object>}
  */
 async function loadUserConfig() {
-	for (const fileName of CONFIG_FILES) {
-		const fullPath = path.resolve(process.cwd(), fileName);
-
-		if (!(await pathExists(fileName))) {
-			continue;
-		}
-
-		try {
-			const module = await import(`${fullPath}?time=${Date.now()}`);
-			return {
-				userFileName: fileName,
-				config: module.default || {},
-			};
-		} catch (error) {
-			return {
-				userFileName: fileName,
-				error: /** @type {Error} */ (error),
-			};
-		}
-	}
-
-	return {
-		userFileName: null,
-		config: null,
-	};
+  for (const fileName of CONFIG_FILES) {
+    const fullPath = path.resolve(process.cwd(), fileName);
+
+    if (!(await pathExists(fileName))) {
+      continue;
+    }
+
+    try {
+      const module = await import(`${fullPath}?time=${Date.now()}`);
+      return {
+        userFileName: fileName,
+        config: module.default || {},
+      };
+    } catch (error) {
+      return {
+        userFileName: fileName,
+        error: /** @type {Error} */ (error),
+      };
+    }
+  }
+
+  return {
+    userFileName: null,
+    config: null,
+  };
 }