remark-preview-to-frontmatter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mohsen Waheed Elsisi
+
+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,102 @@
+# remark-preview-to-markdown
+
+[remark](https://github.com/remarkjs/remark) plugin to add text from the beginning of a document to a property in frontmatter.
+
+## Contents
+
+- [What is this](#what-is-this?)
+- [When should I use this?](#when-should-I-use-this?)
+- [Installation](#install)
+- [usage](#use)
+- [API](#api)
+	- [PluginOptions](#pluginoptions)
+
+## What is this?
+
+This is a [unified](https://github.com/unifiedjs/unified) ([remark](https://github.com/remarkjs/remark)) plugin that extracts some text from the beginning of a markdown file (not including frontmatter and comments) and adds the extracted text as a frontmatter property. 
+
+## When should I use this?
+
+This plugin is useful in use cases where a preview of the document must be part of the files metadata. For example, blogging sites may use this to show a snippet of each individual blog post in a list of multiple posts. 
+
+This plugin selects the snippet based on a number of characters, hence for something like an abstract in a journal article, this plugin is not useful. 
+
+## Install
+
+The package is only available on npm:
+
+```shell
+npm install remark-preview-to-frontmatter
+```
+
+## Use
+
+Consider `exmaple.md`
+
+```md
+_Lorem Ipsum_ is simply **dummy text** of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+
+sourced from [lipsum.com](https://www.lipsum.com/)
+```
+
+To add a preview of this file in markdown, the following is done:
+
+```js
+import fs from "fs/promises";
+import { remark } from "remark";
+import remarkFrontmatter from "remark-frontmatter";
+import remarkPreviewToFrontmatter from "remark-preview-to-frontmatter";
+
+const inputFIle = "./example.md";
+const outputFile = "./output.md";
+
+const inputMarkdown = await fs.readFile(inputFIle, "utf-8");
+
+const outputMarkdown = await remark()
+  .use(remarkFrontmatter)
+  .use(remarkPreviewToFrontmatter, { charLimit: 100 })
+  .process(inputMarkdown);
+
+await fs.writeFile(outputFile, String(outputMarkdown));
+
+```
+
+`output.md` would look like this
+
+```md
+---
+preview: Lorem Ipsum is simply dummy text of the printing and typesetting
+  industry. Lorem Ipsum has been the ...
+
+---
+
+*Lorem Ipsum* is simply **dummy text** of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+
+sourced from [lipsum.com](https://www.lipsum.com/)
+```
+
+## API
+
+The package only provides the default export used as a plugin to remark. Provding options is of course optional.
+
+```js
+remark().use(remarkPreviewToFrontmatter, options)
+```
+
+### PluginOptions 
+
+| Field                     | type         | default | purpose                                                              |
+| ------------------------- | ------------ | ------- | -------------------------------------------------------------------- |
+| `charLimit`               | int          | 200     | the number of maximum number of characters to include in the preview |
+| `frontmatterKey`          | string       | preview | defined the key to use in the frontmatter                            |
+| `appendEllipsis`          | bool         | true    | whether to add "..." at end of preview                               |
+| `allowMultipleLines`      | bool         | false   | removes new lines and redundant whitespace from the text             |
+| `trailingWordBreakPolicy` | (see bellow) | break   | how to handle a word if the charLimit lies within it                 |
+
+`trailingWordBreakPolicy` acts when only part of the last word is included in the preview. For example, if the last word is *hello* and the `charLimit` is such that only the first three letters are taken, each policy will handle this scenario differently:
+
+| policy      | result      | explanation                                                     |
+| ----------- | ----------- | --------------------------------------------------------------- |
+| `break`     | hel         | will strictlly apply the character limit                        |
+| `full word` | hello       | will preserve the whole word, exceed the limit                  |
+| `remove`    | *(nothing)* | will remove the incomplete word entirely, going under the limit |

package/dist/extractPreviewText.d.ts

@@ -0,0 +1,3 @@
+import type { Root } from "mdast";
+declare function extractPreviewText(tree: Root, charLimit: number): string;
+export default extractPreviewText;

package/dist/extractPreviewText.js

@@ -0,0 +1,15 @@
+import { visit } from "unist-util-visit";
+function extractPreviewText(tree, charLimit) {
+    let previewText = "";
+    visit(tree, ["text", "code", "inlineCode"], (node) => {
+        if (previewText.length >= charLimit)
+            return;
+        // @ts-ignore
+        if (node.value) {
+            // @ts-ignore
+            previewText += node.value + " ";
+        }
+    });
+    return previewText;
+}
+export default extractPreviewText;

package/dist/frontmatter.d.ts

@@ -0,0 +1,2 @@
+import type { Root } from "mdast";
+export default function modifyFrontmatter(tree: Root, key: string, previewText: string): void;

package/dist/frontmatter.js

@@ -0,0 +1,27 @@
+import { u } from "unist-builder";
+import { visit } from "unist-util-visit";
+import * as yaml from "yaml";
+export default function modifyFrontmatter(tree, key, previewText) {
+    let frontmatterNodeExists = addPropertyIfYamlExists(tree, key, previewText);
+    if (!frontmatterNodeExists) {
+        insertNewYamlNode(key, previewText, tree);
+    }
+}
+function addPropertyIfYamlExists(tree, key, previewText) {
+    let nodeFound = false;
+    visit(tree, "yaml", (node) => {
+        nodeFound = true;
+        node.value = addYamlProperty(node.value, key, previewText);
+    });
+    return nodeFound;
+}
+function insertNewYamlNode(key, previewText, tree) {
+    const yamlContent = addYamlProperty("", key, previewText);
+    const yamlNode = u("yaml", yamlContent);
+    tree.children.unshift(yamlNode);
+}
+function addYamlProperty(yamlString, frontmatterKey, previewText) {
+    const parsedYaml = yaml.parse(yamlString) ?? {};
+    parsedYaml[frontmatterKey] = previewText;
+    return yaml.stringify(parsedYaml);
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import remarkPreviewToFrontmatter from "./plugin.js";
+export default remarkPreviewToFrontmatter;

package/dist/index.js

@@ -0,0 +1,2 @@
+import remarkPreviewToFrontmatter from "./plugin.js";
+export default remarkPreviewToFrontmatter;

package/dist/plugin.d.ts

@@ -0,0 +1,11 @@
+import type { Root } from "mdast";
+import { TrailingWordBreakPolicy } from "./wordBreaks.js";
+interface PluginOptions {
+    charLimit?: number;
+    trailingWordBreakPolicy?: TrailingWordBreakPolicy;
+    frontmatterKey?: string;
+    allowMultipleLines?: boolean;
+    appendEllipsis?: boolean;
+}
+declare function remarkPreviewToFrontmatter(options?: PluginOptions): (tree: Root) => void;
+export default remarkPreviewToFrontmatter;

package/dist/plugin.js

@@ -0,0 +1,26 @@
+import modifyFrontmatter from "./frontmatter.js";
+import trimPreviewTextToLength from "./wordBreaks.js";
+import extractPreviewText from "./extractPreviewText.js";
+const defaultOptions = {
+    charLimit: 200,
+    trailingWordBreakPolicy: "break",
+    frontmatterKey: "preview",
+    allowMultipleLines: false,
+    appendEllipsis: true,
+};
+function remarkPreviewToFrontmatter(options = {}) {
+    const { charLimit = defaultOptions.charLimit, trailingWordBreakPolicy = defaultOptions.trailingWordBreakPolicy, frontmatterKey = defaultOptions.frontmatterKey, allowMultipleLines = defaultOptions.allowMultipleLines, appendEllipsis = defaultOptions.appendEllipsis, } = options;
+    return function (tree) {
+        let previewText = extractPreviewText(tree, charLimit);
+        if (!allowMultipleLines) {
+            previewText = previewText.replace("\n", " ");
+            previewText = previewText.replace(/\s+/g, " ");
+        }
+        previewText = previewText.trim();
+        previewText = trimPreviewTextToLength(previewText, charLimit, trailingWordBreakPolicy);
+        if (appendEllipsis)
+            previewText = previewText + "...";
+        modifyFrontmatter(tree, frontmatterKey, previewText);
+    };
+}
+export default remarkPreviewToFrontmatter;

package/dist/wordBreaks.d.ts

@@ -0,0 +1,2 @@
+export type TrailingWordBreakPolicy = "break" | "remove" | "full word";
+export default function trimPreviewTextToLength(text: string, limit: number, policy: TrailingWordBreakPolicy): string;

package/dist/wordBreaks.js

@@ -0,0 +1,31 @@
+export default function trimPreviewTextToLength(text, limit, policy) {
+    let trimmedText = limit >= text.length ? text : text.slice(0, limit);
+    return applyTrailingWordBreakPolicy(text, trimmedText, policy);
+}
+function applyTrailingWordBreakPolicy(fullText, trimmedText, policy) {
+    if (policy == "break")
+        return trimmedText;
+    const [lastWordInPreview, lastWordInfullText] = getLastWords(fullText, trimmedText);
+    if (lastWordInPreview === lastWordInfullText)
+        return trimmedText;
+    if (policy == "remove") {
+        const previewWords = trimmedText.split(" ");
+        previewWords.pop();
+        return previewWords.join(" ");
+    }
+    else if (policy == "full word") {
+        const previewWords = trimmedText.split(" ");
+        previewWords.pop();
+        previewWords.push(lastWordInfullText);
+        return previewWords.join(" ");
+    }
+    throw new Error(`Unknown trailing word break policy: ${policy}`);
+}
+function getLastWords(fullText, textPreview) {
+    const previewTextWords = textPreview.split(" ");
+    const fullTextWords = fullText.split(" ");
+    const lastWordIndex = previewTextWords.length - 1;
+    const lastWordInPreview = previewTextWords[lastWordIndex];
+    const lastWordInfullText = fullTextWords[lastWordIndex];
+    return [lastWordInPreview, lastWordInfullText];
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "remark-preview-to-frontmatter",
+  "version": "1.0.0",
+  "author": "Mohsen Elsisi",
+  "description": "remark plugin to add text from the beginning of a document to a property in frontmatter.",
+  "keywords": [
+    "unified",
+    "remark",
+    "remark-plugin",
+    "markdown",
+    "frontmatter"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mohsen-w-elsisi/remark-preview-to-frontmatter"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "npm run build && node tests/test.js"
+  },
+  "dependencies": {
+    "unist-builder": "^4.0.0",
+    "unist-util-visit": "^5.0.0",
+    "yaml": "^2.8.2"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "mdast-util-frontmatter": "^2.0.1",
+    "micromark-extension-frontmatter": "^2.0.0",
+    "remark": "^15.0.1",
+    "remark-frontmatter": "^5.0.0"
+  }
+}