@jungvonmatt/cssg-plugin-hugo 1.1.0 → 1.4.0

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.4.0](https://github.com/jungvonmatt/contentful-ssg/compare/v1.3.2...v1.4.0) (2022-01-19)
+
+**Note:** Version bump only for package @jungvonmatt/cssg-plugin-hugo
+
+
+
+
+
+## [1.3.2](https://github.com/jungvonmatt/contentful-ssg/compare/v1.3.1...v1.3.2) (2022-01-14)
+
+**Note:** Version bump only for package @jungvonmatt/cssg-plugin-hugo
+
+
+
+
+
+# [1.3.0](https://github.com/jungvonmatt/contentful-ssg/compare/v1.2.0...v1.3.0) (2022-01-10)
+
+
+### Features
+
+* 🎸 Consider menu reference in page node when building menu ([42499a4](https://github.com/jungvonmatt/contentful-ssg/commit/42499a4efb2f25275d8ea4fb74f72461aa441ba0))
+
+
+
+
+
+# [1.2.0](https://github.com/jungvonmatt/contentful-ssg/compare/v1.1.1...v1.2.0) (2021-12-21)
+
+
+### Features
+
+* 🎸 Generates hugo's menu.toml ([27e95a3](https://github.com/jungvonmatt/contentful-ssg/commit/27e95a33452b1aa5158ee89070889383cee4b6c5))
+
+
+
+
+
 # [1.1.0](https://github.com/jungvonmatt/contentful-ssg/compare/v1.0.6...v1.1.0) (2021-12-02)
 
 

package/index.js

@@ -20,9 +20,16 @@ const defaultOptions = {
   translationStrategy: STRATEGY_DIRECTORY,
   typeIdI18n: 'd-i18n',
   languageConfig: true,
+  menuDepth: 0,
+  autoSubMenu: false,
+  typeIdMenu: 'c-menu',
   fieldIdHome: 'home',
   fieldIdSlug: 'slug',
   fieldIdParent: 'parent_page',
+  fieldIdMenu: 'menu',
+  fieldIdMenuEntries: 'entries',
+  fieldIdMenuHide: 'hide_in_menu',
+  fieldIdMenuPos: 'menu_pos',
   typeConfig: {
     [TYPE_CONTENT]: ['page'],
   },
@@ -61,6 +68,136 @@ export default (args) => {
     return type;
   };
 
+  const buildMenu = async (transformContext, depth = 0) => {
+    const { entry, entryMap } = transformContext;
+    const entries = entry.fields?.[options.fieldIdMenuEntries] ?? [];
+    const nodes = entries
+      .filter((node) => node?.sys?.id && node?.sys?.contentType?.sys?.id)
+      .map((node, index) => ({
+        identifier: node.sys.id,
+        weight: (index + 1) * -10,
+        params: {
+          id: node.sys.id,
+          // eslint-disable-next-line camelcase
+          content_type: node.sys.contentType.sys.id,
+        },
+      }));
+
+    // Resolve page entry
+    const resolvePageEntry = async (entry) => {
+      const id = entry?.sys?.id ?? 0;
+      const node = entryMap.get(id);
+      const contentType = node?.sys?.contentType?.sys?.id ?? '';
+      const pageId = node?.fields?.link_to_entry?.sys?.id;
+      if (contentType === 'page') {
+        return node;
+      }
+
+      if (pageId) {
+        return entryMap.get(pageId);
+      }
+
+      if (typeof options.resolvePage === 'function') {
+        return options.resolvePage(entry, entryMap);
+      }
+    };
+
+    const getChildnodesManual = async (entry, depth, ids = []) => {
+      const id = entry?.sys?.id ?? 0;
+      const page = await resolvePageEntry(entry);
+      const contentType = page?.sys?.contentType?.sys?.id ?? '';
+      const menuId = page?.fields?.[options.fieldIdMenu]?.sys?.id;
+
+      if (
+        !id ||
+        !contentType ||
+        !menuId ||
+        !entryMap.has(menuId) ||
+        ids.includes(id) ||
+        depth <= 0
+      ) {
+        return [];
+      }
+
+      const menu = entryMap.get(menuId);
+      const subentries = menu?.fields?.[options.fieldIdMenuEntries] ?? [];
+
+      const collected = await Promise.all(
+        subentries.flatMap((node) => getChildnodesManual(node, depth - 1, [...ids, id]))
+      );
+
+      return [
+        ...subentries
+          .filter((node) => node?.sys?.id && node?.sys?.contentType?.sys?.id)
+          .map((node, index) => ({
+            identifier: node.sys.id,
+            parent: id,
+            weight: (index + 1) * -10,
+            params: {
+              id: node.sys.id,
+              // eslint-disable-next-line camelcase
+              content_type: node.sys.contentType.sys.id,
+            },
+          })),
+        ...collected,
+      ];
+    };
+
+    const getChildnodesRecursive = async (entry, depth) => {
+      const id = entry?.sys?.id ?? 0;
+      const page = await resolvePageEntry(id);
+      const contentType = page?.sys?.contentType?.sys?.id ?? '';
+
+      if (!id || !contentType || depth <= 0) {
+        return [];
+      }
+
+      const childnodes = [...entryMap.values()].filter(
+        (entry) => (entry?.fields?.[options.fieldIdParent]?.sys?.id ?? '') === id
+      );
+
+      // Filter childnodes based on hide_in_menu field
+      const filtered = childnodes.filter(
+        (entry) => !(entry?.fields?.[options.fieldIdMenuHide] ?? false)
+      );
+
+      // Sort based on menuPos field
+      const sorted = [...filtered].sort(
+        (a, b) =>
+          (a?.fields?.[options.fieldIdMenuPos] ?? Number.MAX_SAFE_INTEGER) -
+          (b?.fields?.[options.fieldIdMenuPos] ?? Number.MAX_SAFE_INTEGER)
+      );
+
+      return Array.from(
+        await Promise.allSettled([
+          ...sorted
+            .filter((node) => node?.sys?.id && node?.sys?.contentType?.sys?.id)
+            .map((node, index) => ({
+              identifier: node.sys.id,
+              parent: id,
+              weight: (index + 1) * -10,
+              params: {
+                id: node.sys.id,
+                // eslint-disable-next-line camelcase
+                content_type: node.sys.contentType.sys.id,
+              },
+            })),
+          ...sorted.flatMap((node) => getChildnodesRecursive(node, depth - 1)),
+        ])
+      )
+        .map((a) => a.value)
+        .filter((v) => v);
+    };
+
+    // When autoSubMenu parameter is set, we collect child pages automatically
+    // Otherwise we look for dedicated menu entries in page nodes
+    const childentries = options.autoSubMenu
+      ? await Promise.all(entries.flatMap((node) => getChildnodesRecursive(node, depth)))
+      : await Promise.all(entries.flatMap((node) => getChildnodesManual(node, depth)));
+
+    return [...nodes, ...childentries].flat(Infinity).filter((v) => v);
+  };
+
   return {
     config(prev) {
       const { managedDirectories } = prev || {};
@@ -76,10 +213,10 @@ export default (args) => {
       // Initialize getSettings
       const getSettings = getSettingsHelper(runtimeContext);
       helper.getSettings = getSettings;
-      // Write config toml according to locale settings in contentful
+      // Write config yaml according to locale settings in contentful
       if (options.languageConfig) {
         const rootDir = runtimeContext?.config?.rootDir ?? process.cwd();
-        const dst = path.join(rootDir, 'config/_default/languages.toml');
+        const dst = path.join(rootDir, 'config/_default/languages.yaml');
         const languageConfig = Object.fromEntries(
           locales.map((locale) => {
             const { code, name: languageName } = locale;
@@ -105,7 +242,7 @@ export default (args) => {
             ];
           })
         );
-        await outputFile(dst, converter.toml.stringify(languageConfig));
+        await outputFile(dst, converter.yaml.stringify(languageConfig));
       }
 
       // Find section pages and add them to the runtimeconfig
@@ -125,8 +262,9 @@ export default (args) => {
       );
 
       const i18n = Object.fromEntries(locales.map((locale) => [locale.code, {}]));
+      const menus = Object.fromEntries(locales.map((locale) => [locale.code, {}]));
 
-      return { ...runtimeContext, helper, localized: enhancedLocalized, i18n };
+      return { ...runtimeContext, helper, localized: enhancedLocalized, i18n, menus };
     },
 
     /**
@@ -231,7 +369,7 @@ export default (args) => {
     },
 
     async transform(transformContext, runtimeContext) {
-      const { content, id, contentTypeId, locale } = transformContext;
+      const { content, id, contentTypeId, locale, entry } = transformContext;
 
       const type = getEntryType(transformContext);
 
@@ -247,6 +385,15 @@ export default (args) => {
         return undefined;
       }
 
+      // Automatically build hugo menus
+      // See https://gohugo.io/content-management/menus/
+      if (options.typeIdMenu && contentTypeId === options.typeIdMenu) {
+        const { name = 'main' } = entry.fields;
+        const menu = await buildMenu(transformContext, options.menuDepth);
+
+        runtimeContext.menus[locale.code][name] = menu;
+      }
+
       if (type === TYPE_CONTENT) {
         return {
           ...snakeCaseKeys({
@@ -261,17 +408,26 @@ export default (args) => {
 
     async after(runtimeContext) {
       const contentDir = runtimeContext.config.directory;
-      const { toml } = runtimeContext.converter;
+      const { yaml } = runtimeContext.converter;
       const i18n = runtimeContext?.i18n ?? {};
 
       await Promise.all(
         Object.entries(i18n).map(async ([localeCode, translations]) => {
-          const dictionaryPath = path.join(contentDir, `../i18n/${localeCode}.toml`);
+          const dictionaryPath = path.join(contentDir, `../i18n/${localeCode}.yaml`);
           const oldContent = existsSync(dictionaryPath)
-            ? toml.parse(await readFile(dictionaryPath, 'utf8'))
+            ? yaml.parse(await readFile(dictionaryPath, 'utf8'))
             : {};
 
-          return outputFile(dictionaryPath, toml.stringify({ ...oldContent, ...translations }));
+          return outputFile(dictionaryPath, yaml.stringify({ ...oldContent, ...translations }));
+        })
+      );
+
+      const menus = runtimeContext?.menus ?? {};
+      await Promise.all(
+        Object.entries(menus).map(([localeCode, menuData]) => {
+          const file = `config/_default/menus.${localeCode}.yaml`;
+          const data = yaml.stringify(menuData);
+          return outputFile(file, data);
         })
       );
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/cssg-plugin-hugo",
-  "version": "1.1.0",
+  "version": "1.4.0",
   "description": "",
   "main": "index.js",
   "typings": "./index.d.ts",
@@ -20,16 +20,16 @@
   },
   "keywords": [],
   "author": "Ben Zörb",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
   },
   "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
   "dependencies": {
-    "@jungvonmatt/contentful-ssg": "^1.1.0",
+    "@jungvonmatt/contentful-ssg": "^1.4.0",
     "fs-extra": "^10.0.0",
     "merge-options": "^3.0.4",
     "micromatch": "^4.0.4"
   },
-  "gitHead": "95f58f6323beda2a6ba1b3cb6fecd07ff6d6cc7f"
+  "gitHead": "0d323f9884ae8fa48049e25bcd127954ee7988b8"
 }