@schalkneethling/miyagi-core 4.4.2 → 4.4.3

package/lib/init/engines.js

@@ -1,7 +1,7 @@
 import path from "path";
 import {
-	createSynchronousEnvironment,
-	createSynchronousFilesystemLoader,
+  createSynchronousEnvironment,
+  createSynchronousFilesystemLoader,
 } from "twing";
 import fs from "fs";
 import { t } from "../i18n/index.js";
@@ -15,60 +15,60 @@ import * as twingFunctions from "./twing/functions.js";
  * @returns {void}
  */
 function setMiyagiEngine() {
-	const loader = createSynchronousFilesystemLoader(fs);
-	const twing = createSynchronousEnvironment(loader, {
-		cache: new TwingCache(),
-	});
+  const loader = createSynchronousFilesystemLoader(fs);
+  const twing = createSynchronousEnvironment(loader, {
+    cache: new TwingCache(),
+  });
 
-	loader.addPath(
-		path.join(import.meta.dirname, "../../frontend/views"),
-		"@miyagi",
-	);
+  loader.addPath(
+    path.join(import.meta.dirname, "../../frontend/views"),
+    "@miyagi",
+  );
 
-	Object.values(twingFunctions).forEach((twingFunction) => {
-		twing.addFunction(twingFunction);
-	});
+  Object.values(twingFunctions).forEach((twingFunction) => {
+    twing.addFunction(twingFunction);
+  });
 
-	global.app.engine("miyagi", async (str, options, cb) =>
-		cb(await twing.render(str, options)),
-	);
+  global.app.engine("miyagi", async (str, options, cb) =>
+    cb(await twing.render(str, options)),
+  );
 }
 
 /**
  * @returns {Promise<void>}
  */
 async function setUserEngine() {
-	const { extension } = global.config.files.templates;
-	const { engine } = global.config;
+  const { extension } = global.config.files.templates;
+  const { engine } = global.config;
 
-	if (!engine.render) {
-		const message = "No render function has beend defined.";
-		log("error", message);
-		throw new MiyagiError(message, {
-			code: EXIT_CODES.CONFIG_ERROR,
-			logged: true,
-		});
-	}
+  if (!engine.render) {
+    const message = "No render function has beend defined.";
+    log("error", message);
+    throw new MiyagiError(message, {
+      code: EXIT_CODES.CONFIG_ERROR,
+      logged: true,
+    });
+  }
 
-	try {
-		global.app.engine(
-			helpers.getSingleFileExtension(extension),
-			async (name, context, cb) => await engine.render({ name, context, cb }),
-		);
-	} catch (e) {
-		const message = t("settingEngineFailed");
-		log("error", message, e);
-		throw new MiyagiError(message, {
-			code: EXIT_CODES.CONFIG_ERROR,
-			logged: true,
-		});
-	}
+  try {
+    global.app.engine(
+      helpers.getSingleFileExtension(extension),
+      async (name, context, cb) => await engine.render({ name, context, cb }),
+    );
+  } catch (e) {
+    const message = t("settingEngineFailed");
+    log("error", message, e);
+    throw new MiyagiError(message, {
+      code: EXIT_CODES.CONFIG_ERROR,
+      logged: true,
+    });
+  }
 }
 
 /**
  * @returns {Promise<void>}
  */
 export default async function initEngines() {
-	await setUserEngine();
-	setMiyagiEngine();
+  await setUserEngine();
+  setMiyagiEngine();
 }

package/lib/init/index.js

@@ -25,67 +25,67 @@ import setWatcher from "./watcher.js";
  * @returns {Promise<object>}
  */
 export default async function init(mergedConfig) {
-	// deepcode ignore UseCsurfForExpress: local server only, deepcode ignore DisablePoweredBy: local server only
-	global.app = express();
-	global.app.use(cookieParser());
-	global.config = mergedConfig;
-	global.app.set("view cache", global.config.isBuild);
-	global.app.set("cache", global.config.isBuild);
-
-	await setEngines();
-
-	const port = process.env.PORT || appConfig.defaultPort;
-
-	global.app.set("port", port);
-
-	await setState({
-		sourceTree: true,
-		menu: true,
-		partials: true,
-		fileContents: true,
-		css: true,
-	});
-
-	setStatic();
-	setRouter();
-	setViews();
-
-	if (global.config.isBuild) {
-		try {
-			const message = await build();
-			log("success", message);
-			return {
-				success: true,
-				code: EXIT_CODES.SUCCESS,
-				shouldExit: true,
-				message,
-			};
-		} catch (error) {
-			log("error", error);
-			return {
-				success: false,
-				code: EXIT_CODES.GENERAL_ERROR,
-				shouldExit: true,
-				message: String(error),
-			};
-		}
-	}
-
-	const { server, port: actualPort } = await startServer(
-		global.app.get("port"),
-	);
-
-	setWatcher(server);
-
-	log("success", `${t("serverStarted").replace("{{port}}", actualPort)}\n`);
-
-	return {
-		success: true,
-		code: EXIT_CODES.SUCCESS,
-		shouldExit: false,
-		server,
-		port: actualPort,
-	};
+  // deepcode ignore UseCsurfForExpress: local server only, deepcode ignore DisablePoweredBy: local server only
+  global.app = express();
+  global.app.use(cookieParser());
+  global.config = mergedConfig;
+  global.app.set("view cache", global.config.isBuild);
+  global.app.set("cache", global.config.isBuild);
+
+  await setEngines();
+
+  const port = process.env.PORT || appConfig.defaultPort;
+
+  global.app.set("port", port);
+
+  await setState({
+    sourceTree: true,
+    menu: true,
+    partials: true,
+    fileContents: true,
+    css: true,
+  });
+
+  setStatic();
+  setRouter();
+  setViews();
+
+  if (global.config.isBuild) {
+    try {
+      const message = await build();
+      log("success", message);
+      return {
+        success: true,
+        code: EXIT_CODES.SUCCESS,
+        shouldExit: true,
+        message,
+      };
+    } catch (error) {
+      log("error", error);
+      return {
+        success: false,
+        code: EXIT_CODES.GENERAL_ERROR,
+        shouldExit: true,
+        message: String(error),
+      };
+    }
+  }
+
+  const { server, port: actualPort } = await startServer(
+    global.app.get("port"),
+  );
+
+  setWatcher(server);
+
+  log("success", `${t("serverStarted").replace("{{port}}", actualPort)}\n`);
+
+  return {
+    success: true,
+    code: EXIT_CODES.SUCCESS,
+    shouldExit: false,
+    server,
+    port: actualPort,
+  };
 }
 
 /**
@@ -93,26 +93,26 @@ export default async function init(mergedConfig) {
  * @returns {Promise} gets resolved with the server instance and the actual port
  */
 function startServer(port) {
-	const server = http.createServer(global.app);
-
-	return new Promise((resolve) => {
-		server
-			.listen(port, function () {
-				resolve({ server, port });
-			})
-			.on("error", (error) => {
-				if (error["code"] === "EADDRINUSE") {
-					log(
-						"error",
-						t("portInUse").replace("{{port}}", port),
-						error.toString(),
-					);
-					server.close(async function () {
-						const response = await startServer(port + 1);
-
-						resolve(response);
-					});
-				}
-			});
-	});
+  const server = http.createServer(global.app);
+
+  return new Promise((resolve) => {
+    server
+      .listen(port, function () {
+        resolve({ server, port });
+      })
+      .on("error", (error) => {
+        if (error["code"] === "EADDRINUSE") {
+          log(
+            "error",
+            t("portInUse").replace("{{port}}", port),
+            error.toString(),
+          );
+          server.close(async function () {
+            const response = await startServer(port + 1);
+
+            resolve(response);
+          });
+        }
+      });
+  });
 }

package/lib/init/rendering.js

@@ -6,7 +6,7 @@ import init from "./index.js";
  * @returns {Promise<object>}
  */
 export default async function initRendering(config) {
-	if (config) {
-		return await init(config);
-	}
+  if (config) {
+    return await init(config);
+  }
 }

package/lib/init/static.js

@@ -11,68 +11,68 @@ import config from "../default-config.js";
  * @returns {void}
  */
 function registerUserAssetFolder() {
-	const { assets } = global.config;
-
-	if (assets && assets.folder) {
-		for (const folder of assets.folder) {
-			global.app.use(
-				path.join("/", folder),
-				express.static(path.join(assets.root, folder)),
-			);
-		}
-	}
+  const { assets } = global.config;
+
+  if (assets && assets.folder) {
+    for (const folder of assets.folder) {
+      global.app.use(
+        path.join("/", folder),
+        express.static(path.join(assets.root, folder)),
+      );
+    }
+  }
 }
 
 /**
  * @returns {void}
  */
 function registerThemeFavicon() {
-	if (global.config.ui && global.config.ui.theme) {
-		const file = global.config.ui.theme.favicon;
+  if (global.config.ui && global.config.ui.theme) {
+    const file = global.config.ui.theme.favicon;
 
-		if (file) {
-			global.app.use(`/favicon.ico`, express.static(path.resolve(file)));
-		}
-	}
+    if (file) {
+      global.app.use(`/favicon.ico`, express.static(path.resolve(file)));
+    }
+  }
 }
 
 /**
  * @returns {void}
  */
 function registerThemeLogo() {
-	const files = [
-		global.config.ui.theme.logo.light,
-		global.config.ui.theme.logo.dark,
-	];
-
-	files.forEach((file) => {
-		if (file) {
-			global.app.use(
-				path.join("/", path.dirname(file)),
-				express.static(path.resolve(path.dirname(file))),
-			);
-		}
-	});
+  const files = [
+    global.config.ui.theme.logo.light,
+    global.config.ui.theme.logo.dark,
+  ];
+
+  files.forEach((file) => {
+    if (file) {
+      global.app.use(
+        path.join("/", path.dirname(file)),
+        express.static(path.resolve(path.dirname(file))),
+      );
+    }
+  });
 }
 
 /**
  * @param {("css"|"js")} files - the type of user assets that should be registered
  */
 function registerUserFiles(files) {
-	const { assets } = global.config;
+  const { assets } = global.config;
 
-	if (assets) {
-		for (const file of assets[files]) {
-			const asset = files === "js" ? file.src : file;
+  if (assets) {
+    for (const file of assets[files]) {
+      const asset = files === "js" ? file.src : file;
 
-			if (asset.startsWith("https://")) continue;
+      if (asset.startsWith("https://")) continue;
 
-			global.app.use(
-				path.join("/", path.dirname(asset)),
-				express.static(path.join(assets.root, path.dirname(asset))),
-			);
-		}
-	}
+      global.app.use(
+        path.join("/", path.dirname(asset)),
+        express.static(path.join(assets.root, path.dirname(asset))),
+      );
+    }
+  }
 }
 
 /**
@@ -80,84 +80,84 @@ function registerUserFiles(files) {
  * @returns {void}
  */
 function registerSharedFiles() {
-	const { assets } = global.config;
+  const { assets } = global.config;
 
-	if (!assets?.shared) return;
+  if (!assets?.shared) return;
 
-	for (const file of assets.shared.css || []) {
-		if (file.startsWith("https://")) continue;
+  for (const file of assets.shared.css || []) {
+    if (file.startsWith("https://")) continue;
 
-		global.app.use(
-			path.join("/", path.dirname(file)),
-			express.static(path.join(assets.root, path.dirname(file))),
-		);
-	}
+    global.app.use(
+      path.join("/", path.dirname(file)),
+      express.static(path.join(assets.root, path.dirname(file))),
+    );
+  }
 
-	for (const file of assets.shared.js || []) {
-		const src = file.src || file;
-		if (src.startsWith("https://")) continue;
+  for (const file of assets.shared.js || []) {
+    const src = file.src || file;
+    if (src.startsWith("https://")) continue;
 
-		global.app.use(
-			path.join("/", path.dirname(src)),
-			express.static(path.join(assets.root, path.dirname(src))),
-		);
-	}
+    global.app.use(
+      path.join("/", path.dirname(src)),
+      express.static(path.join(assets.root, path.dirname(src))),
+    );
+  }
 }
 
 /**
  * @returns {void}
  */
 function registerCustomPropertyFiles() {
-	const { assets } = global.config;
-
-	if (assets?.customProperties?.files) {
-		for (const file of assets.customProperties.files) {
-			global.app.use(
-				path.join("/", path.dirname(file)),
-				express.static(path.dirname(file)),
-			);
-		}
-	}
+  const { assets } = global.config;
+
+  if (assets?.customProperties?.files) {
+    for (const file of assets.customProperties.files) {
+      global.app.use(
+        path.join("/", path.dirname(file)),
+        express.static(path.dirname(file)),
+      );
+    }
+  }
 }
 
 /**
  * @returns {void}
  */
 function registerAssetFolder() {
-	const assetFolder =
-		config.folders.assets[
-			process.env.MIYAGI_DEVELOPMENT ? "development" : "production"
-		];
-
-	global.app.use(
-		`/${config.projectName}`,
-		express.static(path.join(import.meta.dirname, `../../${assetFolder}`)),
-	);
+  const assetFolder =
+    config.folders.assets[
+      process.env.MIYAGI_DEVELOPMENT ? "development" : "production"
+    ];
+
+  global.app.use(
+    `/${config.projectName}`,
+    express.static(path.join(import.meta.dirname, `../../${assetFolder}`)),
+  );
 }
 
 /**
  * @returns {void}
  */
 function registerUserComponentAssets() {
-	if (!global.config.components.folder) return;
+  if (!global.config.components.folder) return;
 
-	global.app.use(
-		path.join("/", global.config.components.folder),
-		express.static(global.config.components.folder),
-	);
+  global.app.use(
+    path.join("/", global.config.components.folder),
+    express.static(global.config.components.folder),
+  );
 }
 
 /**
  * @returns {void}
  */
 export default function initStatic() {
-	registerThemeFavicon();
-	registerThemeLogo();
-	registerUserAssetFolder();
-	registerUserComponentAssets();
-	registerUserFiles("css");
-	registerUserFiles("js");
-	registerSharedFiles();
-	registerCustomPropertyFiles();
-	registerAssetFolder();
+  registerThemeFavicon();
+  registerThemeLogo();
+  registerUserAssetFolder();
+  registerUserComponentAssets();
+  registerUserFiles("css");
+  registerUserFiles("js");
+  registerSharedFiles();
+  registerCustomPropertyFiles();
+  registerAssetFolder();
 }

package/lib/init/twing/cache.js

@@ -1,34 +1,34 @@
 export default class TwingCache {
-	#cache = new Map();
+  #cache = new Map();
 
-	/**
-	 * @param {string} key
-	 * @returns {object|null}
-	 */
-	load(key) {
-		if (this.#cache.get(key)?.content) {
-			return this.#cache.get(key)?.content;
-		}
+  /**
+   * @param {string} key
+   * @returns {object|null}
+   */
+  load(key) {
+    if (this.#cache.get(key)?.content) {
+      return this.#cache.get(key)?.content;
+    }
 
-		return null;
-	}
+    return null;
+  }
 
-	/**
-	 * @param {string} key
-	 * @param {object} content
-	 */
-	write(key, content) {
-		const timestamp = new Date().getTime();
-		const value = { content, timestamp };
+  /**
+   * @param {string} key
+   * @param {object} content
+   */
+  write(key, content) {
+    const timestamp = new Date().getTime();
+    const value = { content, timestamp };
 
-		this.#cache.set(key, value);
-	}
+    this.#cache.set(key, value);
+  }
 
-	/**
-	 * @param {string} key
-	 * @returns {number|null}
-	 */
-	getTimestamp(key) {
-		return this.#cache.get(key)?.timestamp ?? null;
-	}
+  /**
+   * @param {string} key
+   * @returns {number|null}
+   */
+  getTimestamp(key) {
+    return this.#cache.get(key)?.timestamp ?? null;
+  }
 }