npm - astro-loader-glob-frontmatter - Versions diffs - 0.1.0 → 0.2.0 - Mend

astro-loader-glob-frontmatter 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md CHANGED Viewed

@@ -111,14 +111,14 @@ No config flag needed. If the file exists, it's used. If you don't want per-dire
 ## Merge Cascade
-Three layers, from broadest to most specific:
+Four layers, from broadest to most specific:
 ```
-centralized file  →  per-directory file  →  in-file frontmatter
-   (broadest)        (directory-scoped)       (most specific)
+centralized file  →  per-directory file  →  H1 title  →  in-file frontmatter
+   (broadest)        (directory-scoped)     (from body)    (most specific)
 ```
-**In-file frontmatter always wins.** If a key exists in the markdown file's frontmatter, that value is used. Per-directory files fill in gaps and override the centralized file. The centralized file provides defaults for everything else.
+**In-file frontmatter always wins.** If a key exists in the markdown file's frontmatter, that value is used. The H1 title sits between external frontmatter and in-file frontmatter—it fills in the `title` field when external files don't provide one, but in-file `title` still takes precedence. Per-directory files fill in gaps and override the centralized file. The centralized file provides defaults for everything else.
 For nested objects, merging is deep. If your centralized file sets `sidebar.badge: new` and the per-directory file sets `sidebar.order: 2`, the result is `sidebar: { order: 2, badge: new }`—not a wholesale replacement.
@@ -166,6 +166,29 @@ sidebar:
   badge: new                  # central, inherited via deep merge
 ```
+## Title from H1
+The loader automatically extracts the first `# Heading` from your markdown content and uses it as the `title` field. This means you can write natural markdown that looks good on GitHub:
+```markdown
+---
+sidebar:
+  order: 3
+---
+# Accordion
+The accordion component expands and collapses content.
+```
+The `# Accordion` heading becomes `title: "Accordion"` in your frontmatter data, and is stripped from the rendered body to prevent duplication.
+**Rules:**
+- The H1 must be the first non-blank content after frontmatter
+- If frontmatter already has a `title` field, the in-file title wins (H1 is still stripped from the body)
+- Inline markdown in the heading (`# My **Bold** Title`) is flattened to plain text
+- Only the first H1 is extracted — subsequent H1s are left in the body
 ## Dev Mode
 The loader automatically watches all frontmatter files for changes during `astro dev`. Edit a `frontmatter.yml` and the collection reloads—no restart needed.

package/dist/h1.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+export declare function stripH1Html(html: string): string;
+export declare function extractH1(markdown: string): {
+    title: string;
+    body: string;
+} | null;
+//# sourceMappingURL=h1.d.ts.map

package/dist/h1.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"h1.d.ts","sourceRoot":"","sources":["../src/h1.ts"],"names":[],"mappings":"AAsBA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAUlF"}

package/dist/h1.js ADDED Viewed

@@ -0,0 +1,33 @@
+/**
+ * Match a leading `# Title` line. The H1 must appear before any
+ * non-blank content. Leading blank lines are allowed.
+ *
+ * Capture group 1 = raw heading text (may contain inline markdown).
+ */
+const H1_RE = /^(?:[^\S\n]*\n)*# (.+)\n?/;
+/** Strip bold, italic, code, images, and links down to plain text. */
+function flattenInlineMarkdown(text) {
+    return text
+        .replace(/!\[([^\]]*)\]\([^)]*\)/g, '$1') // images
+        .replace(/\[([^\]]*)\]\([^)]*\)/g, '$1') // links
+        .replace(/(\*\*|__)(.*?)\1/g, '$2') // bold
+        .replace(/(\*|_)(.*?)\1/g, '$2') // italic
+        .replace(/~~(.*?)~~/g, '$1') // strikethrough
+        .replace(/`([^`]+)`/g, '$1') // inline code
+        .trim();
+}
+const H1_HTML_RE = /<h1[^>]*>[\s\S]*?<\/h1>\n*/;
+export function stripH1Html(html) {
+    return html.replace(H1_HTML_RE, '');
+}
+export function extractH1(markdown) {
+    const match = H1_RE.exec(markdown);
+    if (!match)
+        return null;
+    const rawTitle = match[1];
+    const title = flattenInlineMarkdown(rawTitle);
+    // Remove the H1 line and at most one trailing blank line
+    const body = markdown.slice(match[0].length).replace(/^\n/, '');
+    return { title, body };
+}
+//# sourceMappingURL=h1.js.map

package/dist/h1.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"h1.js","sourceRoot":"","sources":["../src/h1.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,KAAK,GAAG,2BAA2B,CAAA;AAEzC,sEAAsE;AACtE,SAAS,qBAAqB,CAAC,IAAY;IACzC,OAAO,IAAI;SACR,OAAO,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAG,SAAS;SACpD,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAK,QAAQ;SACpD,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAU,OAAO;SACnD,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAa,SAAS;SACrD,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAiB,gBAAgB;SAC5D,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAiB,cAAc;SAC1D,IAAI,EAAE,CAAA;AACX,CAAC;AAED,MAAM,UAAU,GAAG,4BAA4B,CAAA;AAE/C,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,QAAgB;IACxC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAClC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IAEvB,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;IACzB,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAA;IAC7C,yDAAyD;IACzD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IAE/D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;AACxB,CAAC"}

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;~~AAM3C~~,KAAK,QAAQ,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;AAE1C,UAAU,sBAAuB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,sBAAsB,GAAG,MAAM,~~CA4CpE~~;AAED,YAAY,EAAE,sBAAsB,EAAE,CAAA"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAQ3C,KAAK,QAAQ,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;AAE1C,UAAU,sBAAuB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,sBAAsB,GAAG,MAAM,CAiGpE;AAED,YAAY,EAAE,sBAAsB,EAAE,CAAA"}

package/dist/index.js CHANGED Viewed

@@ -1,7 +1,9 @@
 import { glob } from 'astro/loaders';
+import { readFileSync } from 'node:fs';
 import { normalize, resolve, relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { loadFrontmatterMap, collectFrontmatterFilePaths } from './frontmatter-map.js';
+import { extractH1, stripH1Html } from './h1.js';
 import { deepMerge } from './merge.js';
 export function globFrontmatter(opts) {
     return {
@@ -31,10 +33,50 @@ export function globFrontmatter(opts) {
                         const relPath = relative(normalizedBase, props.filePath);
                         const externalData = fmMap.get(relPath) ?? {};
                         const merged = deepMerge(externalData, props.data);
+                        // Extract H1 from file body as title if not already set
+                        if (!merged.title) {
+                            try {
+                                const raw = readFileSync(resolve(rootDir, props.filePath), 'utf-8');
+                                // Skip frontmatter fences to get body
+                                const fmMatch = /^---\n[\s\S]*?\n---\n?/.exec(raw);
+                                const body = fmMatch ? raw.slice(fmMatch[0].length) : raw;
+                                const h1 = extractH1(body);
+                                if (h1) {
+                                    merged.title = h1.title;
+                                }
+                            }
+                            catch {
+                                // File read failed — skip H1 extraction
+                            }
+                        }
                         return originalParseData({ ...props, data: merged });
                     },
                 },
             });
+            // Wrap store.set to strip H1 from body and rendered HTML
+            const originalSet = context.store.set.bind(context.store);
+            wrappedContext.store = Object.create(context.store, {
+                set: {
+                    value: (entry) => {
+                        if (entry.body) {
+                            const h1 = extractH1(entry.body);
+                            if (h1) {
+                                entry.body = h1.body;
+                                if (entry.rendered) {
+                                    entry.rendered.html = stripH1Html(entry.rendered.html);
+                                    if (entry.rendered.metadata?.headings) {
+                                        const headings = entry.rendered.metadata.headings;
+                                        if (headings.length > 0 && headings[0].depth === 1) {
+                                            entry.rendered.metadata.headings = headings.slice(1);
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                        return originalSet(entry);
+                    },
+                },
+            });
             const { frontmatter: _frontmatter, ...globOpts } = opts;
             await glob(globOpts).load(wrappedContext);
         },

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AAEpC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAA;AACtF,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAStC,MAAM,UAAU,eAAe,CAAC,IAA4B;IAC1D,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,KAAK,CAAC,IAAI,CAAC,OAAO;YAChB,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAA;YACzC,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;YACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;YAEjD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW;gBAClC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;gBACpC,CAAC,CAAC,SAAS,CAAA;YACb,MAAM,KAAK,GAAG,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAA;YAE3D,kDAAkD;YAClD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,MAAM,YAAY,GAAG,2BAA2B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;gBACvE,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC5B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;gBACnC,CAAC;YACH,CAAC;YAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACzD,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;gBAC5C,SAAS,EAAE;oBACT,KAAK,EAAE,KAAK,EACV,KAAqD,EACrD,EAAE;wBACF,IAAI,CAAC,KAAK,CAAC,QAAQ;4BAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAA;wBAEpD,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;wBACxD,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;wBAE7C,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,IAA+B,CAAC,CAAA;wBAE7E,OAAO,iBAAiB,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,MAAe,EAAE,CAAC,CAAA;oBAC/D,CAAC;iBACF;aACF,CAAC,CAAA;YAEF,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAA;YACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC3C,CAAC;KACF,CAAA;AACH,CAAC"}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAA;AACtF,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAStC,MAAM,UAAU,eAAe,CAAC,IAA4B;IAC1D,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,KAAK,CAAC,IAAI,CAAC,OAAO;YAChB,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAA;YACzC,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;YACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;YAEjD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW;gBAClC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;gBACpC,CAAC,CAAC,SAAS,CAAA;YACb,MAAM,KAAK,GAAG,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAA;YAE3D,kDAAkD;YAClD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,MAAM,YAAY,GAAG,2BAA2B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;gBACvE,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC5B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;gBACnC,CAAC;YACH,CAAC;YAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACzD,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;gBAC5C,SAAS,EAAE;oBACT,KAAK,EAAE,KAAK,EACV,KAAqD,EACrD,EAAE;wBACF,IAAI,CAAC,KAAK,CAAC,QAAQ;4BAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAA;wBAEpD,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;wBACxD,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;wBAE7C,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,IAA+B,CAAC,CAAA;wBAE7E,wDAAwD;wBACxD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;4BAClB,IAAI,CAAC;gCACH,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;gCACnE,sCAAsC;gCACtC,MAAM,OAAO,GAAG,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gCAClD,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;gCACzD,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;gCAC1B,IAAI,EAAE,EAAE,CAAC;oCACP,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,KAAK,CAAA;gCACzB,CAAC;4BACH,CAAC;4BAAC,MAAM,CAAC;gCACP,wCAAwC;4BAC1C,CAAC;wBACH,CAAC;wBAED,OAAO,iBAAiB,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,MAAe,EAAE,CAAC,CAAA;oBAC/D,CAAC;iBACF;aACF,CAAC,CAAA;YAEF,yDAAyD;YACzD,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YACzD,cAAc,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;gBAClD,GAAG,EAAE;oBACH,KAAK,EAAE,CAAwC,KAY9C,EAAE,EAAE;wBACH,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;4BACf,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;4BAChC,IAAI,EAAE,EAAE,CAAC;gCACP,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAA;gCACpB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oCACnB,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;oCACtD,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;wCACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAA;wCACjD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;4CACnD,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;wCACtD,CAAC;oCACH,CAAC;gCACH,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAA;oBAC3B,CAAC;iBACF;aACF,CAAC,CAAA;YAEF,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAA;YACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC3C,CAAC;KACF,CAAA;AACH,CAAC"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-glob-frontmatter",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "Astro content loader that injects frontmatter from external YAML/JSON files",
   "license": "MIT",