@jungvonmatt/cssg-plugin-hugo 1.0.4 → 1.2.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.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)
+
+
+### Bug Fixes
+
+* 🐛 Adds <rootDir>/data to managed directories ([d67de2b](https://github.com/jungvonmatt/contentful-ssg/commit/d67de2b4a78771076e5fd1d4e7beec0c1fb65a7d))
+
+
+
+
+
+## [1.0.6](https://github.com/jungvonmatt/contentful-ssg/compare/v1.0.5...v1.0.6) (2021-12-02)
+
+**Note:** Version bump only for package @jungvonmatt/cssg-plugin-hugo
+
+
+
+
+
+## [1.0.5](https://github.com/jungvonmatt/contentful-ssg/compare/v1.0.4...v1.0.5) (2021-11-30)
+
+**Note:** Version bump only for package @jungvonmatt/cssg-plugin-hugo
+
+
+
+
+
 ## [1.0.4](https://github.com/jungvonmatt/contentful-ssg/compare/v1.0.3...v1.0.4) (2021-11-29)
 
 **Note:** Version bump only for package @jungvonmatt/cssg-plugin-hugo

package/index.js

@@ -3,7 +3,8 @@ import mergeOptionsModule from 'merge-options';
 import { snakeCaseKeys } from '@jungvonmatt/contentful-ssg/lib/object';
 import mm from 'micromatch';
 import { existsSync } from 'fs';
-import { writeFile, readFile } from 'fs/promises';
+import { outputFile } from 'fs-extra';
+import { readFile } from 'fs/promises';
 import path from 'path';
 
 const mergeOptions = mergeOptionsModule.bind({ ignoreUndefined: true });
@@ -18,10 +19,15 @@ const defaultOptions = {
   typeIdSettings: 'd-settings',
   translationStrategy: STRATEGY_DIRECTORY,
   typeIdI18n: 'd-i18n',
+  menuDepth: 2,
+  typeIdMenu: 'c-menu',
   languageConfig: true,
   fieldIdHome: 'home',
   fieldIdSlug: 'slug',
   fieldIdParent: 'parent_page',
+  fieldIdMenuEntries: 'entries',
+  fieldIdMenuHide: 'hide_in_menu',
+  fieldIdMenuPos: 'menu_pos',
   typeConfig: {
     [TYPE_CONTENT]: ['page'],
   },
@@ -60,7 +66,69 @@ export default (args) => {
     return type;
   };
 
+  const buildMenu = (transformContext, depth = 0) => {
+    const { entry, entryMap } = transformContext;
+
+    const entries = entry.fields?.entries ?? [];
+    const nodes = entries.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,
+      },
+    }));
+
+    const getChildnodes = (entry, depth) => {
+      const id = entry?.sys?.id ?? 0;
+      const contentType = entry?.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 [
+        ...sorted.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) => getChildnodes(node, depth - 1)),
+      ];
+    };
+
+    return [...nodes, ...entries.flatMap((node) => getChildnodes(node, depth))];
+  };
+
   return {
+    config(prev) {
+      const { managedDirectories } = prev || {};
+
+      return { ...prev, managedDirectories: [...(managedDirectories || []), 'data'] };
+    },
+
     // Before hook
     async before(runtimeContext) {
       const { helper, converter, data, localized } = runtimeContext;
@@ -98,7 +166,7 @@ export default (args) => {
             ];
           })
         );
-        await writeFile(dst, converter.toml.stringify(languageConfig));
+        await outputFile(dst, converter.toml.stringify(languageConfig));
       }
 
       // Find section pages and add them to the runtimeconfig
@@ -118,8 +186,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 };
     },
 
     /**
@@ -185,8 +254,8 @@ export default (args) => {
 
       if (contentTypeId === options.typeIdSettings) {
         return options.translationStrategy === STRATEGY_FILENAME
-          ? `../settings.${locale.code}.json`
-          : '../settings.json';
+          ? `../settings.${locale.code}.yaml`
+          : '../settings.yaml';
       }
 
       if (type === TYPE_CONTENT && sectionIds.has(id)) {
@@ -219,12 +288,12 @@ export default (args) => {
       }
 
       return options.translationStrategy === STRATEGY_FILENAME
-        ? `${id}.${locale.code}.json`
-        : `${id}.json`;
+        ? `${id}.${locale.code}.yaml`
+        : `${id}.yaml`;
     },
 
     async transform(transformContext, runtimeContext) {
-      const { content, id, contentTypeId, locale } = transformContext;
+      const { content, id, contentTypeId, locale, entry } = transformContext;
 
       const type = getEntryType(transformContext);
 
@@ -240,6 +309,14 @@ 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 = buildMenu(transformContext, options.menuDepth);
+        runtimeContext.menus[locale.code][name] = menu;
+      }
+
       if (type === TYPE_CONTENT) {
         return {
           ...snakeCaseKeys({
@@ -264,7 +341,17 @@ export default (args) => {
             ? toml.parse(await readFile(dictionaryPath, 'utf8'))
             : {};
 
-          return writeFile(dictionaryPath, toml.stringify({ ...oldContent, ...translations }));
+          return outputFile(dictionaryPath, toml.stringify({ ...oldContent, ...translations }));
+        })
+      );
+
+      const { stringify } = await import('@jungvonmatt/contentful-ssg/converter/toml');
+      const menus = runtimeContext?.menus ?? {};
+      await Promise.all(
+        Object.entries(menus).map(([localeCode, menuData]) => {
+          const file = `config/_default/menus.${localeCode}.toml`;
+          const data = stringify(menuData);
+          return outputFile(file, data);
         })
       );
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/cssg-plugin-hugo",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "description": "",
   "main": "index.js",
   "typings": "./index.d.ts",
@@ -26,9 +26,10 @@
   },
   "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
   "dependencies": {
-    "@jungvonmatt/contentful-ssg": "^1.0.4",
+    "@jungvonmatt/contentful-ssg": "^1.1.0",
+    "fs-extra": "^10.0.0",
     "merge-options": "^3.0.4",
     "micromatch": "^4.0.4"
   },
-  "gitHead": "9da40bcd4fa8124cf7ae3ff6a2dcfca91c82c4fb"
+  "gitHead": "9e0182ef7511c6ba80f6332e6f726eaadafca915"
 }