@schalkneethling/miyagi-core 4.4.2 → 4.4.4

package/README.md

@@ -35,10 +35,15 @@ pnpm add -D @schalkneethling/miyagi-core twing
 Create `.miyagi.mjs`:
 
 ```js
-import { createSynchronousEnvironment, createSynchronousFilesystemLoader } from "twing";
+import {
+  createSynchronousEnvironment,
+  createSynchronousFilesystemLoader,
+} from "twing";
 import fs from "node:fs";
 
-const twing = createSynchronousEnvironment(createSynchronousFilesystemLoader(fs));
+const twing = createSynchronousEnvironment(
+  createSynchronousFilesystemLoader(fs),
+);
 
 export default {
   components: {

package/api/app.js

@@ -17,23 +17,23 @@ import setViews from "../lib/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/api/index.js

@@ -8,9 +8,9 @@ import generateMockData from "../lib/generator/mocks.js";
 import generateComponent from "../lib/generator/component.js";
 import validateMockData from "../lib/validator/mocks.js";
 import {
-	getSchemaValidationMode,
-	toSchemaValidationResult,
-	validateSchemas,
+  getSchemaValidationMode,
+  toSchemaValidationResult,
+  validateSchemas,
 } from "../lib/validator/schemas.js";
 
 /**
@@ -20,43 +20,43 @@ import {
  * @returns {Promise<object>}
  */
 export const getMockData = async (
-	{ component, variant = "default" } = { component: null },
+  { component, variant = "default" } = { component: null },
 ) => {
-	if (!component)
-		return {
-			success: false,
-			message:
-				'Please pass a component to `getMockData` ({ component: "name" }).',
-		};
-
-	global.app = await init("api");
-
-	const componentObject = getComponentsObject(component);
-
-	if (!componentObject)
-		return {
-			success: false,
-			message: `Component "${component}" does not exist.`,
-		};
-
-	const data = await getVariationData(componentObject, variant);
-
-	if (!data) {
-		return {
-			success: true,
-			message: `No mock data found for component "${component}", variant "${variant}".`,
-			data: null,
-		};
-	}
-
-	if (!data.resolved) {
-		return {
-			success: false,
-			message: "An unknown error occured.",
-		};
-	}
-
-	return { success: true, data: data.resolved };
+  if (!component)
+    return {
+      success: false,
+      message:
+        'Please pass a component to `getMockData` ({ component: "name" }).',
+    };
+
+  global.app = await init("api");
+
+  const componentObject = getComponentsObject(component);
+
+  if (!componentObject)
+    return {
+      success: false,
+      message: `Component "${component}" does not exist.`,
+    };
+
+  const data = await getVariationData(componentObject, variant);
+
+  if (!data) {
+    return {
+      success: true,
+      message: `No mock data found for component "${component}", variant "${variant}".`,
+      data: null,
+    };
+  }
+
+  if (!data.resolved) {
+    return {
+      success: false,
+      message: "An unknown error occured.",
+    };
+  }
+
+  return { success: true, data: data.resolved };
 };
 
 /**
@@ -66,228 +66,229 @@ export const getMockData = async (
  * @returns {Promise<object>}
  */
 export const getHtml = async (
-	{ component, variant } = { component: null, variant: "default" },
+  { component, variant } = { component: null, variant: "default" },
 ) => {
-	if (!component)
-		return {
-			success: false,
-			message: 'Please pass a component to `getHtml` ({ component: "name" }).',
-		};
-
-	const { success, data, message } = await getMockData({ component, variant });
-
-	if (success) {
-		const result = await renderIframeVariationStandalone({
-			component: getComponentsObject(component),
-			componentData: success ? data : {},
-		});
-
-		return {
-			success: true,
-			data: result,
-		};
-	} else {
-		return {
-			success: false,
-			message,
-		};
-	}
+  if (!component)
+    return {
+      success: false,
+      message: 'Please pass a component to `getHtml` ({ component: "name" }).',
+    };
+
+  const { success, data, message } = await getMockData({ component, variant });
+
+  if (success) {
+    const result = await renderIframeVariationStandalone({
+      component: getComponentsObject(component),
+      componentData: success ? data : {},
+    });
+
+    return {
+      success: true,
+      data: result,
+    };
+  } else {
+    return {
+      success: false,
+      message,
+    };
+  }
 };
 
 export const createBuild = async () => {
-	global.app = await init("api", { isBuild: true });
-
-	try {
-		const message = await build();
-
-		return {
-			success: true,
-			message,
-		};
-	} catch (message) {
-		return {
-			success: false,
-			message,
-		};
-	}
+  global.app = await init("api", { isBuild: true });
+
+  try {
+    const message = await build();
+
+    return {
+      success: true,
+      message,
+    };
+  } catch (message) {
+    return {
+      success: false,
+      message,
+    };
+  }
 };
 
 export const createMockData = async ({ component }) => {
-	if (!component) {
-		return {
-			success: false,
-			message: t("dataGenerator.noComponentFolderDefined"),
-		};
-	}
-
-	try {
-		global.app = await init("api");
-
-		const { success, message } = await generateMockData(
-			path.join(global.config.components.folder, component),
-			global.config.files,
-		);
-
-		if (success) {
-			return {
-				success: true,
-			};
-		}
-
-		return {
-			success,
-			message: message.text,
-		};
-	} catch (message) {
-		return {
-			success: false,
-			message,
-		};
-	}
+  if (!component) {
+    return {
+      success: false,
+      message: t("dataGenerator.noComponentFolderDefined"),
+    };
+  }
+
+  try {
+    global.app = await init("api");
+
+    const { success, message } = await generateMockData(
+      path.join(global.config.components.folder, component),
+      global.config.files,
+    );
+
+    if (success) {
+      return {
+        success: true,
+      };
+    }
+
+    return {
+      success,
+      message: message.text,
+    };
+  } catch (message) {
+    return {
+      success: false,
+      message,
+    };
+  }
 };
 
 export const createComponent = async ({ component, only = [], skip = [] }) => {
-	global.app = await init("api");
-
-	let fileTypes = ["css", "docs", "js", "mocks", "schema", "tpl"];
-
-	if (only.length > 0) {
-		fileTypes = only;
-	} else if (skip.length > 0) {
-		fileTypes = fileTypes.filter((value) => !skip.includes(value));
-	}
-
-	try {
-		const result = await generateComponent({
-			component: path.join(global.config.components.folder, component),
-			fileTypes,
-		});
-
-		return {
-			success: true,
-			message: result,
-		};
-	} catch (message) {
-		return {
-			success: false,
-			message,
-		};
-	}
+  global.app = await init("api");
+
+  let fileTypes = ["css", "docs", "js", "mocks", "schema", "tpl"];
+
+  if (only.length > 0) {
+    fileTypes = only;
+  } else if (skip.length > 0) {
+    fileTypes = fileTypes.filter((value) => !skip.includes(value));
+  }
+
+  try {
+    const result = await generateComponent({
+      component: path.join(global.config.components.folder, component),
+      fileTypes,
+    });
+
+    return {
+      success: true,
+      message: result,
+    };
+  } catch (message) {
+    return {
+      success: false,
+      message,
+    };
+  }
 };
 
 export const lintComponents = async () => {
-	global.app = await init("api");
-	const mode = getSchemaValidationMode();
-	const components = global.state.routes.filter((route) => route.paths.tpl);
-	const schemaValidation = validateSchemas({
-		components,
-	});
-	const schemaErrorsByComponent = new Map();
-
-	schemaValidation.errors.forEach((entry) => {
-		if (!schemaErrorsByComponent.has(entry.component)) {
-			schemaErrorsByComponent.set(entry.component, []);
-		}
-		schemaErrorsByComponent
-			.get(entry.component)
-			.push(toSchemaValidationResult(entry));
-	});
-
-	if (mode === "fail-fast" && schemaValidation.errors.length > 0) {
-		return {
-			success: false,
-			data: getLintComponentErrorsInRouteOrder({
-				components,
-				errorMap: schemaErrorsByComponent,
-			}),
-		};
-	}
-
-	const promises = components
-		.filter((route) => !schemaErrorsByComponent.has(route.paths.dir.short))
-		.map(
-			(route) =>
-				new Promise((resolve) => {
-					getComponentData(route).then((data) => {
-						const validation = validateMockData(
-							route,
-							data || [],
-							true,
-							schemaValidation.validSchemas,
-						);
-
-						resolve({
-							component: route.alias,
-							errors: validation,
-						});
-					});
-				}),
-		);
-
-	return await Promise.all(promises)
-		.then((res) => {
-			res.forEach((result) => {
-				if (!result?.errors?.length) {
-					return;
-				}
-				const componentErrors = schemaErrorsByComponent.get(result.component) || [];
-				schemaErrorsByComponent.set(result.component, [
-					...componentErrors,
-					...result.errors,
-				]);
-			});
-
-			const errors = getLintComponentErrorsInRouteOrder({
-				components,
-				errorMap: schemaErrorsByComponent,
-			});
-
-			return {
-				success: errors.length === 0,
-				data: errors,
-			};
-		})
-		.catch((err) => {
-			return { success: false, message: err.toString() };
-		});
+  global.app = await init("api");
+  const mode = getSchemaValidationMode();
+  const components = global.state.routes.filter((route) => route.paths.tpl);
+  const schemaValidation = validateSchemas({
+    components,
+  });
+  const schemaErrorsByComponent = new Map();
+
+  schemaValidation.errors.forEach((entry) => {
+    if (!schemaErrorsByComponent.has(entry.component)) {
+      schemaErrorsByComponent.set(entry.component, []);
+    }
+    schemaErrorsByComponent
+      .get(entry.component)
+      .push(toSchemaValidationResult(entry));
+  });
+
+  if (mode === "fail-fast" && schemaValidation.errors.length > 0) {
+    return {
+      success: false,
+      data: getLintComponentErrorsInRouteOrder({
+        components,
+        errorMap: schemaErrorsByComponent,
+      }),
+    };
+  }
+
+  const promises = components
+    .filter((route) => !schemaErrorsByComponent.has(route.paths.dir.short))
+    .map(
+      (route) =>
+        new Promise((resolve) => {
+          getComponentData(route).then((data) => {
+            const validation = validateMockData(
+              route,
+              data || [],
+              true,
+              schemaValidation.validSchemas,
+            );
+
+            resolve({
+              component: route.alias,
+              errors: validation,
+            });
+          });
+        }),
+    );
+
+  return await Promise.all(promises)
+    .then((res) => {
+      res.forEach((result) => {
+        if (!result?.errors?.length) {
+          return;
+        }
+        const componentErrors =
+          schemaErrorsByComponent.get(result.component) || [];
+        schemaErrorsByComponent.set(result.component, [
+          ...componentErrors,
+          ...result.errors,
+        ]);
+      });
+
+      const errors = getLintComponentErrorsInRouteOrder({
+        components,
+        errorMap: schemaErrorsByComponent,
+      });
+
+      return {
+        success: errors.length === 0,
+        data: errors,
+      };
+    })
+    .catch((err) => {
+      return { success: false, message: err.toString() };
+    });
 };
 
 export const lintComponent = async ({ component }) => {
-	global.app = await init("api");
-
-	const componentObject = getComponentsObject(component);
-
-	if (!componentObject)
-		return {
-			success: false,
-			message: `The component ${component} does not seem to exist.`,
-		};
-
-	const allSchemaValidation = validateSchemas({
-		components: [componentObject],
-	});
-
-	if (allSchemaValidation.errors.length > 0) {
-		return {
-			success: false,
-			data: allSchemaValidation.errors.map((entry) =>
-				toSchemaValidationResult(entry),
-			),
-		};
-	}
-
-	const data = await getComponentData(componentObject);
-	const errors = validateMockData(
-		componentObject,
-		data || [],
-		true,
-		allSchemaValidation.validSchemas,
-	);
-
-	return {
-		success: errors === null || errors?.length === 0,
-		data: errors,
-	};
+  global.app = await init("api");
+
+  const componentObject = getComponentsObject(component);
+
+  if (!componentObject)
+    return {
+      success: false,
+      message: `The component ${component} does not seem to exist.`,
+    };
+
+  const allSchemaValidation = validateSchemas({
+    components: [componentObject],
+  });
+
+  if (allSchemaValidation.errors.length > 0) {
+    return {
+      success: false,
+      data: allSchemaValidation.errors.map((entry) =>
+        toSchemaValidationResult(entry),
+      ),
+    };
+  }
+
+  const data = await getComponentData(componentObject);
+  const errors = validateMockData(
+    componentObject,
+    data || [],
+    true,
+    allSchemaValidation.validSchemas,
+  );
+
+  return {
+    success: errors === null || errors?.length === 0,
+    data: errors,
+  };
 };
 
 /**
@@ -295,9 +296,9 @@ export const lintComponent = async ({ component }) => {
  * @returns {object}
  */
 function getComponentsObject(component) {
-	return global.state.routes.find(
-		(route) => route.paths.dir.short === component,
-	);
+  return global.state.routes.find(
+    (route) => route.paths.dir.short === component,
+  );
 }
 
 /**
@@ -307,18 +308,18 @@ function getComponentsObject(component) {
  * @returns {Array<object>}
  */
 function getLintComponentErrorsInRouteOrder({ components, errorMap }) {
-	return components
-		.map((route) => {
-			const componentErrors = errorMap.get(route.alias) || [];
-
-			if (componentErrors.length === 0) {
-				return null;
-			}
-
-			return {
-				component: route.alias,
-				errors: componentErrors,
-			};
-		})
-		.filter(Boolean);
+  return components
+    .map((route) => {
+      const componentErrors = errorMap.get(route.alias) || [];
+
+      if (componentErrors.length === 0) {
+        return null;
+      }
+
+      return {
+        component: route.alias,
+        errors: componentErrors,
+      };
+    })
+    .filter(Boolean);
 }

package/bin/miyagi.js

@@ -4,7 +4,7 @@ import runCli from "../index.js";
 const result = await runCli();
 
 if (result?.shouldExit) {
-	process.exit(result.code ?? 0);
+  process.exit(result.code ?? 0);
 }
 
 process.exitCode = result?.code ?? 0;