@nifrajs/content 2.1.0 → 2.3.0

package/README.md

@@ -1,8 +1,8 @@
 # @nifrajs/content
 
-Typed, schema-validated content collections for nifra — Markdown + frontmatter, framework-agnostic.
+Typed, schema-validated content collections for nifra - Markdown + frontmatter, framework-agnostic.
 
-Part of the **[nifra](https://nifra.dev)** full-stack TypeScript framework — one core, five UI libraries, every runtime. Scaffold a new app with `bun create nifra`.
+Part of the **[nifra](https://nifra.dev)** full-stack TypeScript framework - one core, five UI libraries, every runtime. Scaffold a new app with `bun create nifra`.
 
 ## Install
 
@@ -19,7 +19,7 @@ MIT
 
 ## For AI agents
 
-Start with [`LLM.md`](./LLM.md) — this package's contract card (the exports you call + its footguns),
+Start with [`LLM.md`](./LLM.md) - this package's contract card (the exports you call + its footguns),
 one cheap read instead of the whole corpus. For the wider framework: the repo's
 [`AGENTS.md`](../../AGENTS.md) is the copy-paste quick reference, and
 [`llms-full.txt`](../../llms-full.txt) is the full machine-readable corpus. Run `nifra check` as the

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nifrajs/content",
-  "version": "2.1.0",
-  "description": "Typed, schema-validated content collections for nifra — Markdown + frontmatter, framework-agnostic.",
+  "version": "2.3.0",
+  "description": "Typed, schema-validated content collections for nifra - Markdown + frontmatter, framework-agnostic.",
   "keywords": [
     "bun",
     "typescript",

package/src/fs.ts

@@ -1,7 +1,7 @@
 /**
- * Filesystem-backed content collections — `defineCollection` reads a directory of Markdown files and
+ * Filesystem-backed content collections - `defineCollection` reads a directory of Markdown files and
  * gives you a typed, validated API over them. Build/server-time (Bun/Node/Deno); for the edge, bake the
- * entries at build (the manifest approach `@nifrajs/web/fs` uses for routes) — tracked as a follow-up.
+ * entries at build (the manifest approach `@nifrajs/web/fs` uses for routes) - tracked as a follow-up.
  */
 import { readdirSync, readFileSync, statSync } from "node:fs"
 import { resolve, sep } from "node:path"
@@ -18,7 +18,7 @@ export interface CollectionConfig<S extends StandardSchemaV1> {
 
 /** A typed collection over a content directory. */
 export interface Collection<Frontmatter> {
-  /** Every entry in the directory (unordered — sort/filter in your loader). Throws if any file's
+  /** Every entry in the directory (unordered - sort/filter in your loader). Throws if any file's
    * frontmatter is invalid. */
   all(): Promise<Array<Entry<Frontmatter>>>
   /** One entry by slug (filename without extension), or `null` if not found. */
@@ -66,7 +66,7 @@ interface CollectionSnapshot<Frontmatter> {
 /**
  * Define a content collection backed by a directory. `all()` discovers + parses every matching file;
  * `get(slug)` loads one. Frontmatter is validated against `schema`, so entries are fully typed and a
- * malformed file fails loudly. Reads the filesystem — use it at build time (SSG/prerender) or on a
+ * malformed file fails loudly. Reads the filesystem - use it at build time (SSG/prerender) or on a
  * long-lived server (Bun/Node/Deno).
  */
 export function defineCollection<S extends StandardSchemaV1>(

package/src/index.ts

@@ -1,7 +1,7 @@
 /**
- * Typed content collections for nifra — the **framework-agnostic core**. Parse a Markdown file's
+ * Typed content collections for nifra - the **framework-agnostic core**. Parse a Markdown file's
  * frontmatter + body, validate the frontmatter against a Standard Schema (`@nifrajs/schema`'s `t`, zod,
- * valibot), and render the body to HTML. Pure (no filesystem, no DOM) so it runs anywhere — pair it
+ * valibot), and render the body to HTML. Pure (no filesystem, no DOM) so it runs anywhere - pair it
  * with `@nifrajs/content/fs`'s `defineCollection` for fs-backed discovery on Bun/Node/Deno + at build.
  *
  *   import { t } from "@nifrajs/schema"
@@ -12,7 +12,7 @@
  *     schema: t.object({ title: t.string(), date: t.string(), draft: t.boolean() }),
  *   })
  *
- *   // in a loader — typed + validated entries, no manual fs/frontmatter parsing:
+ *   // in a loader - typed + validated entries, no manual fs/frontmatter parsing:
  *   const posts = (await blog.all()).filter((p) => !p.frontmatter.draft)
  *   //    posts[0].frontmatter is { title: string; date: string; draft: boolean }
  *   //    posts[0].html is the rendered Markdown
@@ -26,7 +26,7 @@ interface StandardIssue {
 }
 
 /**
- * Minimal [Standard Schema](https://standardschema.dev) shape — lets frontmatter validate against any
+ * Minimal [Standard Schema](https://standardschema.dev) shape - lets frontmatter validate against any
  * compliant validator (`@nifrajs/schema`'s `t`, zod, valibot, …) without coupling `@nifrajs/content` to one.
  */
 export interface StandardSchemaV1<Output = unknown> {
@@ -73,14 +73,14 @@ export function parseFrontmatter(raw: string): { data: unknown; body: string } {
 export interface ParseEntryOptions<S extends StandardSchemaV1> {
   readonly raw: string
   readonly slug: string
-  /** Standard Schema validating the frontmatter — a typo'd/missing field throws (a build-time failure,
+  /** Standard Schema validating the frontmatter - a typo'd/missing field throws (a build-time failure,
    * never a broken page). */
   readonly schema: S
 }
 
 /**
  * Parse one content file: split + validate its frontmatter against `schema`, render its Markdown body
- * to HTML. Throws a descriptive error (naming the slug + the issues) when the frontmatter is invalid —
+ * to HTML. Throws a descriptive error (naming the slug + the issues) when the frontmatter is invalid -
  * surface it at build/load time rather than shipping a malformed entry. Pure + edge-safe.
  */
 export async function parseEntry<S extends StandardSchemaV1>(
@@ -92,7 +92,7 @@ export async function parseEntry<S extends StandardSchemaV1>(
     const detail = result.issues.map((issue) => issue.message).join("; ")
     throw new Error(`@nifrajs/content: invalid frontmatter in "${options.slug}": ${detail}`)
   }
-  // `marked.parse` is sync by default but may be async with extensions — await covers both. Content is
+  // `marked.parse` is sync by default but may be async with extensions - await covers both. Content is
   // author-controlled (your own files), so raw HTML in Markdown is passed through (standard SSG
   // behavior); sanitize yourself if a collection ever holds untrusted input.
   const html = await marked.parse(body)
@@ -100,7 +100,7 @@ export async function parseEntry<S extends StandardSchemaV1>(
 }
 
 /**
- * A content collection baked to plain data — fs-free, so it works at the **edge** (Workers
+ * A content collection baked to plain data - fs-free, so it works at the **edge** (Workers
  * request-time) where `defineCollection`'s `node:fs` reader can't run. Produce one at build/server time
  * with `bakeCollection`, JSON-serialize + ship it in the bundle, then rehydrate with `fromBaked`.
  */
@@ -108,7 +108,7 @@ export interface BakedCollection<Frontmatter> {
   readonly entries: ReadonlyArray<Entry<Frontmatter>>
 }
 
-/** Read-only collection surface (`all()`/`get()`) — structurally compatible with `defineCollection`'s
+/** Read-only collection surface (`all()`/`get()`) - structurally compatible with `defineCollection`'s
  * `Collection`, but with no filesystem access. */
 export interface StaticCollection<Frontmatter> {
   all(): Promise<ReadonlyArray<Entry<Frontmatter>>>
@@ -118,7 +118,7 @@ export interface StaticCollection<Frontmatter> {
 /**
  * Bake a collection's entries to serializable data at build/server time. The collection does the
  * filesystem read + validation (via `all()`); this just collects the already-parsed result so it can be
- * JSON-serialized into the edge bundle. Pure — safe to import anywhere.
+ * JSON-serialized into the edge bundle. Pure - safe to import anywhere.
  */
 export async function bakeCollection<Frontmatter>(collection: {
   all(): Promise<ReadonlyArray<Entry<Frontmatter>>>
@@ -127,7 +127,7 @@ export async function bakeCollection<Frontmatter>(collection: {
 }
 
 /**
- * Rehydrate a baked collection into a read-only `all()`/`get()` collection — fs-free, edge-safe. The
+ * Rehydrate a baked collection into a read-only `all()`/`get()` collection - fs-free, edge-safe. The
  * entries were validated when baked (build output, trusted), so they're served as-is. `get` is O(1).
  */
 export function fromBaked<Frontmatter>(

package/src/mdx.ts

@@ -1,5 +1,5 @@
 /**
- * `mdxBunPlugin` — a `Bun.build` plugin that compiles `.mdx` files (Markdown + JSX components) into
+ * `mdxBunPlugin` - a `Bun.build` plugin that compiles `.mdx` files (Markdown + JSX components) into
  * components for your UI framework, so an `.mdx` file can be a nifra route or be imported like a module.
  * Pass it to `buildClient`/`buildServer`'s `plugins`, and add `.mdx` to your route discovery.
  *
@@ -13,22 +13,22 @@
  *   })
  *
  * MDX is JSX-oriented, so this targets the JSX family (React/Preact/Solid) via `jsxImportSource`. Needs
- * `@mdx-js/mdx` installed (an optional peer — lazy-loaded at build time only).
+ * `@mdx-js/mdx` installed (an optional peer - lazy-loaded at build time only).
  */
 import type { BunPlugin } from "bun"
 
 export interface MdxPluginOptions {
-  /** JSX runtime source the compiled MDX imports from — `"react"` (default), `"preact"`, `"solid-js"`. */
+  /** JSX runtime source the compiled MDX imports from - `"react"` (default), `"preact"`, `"solid-js"`. */
   readonly jsxImportSource?: string
   /** Emit development JSX (line numbers, `jsxDEV`). Default `false`. */
   readonly development?: boolean
-  /** Extra `@mdx-js/mdx` `compile` options — e.g. `remarkPlugins`/`rehypePlugins` (GFM, slugs, …). */
+  /** Extra `@mdx-js/mdx` `compile` options - e.g. `remarkPlugins`/`rehypePlugins` (GFM, slugs, …). */
   readonly compileOptions?: Record<string, unknown>
-  /** Advanced: override the compiler module specifier (default `"@mdx-js/mdx"`) — e.g. to use a fork. */
+  /** Advanced: override the compiler module specifier (default `"@mdx-js/mdx"`) - e.g. to use a fork. */
   readonly moduleName?: string
 }
 
-// Non-literal specifier so tsc/consumers don't need `@mdx-js/mdx`'s types to typecheck this file — it's
+// Non-literal specifier so tsc/consumers don't need `@mdx-js/mdx`'s types to typecheck this file - it's
 // an optional peer, imported only when the plugin actually runs (mirrors `@nifrajs/node`'s lazy `ws`).
 const MDX_MODULE = "@mdx-js/mdx"
 
@@ -53,10 +53,10 @@ export function mdxBunPlugin(options: MdxPluginOptions = {}): BunPlugin {
         compile = mod.compile
       } catch {
         throw new Error(
-          "@nifrajs/content/mdx: compiling `.mdx` needs the `@mdx-js/mdx` package — install it (`bun add @mdx-js/mdx`).",
+          "@nifrajs/content/mdx: compiling `.mdx` needs the `@mdx-js/mdx` package - install it (`bun add @mdx-js/mdx`).",
         )
       }
-      // Tolerate a `?query` suffix — `nifra dev` (Vite) appends an import-cache-busting query so edited
+      // Tolerate a `?query` suffix - `nifra dev` (Vite) appends an import-cache-busting query so edited
       // `.mdx` re-SSR; strip it before reading off disk.
       build.onLoad({ filter: /\.mdx(\?|$)/ }, async (args) => {
         const path = args.path.split("?")[0] ?? args.path
@@ -66,7 +66,7 @@ export function mdxBunPlugin(options: MdxPluginOptions = {}): BunPlugin {
           development,
           ...options.compileOptions,
         })
-        // `loader: "jsx"` — the compiled output still contains JSX; Bun applies the JSX transform with
+        // `loader: "jsx"` - the compiled output still contains JSX; Bun applies the JSX transform with
         // the active `jsxImportSource`. Markup is hydration-equivalent to a hand-written component.
         return { contents: String(compiled), loader: "jsx" }
       })