md-slots 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matt Holden
+
+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,38 @@
+# md-slots
+
+Tiny `{{slot}}` renderer for markdown text.
+
+## Install
+
+```sh
+npm install md-slots
+```
+
+## Usage
+
+```ts
+import { renderSlots, slots } from "md-slots";
+
+const template = "Hello {{ name }}.\n\n{{body}}";
+
+slots(template);
+// ["name", "body"]
+
+renderSlots(template, {
+  name: "Ada",
+  body: "Welcome.",
+});
+// "Hello Ada.\n\nWelcome."
+```
+
+## API
+
+### `slots(template: string): string[]`
+
+Returns unique slot names in order of first appearance. Slots look like `{{name}}`, with ignored whitespace inside the braces.
+
+### `renderSlots(template, values, options?): string`
+
+Replaces matching slots with `values[name]`. Strings render as-is; other values render with `JSON.stringify(value, null, 2)`. Pass `options.format(value, name)` to customize formatting.
+
+Missing, `null`, and `undefined` values throw `Error("Missing slot: <name>")`.

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Returns the unique slot names referenced by a template, preserving the order
+ * in which each name first appears.
+ *
+ * Slots must use `{{name}}` syntax, with optional whitespace inside the braces.
+ * Malformed placeholders are ignored.
+ */
+export declare function slots(template: string): string[];
+/**
+ * Replaces each matching slot in a template with its corresponding value.
+ *
+ * String values are rendered as-is. Other present values are rendered as
+ * pretty-printed JSON unless `options.format` is provided. Missing, `null`, and
+ * `undefined` values throw a `Missing slot` error.
+ */
+export declare function renderSlots(template: string, values: Record<string, unknown>, options?: {
+    format?: (value: unknown, name: string) => string;
+}): string;

package/dist/index.js

@@ -0,0 +1,40 @@
+const slotPattern = /\{\{\s*([A-Za-z][A-Za-z0-9_-]*)\s*\}\}/g;
+/**
+ * Returns the unique slot names referenced by a template, preserving the order
+ * in which each name first appears.
+ *
+ * Slots must use `{{name}}` syntax, with optional whitespace inside the braces.
+ * Malformed placeholders are ignored.
+ */
+export function slots(template) {
+    const names = new Set();
+    for (const match of template.matchAll(slotPattern)) {
+        names.add(match[1]);
+    }
+    return [...names];
+}
+/**
+ * Replaces each matching slot in a template with its corresponding value.
+ *
+ * String values are rendered as-is. Other present values are rendered as
+ * pretty-printed JSON unless `options.format` is provided. Missing, `null`, and
+ * `undefined` values throw a `Missing slot` error.
+ */
+export function renderSlots(template, values, options) {
+    return template.replace(slotPattern, (_match, name) => {
+        if (!Object.hasOwn(values, name)) {
+            throw new Error(`Missing slot: ${name}`);
+        }
+        const value = values[name];
+        if (value === null || value === undefined) {
+            throw new Error(`Missing slot: ${name}`);
+        }
+        if (options?.format) {
+            return options.format(value, name);
+        }
+        if (typeof value === "string") {
+            return value;
+        }
+        return JSON.stringify(value, null, 2);
+    });
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "md-slots",
+  "version": "0.1.0",
+  "description": "Tiny {{slot}} renderer for markdown text.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holdenmatt/md-slots.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "lint": "oxlint",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
+    "check": "pnpm format:check && pnpm lint && pnpm test && pnpm build",
+    "prepare": "tsc"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.1",
+    "oxfmt": "^0.56.0",
+    "oxlint": "^1.71.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9"
+  },
+  "packageManager": "pnpm@10.33.0"
+}