@eclecticpassions/indiekit-preset-hugo 1.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Paul Robert Lloyd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# Indiekit Plugin: preset-hugo
+
+Forked from [@indiekit/preset-hugo](https://www.npmjs.com/package/@indiekit/preset-hugo). In order to get unquoted dates in front matter, the following changes were made:
+
+- Ensure date value is a native JavaScript Date object before being stringified
+- Modify the properties object mapping within getFrontMatter
+
+> [!important]
+> I asked an LLM to help me with the code. Please review before using in your setup.
+
+## Installation
+
+I personally wasn't able to use NPM's override feature for the exisiting Indiekit preset-hugo plugin.
+
+1. Remove existing: `npm remove @indiekit/preset-hugo`
+2. Install with: `npm install github:eclecticpassions/indiekit-preset-hugo`
+3. Replace all existing configuration (e.g. `indiekit.config.js`) and `package.json`, from `@indiekit/preset-hugo` to `@eclecticpassions/indiekit-preset-hugo`
+4. Remove and rebuild `rm -rf node_modules package-lock.json` and `npm install`
+
+See below for the README of the original preset-hugo plugin.
+
+---
+
+A [Hugo](https://gohugo.io) publication preset for Indiekit.
+
+## Installation
+
+`npm install @indiekit/preset-hugo`
+
+## Usage
+
+Add `@indiekit/preset-hugo` to your list of plug-ins, specifying options as required:
+
+```json
+{
+  "plugins": ["@indiekit/preset-hugo"],
+  "@indiekit/preset-hugo": {
+    "frontMatterFormat": "json"
+  }
+}
+```
+
+## Options
+
+| Option              | Type     | Description                                                                            |
+| :------------------ | :------- | :------------------------------------------------------------------------------------- |
+| `frontMatterFormat` | `string` | Front matter format to use (`json`, `toml` or `yaml`). _Optional_, defaults to `yaml`. |

package/assets/icon.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96">
+  <path fill="#FF4088" d="M0 0h96v96H0z"/>
+  <path fill="#FFF" fill-rule="nonzero" d="M47.2 8c-2.5 0-4.9.7-7 2L18.9 23.3A14.3 14.3 0 0 0 12 35.4v27c0 5 2.7 9.7 7 12.1l21.8 12.6a13 13 0 0 0 13 0l23.7-13.3c4-2.3 6.5-6.5 6.5-11.2V34.1a12 12 0 0 0-6-10.4L54.1 9.8a13.5 13.5 0 0 0-7-1.8Zm0 5.6a8 8 0 0 1 4 1.1l24 13.9c2 1.1 3.2 3.2 3.2 5.5v28.5c0 2.6-1.4 5-3.7 6.3L51 82.3a7.4 7.4 0 0 1-7.4 0L21.8 69.5a8.2 8.2 0 0 1-4.2-7.1v-27c0-3 1.6-5.9 4.2-7.4l21.4-13.3a7.8 7.8 0 0 1 4-1.2Zm-15.8 13v43.3h9v-19h15.1v19h9V26.6h-9v15.8h-15V26.6h-9Z"/>
+</svg>

package/index.js

@@ -0,0 +1,56 @@
+import { getPostTemplate } from "./lib/post-template.js";
+import { getPostTypes } from "./lib/post-types.js";
+
+const defaults = {
+  frontMatterFormat: "toml",
+};
+
+export default class HugoPreset {
+  name = "Hugo Custom Preset";
+  postTypes;
+
+  constructor(options = {}) {
+    this.options = { ...defaults, ...options };
+  }
+
+  get info() {
+    return {
+      name: "Hugo Custom Unquoted", // <-- Indiekit reads this to display in your dashboard status
+    };
+  }
+
+  get prompts() {
+    return [
+      {
+        type: "select",
+        name: "frontMatterFormat",
+        message: "Which front matter format are you using?",
+        choices: [
+          {
+            title: "JSON",
+            value: "json",
+          },
+          {
+            title: "TOML",
+            value: "toml",
+          },
+          {
+            title: "YAML",
+            value: "yaml",
+          },
+        ],
+        initial: 2,
+      },
+    ];
+  }
+
+  postTemplate(properties) {
+    return getPostTemplate(properties, this.options.frontMatterFormat);
+  }
+
+  init(Indiekit) {
+    this.postTypes = getPostTypes(Indiekit.postTypes);
+
+    Indiekit.addPreset(this);
+  }
+}

package/lib/post-template.js

@@ -0,0 +1,113 @@
+import TOML from "@iarna/toml";
+import camelcaseKeys from "camelcase-keys";
+import YAML from "yaml";
+
+/**
+ * Get content
+ * @access private
+ * @param {object} properties - JF2 properties
+ * @returns {string} Content
+ */
+const getContent = (properties) => {
+  if (properties.content) {
+    const content =
+      properties.content.text || properties.content.html || properties.content;
+    return `\n${content}\n`;
+  }
+
+  return "";
+};
+
+/**
+ * Get front matter
+ * @access private
+ * @param {object} properties - JF2 properties
+ * @param {string} frontMatterFormat - Front matter format
+ * @returns {string} Front matter in chosen format
+ */
+const getFrontMatter = (properties, frontMatterFormat) => {
+  let delimiters;
+  let frontMatter;
+
+  // 1. camelCase the incoming properties first
+  properties = camelcaseKeys(properties, { deep: true });
+
+  // 2. Capture clean Date objects first
+  const parsedDate = properties.published ? new Date(properties.published) : undefined;
+  const parsedLastmod = properties.updated ? new Date(properties.updated) : undefined;
+  const parsedExpiry = properties.deleted ? new Date(properties.deleted) : undefined;
+
+  // 3. Build the clean, final object mapping
+  properties = {
+    ...(properties.postStatus === "draft" && { draft: true }),
+    ...(properties.name && { title: properties.name }),
+    ...(properties.photo && {
+      images: properties.photo.map((image) => image.url),
+    }),
+    ...properties, // Pull everything else in safely early on
+    
+    // Explicitly place the strict types at the bottom to guarantee they win
+    date: parsedDate,
+    publishDate: parsedDate,
+    ...(parsedLastmod && { lastmod: parsedLastmod }),
+    ...(parsedExpiry && { expiryDate: parsedExpiry }),
+  };
+
+  // 4. Wipe out all unused/overlapping raw string properties completely
+  delete properties.content;
+  delete properties.deleted;
+  delete properties.name;
+  delete properties.postStatus;
+  delete properties.published;
+  delete properties.slug;
+  delete properties.type;
+  delete properties.updated;
+  delete properties.url;
+
+  // 5. Make absolutely sure no string version leaked through
+  if (!properties.lastmod) delete properties.lastmod;
+  if (!properties.expiryDate) delete properties.expiryDate;
+
+  // 6. Before TOML.stringify(properties), convert param name category to tags and makes sure that an array [] is used even when there is only one tag
+  if (properties.category) {
+    properties.tags = Array.isArray(properties.category)
+      ? properties.category
+      : [properties.category];
+    delete properties.category;
+  }
+  
+  switch (frontMatterFormat) {
+    case "json": {
+      delimiters = ["", "\n"];
+      frontMatter = JSON.stringify(properties, undefined, 2);
+      break;
+    }
+
+    case "toml": {
+      delimiters = ["+++\n", "+++\n"];
+      frontMatter = TOML.stringify(properties);
+      break;
+    }
+
+    default: {
+      delimiters = ["---\n", "---\n"];
+      frontMatter = YAML.stringify(properties, { lineWidth: 0 });
+      break;
+    }
+  }
+
+  return `${delimiters[0]}${frontMatter}${delimiters[1]}`;
+};
+
+/**
+ * Get post template
+ * @param {object} properties - JF2 properties
+ * @param {string} [frontMatterFormat] - Front matter format
+ * @returns {string} Rendered template
+ */
+export const getPostTemplate = (properties, frontMatterFormat = "yaml") => {
+  const content = getContent(properties);
+  const frontMatter = getFrontMatter(properties, frontMatterFormat);
+
+  return frontMatter + content;
+};

package/lib/post-types.js

@@ -0,0 +1,31 @@
+import plur from "plur";
+
+/**
+ * Get paths and URLs for configured post types
+ * @param {Map} postTypes - Post type configuration
+ * @returns {object} Updated post type configuration
+ */
+export const getPostTypes = (postTypes) => {
+  for (const type of postTypes.keys()) {
+    const section = plur(type);
+
+    /**
+     * Follow Hugo content management guidelines
+     * @see {@link https://gohugo.io/content-management/organization/}
+     * @see {@link https://gohugo.io/content-management/static-files/}
+     */
+    postTypes.set(type, {
+      ...postTypes.get(type),
+      post: {
+        path: `content/${section}/{slug}.md`,
+        url: `${section}/{slug}`,
+      },
+      media: {
+        path: `static/${section}/{filename}`,
+        url: `${section}/{filename}`,
+      },
+    });
+  }
+
+  return postTypes;
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@eclecticpassions/indiekit-preset-hugo",
+  "version": "1.0.3",
+  "description": "Custom Hugo publication preset for Indiekit",
+  "type": "module",
+  "main": "index.js",
+  "homepage": "https://getindiekit.com",
+  "author": {
+    "name": "Paul Robert Lloyd",
+    "url": "https://paulrobertlloyd.com"
+  },
+  "contributors": [
+    {
+      "name": "Naty S",
+      "url": "https://burgeonlab.com"
+    }
+  ],
+  "files": [
+    "assets",
+    "lib",
+    "index.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eclecticpassions/indiekit-preset-hugo.git"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=24.17.0"
+  },
+  "keywords": [
+    "indiekit",
+    "indiekit-plugin",
+    "frontmatter",
+    "toml"
+  ],
+  "dependencies": {
+    "@iarna/toml": "^2.2.5",
+    "camelcase-keys": "^10.0.2",
+    "plur": "^6.0.0",
+    "yaml": "^2.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}