@jk2908/mdsrc 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.6.0 - 2026-07-01
+
+- For Markdown files, non-frontmatter content is now available on the `html` field, replacing `body`.
+- Added support for `.mdx` files. MDX entries now generate a `Component` field instead of `html`.
+- Added cleanup to remove stale generated files and empty directories when source files are removed or renamed.
+- Improved pluralisation for generated collection names and types.
+
+## 0.5.0 - 2026-06-25
+
+- Added multi-type support using pipe syntax: `'string|number'`. The first matching type wins.
+- Added validation modifiers via pipe syntax: `'string|min=3|max=6'`, `'number|min=18'`, `'date|max=1735689600000'`, `'array|min=2'`.
+- Added `array` as a supported primitive type with `min`/`max` length modifiers.
+- Added `BAD_MODIFIER` issue code for unparseable modifier values.
+- Added `INVALID_LENGTH` issue code for string and array length constraint failures.
+- Added `INVALID_SIZE` issue code for number value constraint failures.
+- Single-type fields now return specific issue codes (e.g. `INVALID_DATE` for invalid dates, `INVALID_TYPE` for wrong type) instead of a generic message.
+- Multi-type fields return a single `INVALID_TYPE` issue listing all attempted types when no type matches.
+- Moved validation logic into `src/validate.ts`.
+
 ## 0.4.1 - 2026-06-23
 
 - Updated README to reflect the new schema API and removed outdated markdown-it references.

package/README.md

@@ -32,14 +32,45 @@ export default defineConfig({
 })
 ```
 
-The plugin reads markdown content, validates frontmatter against your schema, and generates typed modules during build and watch. Root config uses `collections`, optional `compileOptions`, and `logger`. Collection config uses `name`, `dir`, and `schema`.
+The plugin reads markdown and MDX content, validates frontmatter against your schema, and generates typed modules during build and watch. Root config uses `collections`, optional `compileOptions`, and `logger`. Collection config uses `name`, `dir`, and `schema`.
 
 ### Schema
 
-Fields are declared as `fieldName: 'type'`. Supported types: `string`, `number`, `boolean`, `date`, `object`.
+Fields are declared as `fieldName: 'type'`. Supported types: `string`, `number`, `boolean`, `date`, `array`.
 
 Optional fields use a `?` suffix: `'metadata?': { author: 'string' }`.
 
+Multiple types can be combined with `|`:
+
+```ts
+schema: {
+	val: 'string|number',
+}
+```
+
+Validation modifiers are supported:
+
+- `min`: 
+	- strings: minimum string length
+	- numbers: minimum value
+	- dates: earliest allowed date
+	- arrays: minimum array length
+
+- `max`:
+	- strings: maximum string length
+	- numbers: maximum value
+	- dates: latest allowed date
+	- arrays: maximum array length
+
+```ts
+schema: {
+	title: 'string|min=3|max=6',
+	age: 'number|min=18',
+	date: 'date|max=1735689600000',
+	tags: 'array|min=2',
+}
+```
+
 Nested objects are declared inline:
 
 ```ts
@@ -76,7 +107,7 @@ See [satteri](https://satteri.bruits.org/) for the full list of compile options
 
 ### Output
 
-Each entry exports a `body` field containing the rendered HTML.
+Each entry exports a `html` field containing the rendered HTML for markdown files, or a `Component` field for MDX files.
 
 If you configure a collection with `name: 'post'`, `mdsrc` exposes `allPosts` from the package root.
 
@@ -86,10 +117,29 @@ import { allPosts } from '@jk2908/mdsrc'
 export const summaries = allPosts.map(post => ({
 	title: post.title,
 	slug: post.__mdsrc.slug,
-	body: post.body,
+	html: post.html,
 }))
 ```
 
+#### Using MDX Components
+
+For `.mdx` files, the generated entry includes a `Component` that you can render in your application. You can also pass custom components to it.
+
+For example, to render a post and provide a custom `h1` component:
+
+```tsx
+import { allPosts } from '@jk2908/mdsrc'
+
+const post = allPosts.find(p => p.__mdsrc.slug === 'my-first-post')
+const H1 = ({ children }) => <h1 style={{ color: 'red' }}>{children}</h1>
+
+export function Post() {
+	if (!post || !post.Component) return <div>Not found</div>
+
+	return <post.Component components={{ h1: H1 }} />
+}
+```
+
 If you want the generated collection module directly, you can also import the collection subpath.
 
 ```ts

package/dist/config.d.ts

@@ -1,4 +1,5 @@
 export declare const NAME = "mdsrc";
 export declare const PKG_NAME = "@jk2908/mdsrc";
 export declare const GENERATED_DIR = ".mdsrc";
+export declare const AUTOGEN_MSG = "// auto-generated by mdsrc";
 //# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,UAAU,CAAA;AAC3B,eAAO,MAAM,QAAQ,kBAAoB,CAAA;AACzC,eAAO,MAAM,aAAa,WAAa,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,UAAU,CAAA;AAC3B,eAAO,MAAM,QAAQ,kBAAoB,CAAA;AACzC,eAAO,MAAM,aAAa,WAAa,CAAA;AACvC,eAAO,MAAM,WAAW,+BAAiC,CAAA"}

package/dist/config.js

@@ -1,4 +1,5 @@
 export const NAME = 'mdsrc';
 export const PKG_NAME = `@jk2908/${NAME}`;
 export const GENERATED_DIR = `.${NAME}`;
+export const AUTOGEN_MSG = `// auto-generated by ${NAME}`;
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAA;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,IAAI,EAAE,CAAA;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAA"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAA;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,IAAI,EAAE,CAAA;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAA;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,wBAAwB,IAAI,EAAE,CAAA"}

package/dist/index.d.ts

@@ -1,16 +1,61 @@
 import type { Plugin } from 'vite';
-import type { BuildContext, PluginConfig } from './types.js';
-export type { CompileOptions } from './types.js';
+import { type MarkdownToHtmlResult } from 'satteri';
+import type { BuildContext, Manifest, PluginConfig, Schema } from './types.js';
+export declare const DEFAULT_COMPILE_OPTIONS: {
+    features: {
+        frontmatter: true;
+    };
+};
+export type { Collection, CompileOptions } from './types.js';
+/**
+ * Parse YAML or TOML frontmatter
+ */
+export declare function parse(frontmatter: MarkdownToHtmlResult['frontmatter']): Promise<any>;
 /**
  * Read every markdown file in a collection and turn it into the raw entry shape
  * add mdsrc metadata like slug and filename alongside the trimmed body
  * return an empty list if the directory read fails
  */
 export declare function create(dir: string, buildContext: BuildContext): Promise<any[]>;
+/**
+ * Returns whether the error was caused by a missing file or directory
+ */
+export declare function isENOENT(err: unknown): boolean;
+/**
+ * LRU cache for file content. Stores the last written content per file path
+ * so `maybeWrite` can skip disk I/O when nothing has changed.
+ *
+ * Uses Map insertion order to track recency: the front of the map holds the
+ * least recently used entries, which are evicted first when the cache is full.
+ */
+export declare const fileCache: Map<string, string>;
+export declare const FILE_CACHE_MAX_SIZE = 100;
+/**
+ * Promote an existing cache entry to most-recently-used by deleting and
+ * re-inserting it, which moves it to the end of the Map's iteration
+ * order. If the cache is at capacity, evict the least recently used
+ * entry (front) before inserting
+ */
+export declare function setFileCache(filePath: string, content: string): void;
+/**
+ * Retrieve a cached value and promote it to most-recently-used so it won't
+ * be evicted while still actively referenced
+ */
+export declare function getFileCache(filePath: string): string | undefined;
+/**
+ * Write a file only if the content has changed since the last build
+ */
+export declare function maybeWrite(filePath: string, content: string): Promise<boolean>;
+export declare function schemaToType(schema: Schema): string;
+export declare function getManifest(outDir: string): Promise<{
+    [k: string]: string[];
+} | null>;
+export declare function cleanup(outDir: string, manifest: Manifest, prevManifest: Manifest | null): Promise<boolean>;
 /**
  * Build the Vite plugin that validates collections and writes the generated modules
  * keep the runtime data and declaration files in the same pass
  * resolve package imports from the generated directory
  */
 export default function mdsrc(config: PluginConfig): Plugin;
+export declare function toModuleName(name: string): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,MAAM,CAAA;AAIjD,OAAO,KAAK,EACX,YAAY,EAIZ,YAAY,EAIZ,MAAM,YAAY,CAAA;AAanB,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAoBhD;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,kBAgDnE;AA4VD;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAoJ1D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,MAAM,CAAA;AAEjD,OAAO,EAIN,KAAK,oBAAoB,EACzB,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAEX,YAAY,EAEZ,QAAQ,EAER,YAAY,EAEZ,MAAM,EACN,MAAM,YAAY,CAAA;AAanB,eAAO,MAAM,uBAAuB;;;;CAIV,CAAA;AAI1B,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE5D;;GAEG;AACH,wBAAsB,KAAK,CAAC,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,gBAa3E;AAED;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,kBA+DnE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,WAEpC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,qBAA4B,CAAA;AAElD,eAAO,MAAM,mBAAmB,MAAM,CAAA;AAEtC;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,QAY7D;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,sBAQ5C;AAED;;GAEG;AACH,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,oBAyBjE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,UAoB1C;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM;;UAiB/C;AAED,wBAAsB,OAAO,CAC5B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,GAAG,IAAI,oBAsC7B;AAiND;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAgJ1D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,UAExC"}