@schalkneethling/miyagi-core 4.4.2 → 4.4.3

package/lib/state/menu/index.js

@@ -13,26 +13,26 @@ import { getMenu as getDocsMenu } from "../docs.js";
  * @returns {Array} file tree object of the component file in the given directory
  */
 function getComponentFiles(directory) {
-	return directory.children.filter((child) => {
-		const baseName =
-			global.config.files.templates.name === "<component>"
-				? child.name.replace(`.${global.config.files.templates.extension}`, "")
-				: global.config.files.templates.name;
-
-		if (helpers.docFileIsIndexFile(child.path)) return true;
-
-		if (helpers.fileIsTemplateFile(child.name)) {
-			if (
-				global.config.files.templates.name === "<component>" &&
-				directory.name === baseName
-			)
-				return true;
-
-			if (global.config.files.templates.name === baseName) return true;
-		}
-
-		return false;
-	});
+  return directory.children.filter((child) => {
+    const baseName =
+      global.config.files.templates.name === "<component>"
+        ? child.name.replace(`.${global.config.files.templates.extension}`, "")
+        : global.config.files.templates.name;
+
+    if (helpers.docFileIsIndexFile(child.path)) return true;
+
+    if (helpers.fileIsTemplateFile(child.name)) {
+      if (
+        global.config.files.templates.name === "<component>" &&
+        directory.name === baseName
+      )
+        return true;
+
+      if (global.config.files.templates.name === baseName) return true;
+    }
+
+    return false;
+  });
 }
 
 /**
@@ -40,11 +40,11 @@ function getComponentFiles(directory) {
  * @returns {boolean} returns true if the given directory has a component file with the same name
  */
 function hasComponentFileWithCorrectNameAsChild(directory) {
-	return (
-		directory.children &&
-		directory.children.length &&
-		getComponentFiles(directory).length > 0
-	);
+  return (
+    directory.children &&
+    directory.children.length &&
+    getComponentFiles(directory).length > 0
+  );
 }
 
 /**
@@ -52,38 +52,38 @@ function hasComponentFileWithCorrectNameAsChild(directory) {
  * @returns {object} adapted file tree object
  */
 function getDataForLinkedDirectory(directory) {
-	const shortPath = helpers.getShortPathFromFullPath(directory.path);
-	const normalizedShortPath = helpers.normalizeString(shortPath);
-	const name = directory.name.replaceAll("-", " ");
-
-	return {
-		type: directory.type,
-		section: "components",
-		name,
-		fullPath: directory.path,
-		shortPath,
-		normalizedShortPath,
-		url: global.config.isBuild
-			? `/component-${normalizedShortPath}-embedded.html`
-			: `/component?file=${shortPath}&embedded=true`,
-		variations:
-			directory.variations.map((variation) => {
-				const normalizedName = helpers.normalizeString(variation.name);
-
-				return {
-					...variation,
-					normalizedName,
-					parentShortPath: shortPath,
-					url: global.config.isBuild
-						? `component-${normalizedShortPath}-variation-${normalizedName}-embedded.html`
-						: `/component?file=${shortPath}&variation=${encodeURIComponent(
-								variation.name,
-							)}&embedded=true`,
-				};
-			}) || [],
-		index: directory.index,
-		id: normalizedShortPath,
-	};
+  const shortPath = helpers.getShortPathFromFullPath(directory.path);
+  const normalizedShortPath = helpers.normalizeString(shortPath);
+  const name = directory.name.replaceAll("-", " ");
+
+  return {
+    type: directory.type,
+    section: "components",
+    name,
+    fullPath: directory.path,
+    shortPath,
+    normalizedShortPath,
+    url: global.config.isBuild
+      ? `/component-${normalizedShortPath}-embedded.html`
+      : `/component?file=${shortPath}&embedded=true`,
+    variations:
+      directory.variations.map((variation) => {
+        const normalizedName = helpers.normalizeString(variation.name);
+
+        return {
+          ...variation,
+          normalizedName,
+          parentShortPath: shortPath,
+          url: global.config.isBuild
+            ? `component-${normalizedShortPath}-variation-${normalizedName}-embedded.html`
+            : `/component?file=${shortPath}&variation=${encodeURIComponent(
+                variation.name,
+              )}&embedded=true`,
+        };
+      }) || [],
+    index: directory.index,
+    id: normalizedShortPath,
+  };
 }
 
 /**
@@ -91,26 +91,26 @@ function getDataForLinkedDirectory(directory) {
  * @returns {object}
  */
 function getDataForDocumentationFile(file) {
-	const shortPath = helpers
-		.getShortPathFromFullPath(file.path)
-		.replace(".md", "");
-	const normalizedShortPath = helpers.normalizeString(shortPath);
-
-	return {
-		type: file.type,
-		name: path
-			.basename(file.name, ".md")
-			.replaceAll("-", " ")
-			.replaceAll("_", " "),
-		fullPath: file.path,
-		shortPath,
-		normalizedShortPath,
-		url: global.config.isBuild
-			? `/component-${normalizedShortPath}-embedded.html`
-			: `/component?file=${shortPath}&embedded=true`,
-		index: file.index,
-		id: normalizedShortPath,
-	};
+  const shortPath = helpers
+    .getShortPathFromFullPath(file.path)
+    .replace(".md", "");
+  const normalizedShortPath = helpers.normalizeString(shortPath);
+
+  return {
+    type: file.type,
+    name: path
+      .basename(file.name, ".md")
+      .replaceAll("-", " ")
+      .replaceAll("_", " "),
+    fullPath: file.path,
+    shortPath,
+    normalizedShortPath,
+    url: global.config.isBuild
+      ? `/component-${normalizedShortPath}-embedded.html`
+      : `/component?file=${shortPath}&embedded=true`,
+    index: file.index,
+    id: normalizedShortPath,
+  };
 }
 
 /**
@@ -118,19 +118,19 @@ function getDataForDocumentationFile(file) {
  * @returns {object} adapted file tree object
  */
 function getDataForDirectory(directory) {
-	const shortPath = path.relative(
-		path.join(process.cwd(), global.config.components.folder),
-		directory.path,
-	);
-
-	return {
-		type: directory.type,
-		name: directory.name.replaceAll("-", " "),
-		fullPath: directory.path,
-		shortPath,
-		index: directory.index,
-		id: helpers.normalizeString(shortPath),
-	};
+  const shortPath = path.relative(
+    path.join(process.cwd(), global.config.components.folder),
+    directory.path,
+  );
+
+  return {
+    type: directory.type,
+    name: directory.name.replaceAll("-", " "),
+    fullPath: directory.path,
+    shortPath,
+    index: directory.index,
+    id: helpers.normalizeString(shortPath),
+  };
 }
 
 /**
@@ -138,15 +138,15 @@ function getDataForDirectory(directory) {
  * @returns {object} adapted file tree object
  */
 function restructureDirectory(directory) {
-	let item;
+  let item;
 
-	if (hasComponentFileWithCorrectNameAsChild(directory)) {
-		item = getDataForLinkedDirectory(directory);
-	} else {
-		item = getDataForDirectory(directory);
-	}
+  if (hasComponentFileWithCorrectNameAsChild(directory)) {
+    item = getDataForLinkedDirectory(directory);
+  } else {
+    item = getDataForDirectory(directory);
+  }
 
-	return item;
+  return item;
 }
 
 /**
@@ -154,7 +154,7 @@ function restructureDirectory(directory) {
  * @returns {boolean} returns true if the given file tree object has children
  */
 function hasChildren(item) {
-	return item.children && item.children.length > 0;
+  return item.children && item.children.length > 0;
 }
 
 /**
@@ -162,114 +162,114 @@ function hasChildren(item) {
  * @returns {object[]} array with adapted menu items
  */
 export const getMenu = function (sourceTree) {
-	const srcStructure = getSourceStructure();
-	const arr = [];
-	let componentsMenu;
-
-	(function restructure(structure, array) {
-		for (const item of structure) {
-			if (item.type === "directory") {
-				const restructured = restructureDirectory(item);
-
-				if (hasChildren(item)) {
-					restructured.children = [];
-					restructure(item.children, restructured.children);
-
-					if (restructured.children.length === 0) {
-						delete restructured.children;
-					}
-
-					if (restructured.children) {
-						restructured.children.sort(function (a, b) {
-							const nameA = a.name.toLowerCase();
-							const nameB = b.name.toLowerCase();
-
-							if (nameA < nameB) return -1;
-							if (nameA > nameB) return 1;
-
-							return 0;
-						});
-					}
-				}
-				array.push(restructured);
-			} else if (
-				helpers.fileIsDocumentationFile(item.path) &&
-				!item.path.endsWith("index.md") &&
-				!item.path.endsWith("README.md") &&
-				path.basename(item.path, ".md") !==
-					path.dirname(item.path).split("/")[
-						path.dirname(item.path).split("/").length - 1
-					]
-			) {
-				array.push(getDataForDocumentationFile(item));
-			}
-		}
-	})(srcStructure, arr);
-
-	if (arr.length > 0) {
-		componentsMenu = {
-			topLevel: true,
-			section: "components",
-			name: "components",
-			type: "directory",
-			shortPath: "components",
-			file: null,
-			children: arr,
-			id: "components",
-		};
-	}
-
-	const docsMenu = getDocsMenu(sourceTree.docs);
-	const designTokensMenu = getDesignTokensMenu();
-
-	if (!docsMenu && !designTokensMenu && componentsMenu)
-		return componentsMenu.children;
-
-	const menus = [];
-	if (designTokensMenu) menus.push(designTokensMenu);
-	if (componentsMenu) menus.push(componentsMenu);
-	if (docsMenu) menus.push(docsMenu);
-
-	return menus;
+  const srcStructure = getSourceStructure();
+  const arr = [];
+  let componentsMenu;
+
+  (function restructure(structure, array) {
+    for (const item of structure) {
+      if (item.type === "directory") {
+        const restructured = restructureDirectory(item);
+
+        if (hasChildren(item)) {
+          restructured.children = [];
+          restructure(item.children, restructured.children);
+
+          if (restructured.children.length === 0) {
+            delete restructured.children;
+          }
+
+          if (restructured.children) {
+            restructured.children.sort(function (a, b) {
+              const nameA = a.name.toLowerCase();
+              const nameB = b.name.toLowerCase();
+
+              if (nameA < nameB) return -1;
+              if (nameA > nameB) return 1;
+
+              return 0;
+            });
+          }
+        }
+        array.push(restructured);
+      } else if (
+        helpers.fileIsDocumentationFile(item.path) &&
+        !item.path.endsWith("index.md") &&
+        !item.path.endsWith("README.md") &&
+        path.basename(item.path, ".md") !==
+          path.dirname(item.path).split("/")[
+            path.dirname(item.path).split("/").length - 1
+          ]
+      ) {
+        array.push(getDataForDocumentationFile(item));
+      }
+    }
+  })(srcStructure, arr);
+
+  if (arr.length > 0) {
+    componentsMenu = {
+      topLevel: true,
+      section: "components",
+      name: "components",
+      type: "directory",
+      shortPath: "components",
+      file: null,
+      children: arr,
+      id: "components",
+    };
+  }
+
+  const docsMenu = getDocsMenu(sourceTree.docs);
+  const designTokensMenu = getDesignTokensMenu();
+
+  if (!docsMenu && !designTokensMenu && componentsMenu)
+    return componentsMenu.children;
+
+  const menus = [];
+  if (designTokensMenu) menus.push(designTokensMenu);
+  if (componentsMenu) menus.push(componentsMenu);
+  if (docsMenu) menus.push(docsMenu);
+
+  return menus;
 };
 
 /**
  * @returns {object}
  */
 function getDesignTokensMenu() {
-	if (global.config.assets.customProperties.files.length === 0) return null;
-
-	return {
-		topLevel: true,
-		name: "Design Tokens",
-		id: "design-tokens",
-		type: "directory",
-		shortPath: "design-tokens",
-		children: [
-			{
-				section: "design-tokens",
-				type: "file",
-				name: "colors",
-				url: global.config.isBuild
-					? "iframe-design-tokens-colors.html"
-					: "/iframe/design-tokens/colors",
-			},
-			{
-				section: "design-tokens",
-				type: "file",
-				name: "sizes",
-				url: global.config.isBuild
-					? "iframe-design-tokens-sizes.html"
-					: "/iframe/design-tokens/sizes",
-			},
-			{
-				section: "design-tokens",
-				type: "file",
-				name: "typography",
-				url: global.config.isBuild
-					? "iframe-design-tokens-typography.html"
-					: "/iframe/design-tokens/typography",
-			},
-		],
-	};
+  if (global.config.assets.customProperties.files.length === 0) return null;
+
+  return {
+    topLevel: true,
+    name: "Design Tokens",
+    id: "design-tokens",
+    type: "directory",
+    shortPath: "design-tokens",
+    children: [
+      {
+        section: "design-tokens",
+        type: "file",
+        name: "colors",
+        url: global.config.isBuild
+          ? "iframe-design-tokens-colors.html"
+          : "/iframe/design-tokens/colors",
+      },
+      {
+        section: "design-tokens",
+        type: "file",
+        name: "sizes",
+        url: global.config.isBuild
+          ? "iframe-design-tokens-sizes.html"
+          : "/iframe/design-tokens/sizes",
+      },
+      {
+        section: "design-tokens",
+        type: "file",
+        name: "typography",
+        url: global.config.isBuild
+          ? "iframe-design-tokens-typography.html"
+          : "/iframe/design-tokens/typography",
+      },
+    ],
+  };
 }

package/lib/state/menu/structure.js

@@ -14,46 +14,46 @@ import * as helpers from "../../helpers.js";
  * @returns {Array} all valid variation objects
  */
 function getAllValidVariations(json, fullPath) {
-	let arr = [];
-
-	if (json) {
-		const variations = json.$variants;
-		const rootData = helpers.removeInternalKeys(json);
-
-		if (Object.keys(rootData).length > 0 && !json.$hidden) {
-			arr.push({
-				name: json.$name || config.defaultVariationName,
-				data: rootData,
-			});
-		}
-
-		if (variations) {
-			for (const [i, variation] of variations.entries()) {
-				const variationData = helpers.removeInternalKeys(variation);
-				if (variation.$name) {
-					arr.push({
-						name: variation.$name,
-						data: variationData,
-					});
-				} else if (fullPath) {
-					const shortPath = helpers.getShortPathFromFullPath(fullPath);
-					log(
-						"warn",
-						t("noNameSetForVariation")
-							.replace("{{i}}", i)
-							.replace("{{file}}", shortPath),
-					);
-				}
-			}
-		}
-	} else {
-		arr.push({
-			name: config.defaultVariationName,
-			data: {},
-		});
-	}
-
-	return arr;
+  let arr = [];
+
+  if (json) {
+    const variations = json.$variants;
+    const rootData = helpers.removeInternalKeys(json);
+
+    if (Object.keys(rootData).length > 0 && !json.$hidden) {
+      arr.push({
+        name: json.$name || config.defaultVariationName,
+        data: rootData,
+      });
+    }
+
+    if (variations) {
+      for (const [i, variation] of variations.entries()) {
+        const variationData = helpers.removeInternalKeys(variation);
+        if (variation.$name) {
+          arr.push({
+            name: variation.$name,
+            data: variationData,
+          });
+        } else if (fullPath) {
+          const shortPath = helpers.getShortPathFromFullPath(fullPath);
+          log(
+            "warn",
+            t("noNameSetForVariation")
+              .replace("{{i}}", i)
+              .replace("{{file}}", shortPath),
+          );
+        }
+      }
+    }
+  } else {
+    arr.push({
+      name: config.defaultVariationName,
+      data: {},
+    });
+  }
+
+  return arr;
 }
 
 /**
@@ -61,13 +61,13 @@ function getAllValidVariations(json, fullPath) {
  * @returns {object[]} all valid variations for the given mock file
  */
 function getData(mockFilePath) {
-	let result;
+  let result;
 
-	if (mockFilePath && global.state.fileContents[mockFilePath]) {
-		result = global.state.fileContents[mockFilePath];
-	}
+  if (mockFilePath && global.state.fileContents[mockFilePath]) {
+    result = global.state.fileContents[mockFilePath];
+  }
 
-	return getAllValidVariations(result, mockFilePath);
+  return getAllValidVariations(result, mockFilePath);
 }
 
 /**
@@ -75,27 +75,27 @@ function getData(mockFilePath) {
  * @returns {Array} all variations for the mock file of the given file tree object
  */
 function getVariations(obj) {
-	const { mocks } = global.config.files;
-	const tplChild = obj.children.find(
-		(o) =>
-			o.name ===
-			`${helpers.getResolvedFileName(
-				global.config.files.templates.name,
-				obj.name,
-			)}.${global.config.files.templates.extension}`,
-	);
-	const jsonChild = obj.children.find((o) =>
-		[
-			`${mocks.name}.${mocks.extension[0]}`,
-			`${mocks.name}.${mocks.extension[1]}`,
-		].includes(o.name),
-	);
-
-	if (tplChild) {
-		return getData(jsonChild ? jsonChild.path : null);
-	}
-
-	return [];
+  const { mocks } = global.config.files;
+  const tplChild = obj.children.find(
+    (o) =>
+      o.name ===
+      `${helpers.getResolvedFileName(
+        global.config.files.templates.name,
+        obj.name,
+      )}.${global.config.files.templates.extension}`,
+  );
+  const jsonChild = obj.children.find((o) =>
+    [
+      `${mocks.name}.${mocks.extension[0]}`,
+      `${mocks.name}.${mocks.extension[1]}`,
+    ].includes(o.name),
+  );
+
+  if (tplChild) {
+    return getData(jsonChild ? jsonChild.path : null);
+  }
+
+  return [];
 }
 
 /**
@@ -103,14 +103,14 @@ function getVariations(obj) {
  * @returns {object} the updated object
  */
 function updateSourceObject(obj) {
-	const o = { ...obj };
+  const o = { ...obj };
 
-	if (o.children) {
-		o.variations = getVariations(o);
-		o.children = o.children.map((child) => updateSourceObject(child));
-	}
+  if (o.children) {
+    o.variations = getVariations(o);
+    o.children = o.children.map((child) => updateSourceObject(child));
+  }
 
-	return o;
+  return o;
 }
 
 /**
@@ -121,26 +121,26 @@ function updateSourceObject(obj) {
  * @returns {object} the updated object
  */
 function addIndices(obj, index) {
-	const o = { ...obj };
-	o.index = index;
+  const o = { ...obj };
+  o.index = index;
 
-	if (o.children) {
-		o.children = o.children.map((child) => {
-			delete child.size;
-			return addIndices(child, child.type === "directory" ? index + 1 : index);
-		});
-	}
+  if (o.children) {
+    o.children = o.children.map((child) => {
+      delete child.size;
+      return addIndices(child, child.type === "directory" ? index + 1 : index);
+    });
+  }
 
-	return o;
+  return o;
 }
 
 /**
  * @returns {object}
  */
 export default function setMenuStructure() {
-	let result = updateSourceObject(global.state.sourceTree.components);
+  let result = updateSourceObject(global.state.sourceTree.components);
 
-	result = addIndices(result, -1);
+  result = addIndices(result, -1);
 
-	return result && result.children ? result.children : [];
+  return result && result.children ? result.children : [];
 }