@rmdes/indiekit-preset-eleventy 1.0.0-beta.25

package/README.md

@@ -0,0 +1,17 @@
+# @indiekit/preset-eleventy
+
+[Eleventy](https://www.11ty.dev) publication preset for Indiekit.
+
+## Installation
+
+`npm install @indiekit/preset-eleventy`
+
+## Usage
+
+Add `@indiekit/preset-eleventy` to your list of plug-ins:
+
+```json
+{
+  "plugins": ["@indiekit/preset-eleventy"]
+}
+```

package/assets/icon.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96">
+  <path fill="#222" d="M0 0h96v96H0z"/>
+  <path fill="#FFF" d="M42.7 27c1 0 1.3.8 1.3 2v35.5c0 1.6-.4 2.5-1.4 2.5h-4.1c-1 0-1.4-1-1.4-2.5V34.8h-.2l-.8.2-.5.2h-.2c-1 .1-1.4-.7-1.4-1.9v-2.5c0-1 .4-1.8 1.2-2l7-1.7.5-.1Zm11.9-1c1 0 1.4.8 1.4 2.1v10.4h3c1 0 1.5 1 1.5 2V42c0 1.2-.5 2-1.5 2h-3v13.7c0 .9 0 1.6.2 2.2v.3l.4 1.2.6.4.7.1h1.9c1 0 1.5.7 1.5 1.7v1.6c0 1-.6 1.8-1.6 1.8H57c-.8 0-1.5 0-2-.2-.7 0-1.4-.3-2-.7a5 5 0 0 1-1.7-1.7c-.4-.7-.7-1.6-1-2.8-.2-1.1-.4-2.5-.4-4V44h-1.4c-1 0-1.5-.7-1.5-1.8v-1.6c0-1.2.5-2.1 1.5-2.1H50l.4-10.4c.1-1.3.5-2.1 1.5-2.1h2.7Zm22.2 13c.9 0 1.2.7 1.2 1.8v.7l-4.8 25.2a26 26 0 0 1-1.3 5c-.5 1.2-1 2-1.7 2.5s-1.5.8-2.6.8h-.3c-1.6 0-2.8-.5-3.5-1.5-.2-.3-.3-.8-.3-1.4v-.2c0-1.8.3-2.8 1.3-2.8l1.2.4 1 .2s.2-.1.4-.6c.3-.6.4-1.5.4-2.6l-.5-2.9L62 41.4l-.1-.7c0-1 .3-1.7 1.1-1.7h3.2c.5 0 .8.2 1.1.5.3.3.5.7.6 1.4l2.8 15.3L73 41c0-.6.2-1 .4-1.3v-.1c.4-.4.8-.6 1.2-.6h2.2ZM28.7 27c1 0 1.3.8 1.3 2v35.5c0 1.6-.4 2.5-1.4 2.5h-4.1c-1 0-1.4-1-1.4-2.5V34.8h-.2l-.8.2-.5.2h-.2c-1 .1-1.4-.7-1.4-1.9v-2.5c0-1 .4-1.8 1.2-2l7-1.7.5-.1Z"/>
+</svg>

package/index.js

@@ -0,0 +1,22 @@
+import { getPostTemplate } from "./lib/post-template.js";
+import { getPostTypes } from "./lib/post-types.js";
+
+export default class EleventyPreset {
+  name = "Eleventy preset";
+
+  get info() {
+    return {
+      name: "Eleventy",
+    };
+  }
+
+  postTemplate(properties) {
+    return getPostTemplate(properties);
+  }
+
+  init(Indiekit) {
+    this.postTypes = getPostTypes(Indiekit.postTypes);
+
+    Indiekit.addPreset(this);
+  }
+}

package/lib/post-template.js

@@ -0,0 +1,81 @@
+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`;
+  } else {
+    return "";
+  }
+};
+
+/**
+ * Get front matter
+ * @access private
+ * @param {object} properties - JF2 properties
+ * @returns {string} Front matter in chosen format
+ */
+const getFrontMatter = (properties) => {
+  /**
+   * Eleventy uses camelCase for YAML property keys, i.e. `fileSlug`
+   * @see {@link https://www.11ty.dev/docs/data-eleventy-supplied/}
+   */
+  properties = camelcaseKeys(properties, { deep: true });
+
+  /**
+   * Replace Microformat properties with Eleventy equivalents
+   * @see {@link https://www.11ty.dev/docs/data-frontmatter/}
+   * @see {@link https://www.11ty.dev/docs/dates/}
+   */
+  properties = {
+    date: properties.published,
+    ...(properties.name && { title: properties.name }),
+    ...properties,
+  };
+
+  /**
+   * Draft posts
+   * @see {@link https://www.11ty.dev/docs/quicktips/draft-posts/}
+   */
+  if (properties.postStatus === "draft") {
+    properties.draft = true;
+  }
+
+  delete properties.content; // Shown below front matter
+  delete properties.name; // Use `title`
+  delete properties.postStatus; // Use `draft`
+  delete properties.published; // Use `date`
+  delete properties.slug; // use `page.fileSlug`
+  delete properties.type; // Not required
+
+  // Convert url to Eleventy permalink so generated URL matches Indiekit's stored URL
+  // Add trailing slash to generate /path/index.html instead of /path.html
+  if (properties.url) {
+    const url = properties.url;
+    properties.permalink = url.endsWith("/") ? url : `${url}/`;
+  }
+  delete properties.url;
+
+  const frontMatter = YAML.stringify(properties, { lineWidth: 0 });
+  return `---\n${frontMatter}---\n`;
+};
+
+/**
+ * Get post template
+ * @param {object} properties - JF2 properties
+ * @returns {string} Rendered template
+ */
+export const getPostTemplate = (properties) => {
+  const content = getContent(properties);
+  const frontMatter = getFrontMatter(properties);
+
+  return frontMatter + content;
+};

package/lib/post-types.js

@@ -0,0 +1,25 @@
+import plur from "plur";
+
+/**
+ * Get paths and URLs for configured post types
+ * @param {object} postTypes - Post type configuration
+ * @returns {object} Updated post type configuration
+ */
+export const getPostTypes = (postTypes) => {
+  for (const type of postTypes.keys()) {
+    const collection = plur(type);
+
+    postTypes.set(type, {
+      ...postTypes.get(type),
+      post: {
+        path: `${collection}/{yyyy}-{MM}-{dd}-{slug}.md`,
+        url: `${collection}/{yyyy}/{MM}/{dd}/{slug}`,
+      },
+      media: {
+        path: `media/${collection}/{yyyy}/{MM}/{dd}/{filename}`,
+      },
+    });
+  }
+
+  return postTypes;
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@rmdes/indiekit-preset-eleventy",
+  "version": "1.0.0-beta.25",
+  "description": "Eleventy publication preset for Indiekit (fork with permalink fix)",
+  "keywords": [
+    "indiekit",
+    "indiekit-plugin",
+    "indieweb",
+    "micropub",
+    "eleventy",
+    "11ty"
+  ],
+  "homepage": "https://getindiekit.com",
+  "author": {
+    "name": "Paul Robert Lloyd",
+    "url": "https://paulrobertlloyd.com"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
+  "type": "module",
+  "main": "index.js",
+  "files": [
+    "assets",
+    "lib",
+    "index.js"
+  ],
+  "bugs": {
+    "url": "https://github.com/rmdes/indiekit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rmdes/indiekit.git",
+    "directory": "packages/preset-eleventy"
+  },
+  "dependencies": {
+    "camelcase-keys": "^10.0.0",
+    "plur": "^6.0.0",
+    "yaml": "^2.6.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}