@jk2908/mdsrc 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 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.
+- Multi-type fields return a single `INVALID_TYPE` issue listing all attempted types when no type matches.
+- Fixed date modifier parsing — modifier values are now correctly converted to numbers before being passed to `new Date()`.
+- 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.
+
 ## 0.4.0 - 2026-06-23
 
 - Breaking: replaced the verbose schema API with a simplified string-based syntax. Fields are now declared as `fieldName: 'type'` instead of `fieldName: { type: 'type' }`, optional fields use a `?` suffix (e.g. `'metadata?'`), and nested objects are declared inline without a `schema` wrapper.

package/README.md

@@ -11,27 +11,19 @@ npm install @jk2908/mdsrc
 ## Usage
 
 ```ts
-import plugin, { type MarkdownItConfig } from '@jk2908/mdsrc'
-import comark from '@comark/markdown-it'
+import plugin from '@jk2908/mdsrc'
 import { defineConfig } from 'vite'
 
-const markdownItConfig: MarkdownItConfig = {
-	linkify: true,
-}
-
 export default defineConfig({
 	plugins: [
 		plugin({
-			markdown: {
-				plugins: [comark],
-				config: markdownItConfig,
-			},
 			collections: [
 				{
 					dir: 'content',
 					name: 'post',
 					schema: {
-						title: { type: 'string' },
+						title: 'string',
+						'date?': 'date',
 					},
 				},
 			],
@@ -40,18 +32,82 @@ 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 `markdown`, and `logger`. Collection config uses `name`, `dir`, and `schema`.
+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`.
+
+### Schema
+
+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:
 
-Each entry exports both `html` and `markdown`.
+- `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
+schema: {
+	title: 'string',
+	'metadata?': {
+		author: 'string',
+		publishedAt: 'date',
+	},
+}
+```
+
+### Compile Options
+
+Pass `compileOptions` to customise markdown parsing via satteri:
+
+```ts
+plugin({
+	compileOptions: {
+		features: {
+			gfm: true, // tables, footnotes, strikethrough, task lists
+			frontmatter: true, // YAML (---) and TOML (+++)
+			math: false, // LaTeX math blocks
+			smartPunctuation: true, // curly quotes, em-dashes, ellipses
+		},
+		mdastPlugins: [/* transform mdast tree */],
+		hastPlugins: [/* transform hast tree */],
+	},
+	collections: [/* ... */],
+})
+```
 
-- `html` is rendered with `markdown-it-ts`, with hard line breaks preserved by default.
-- Raw HTML is escaped by default because the renderer runs with `html: false`.
-- `markdown` preserves the original body for custom renderers like `@comark/react`.
+See [satteri](https://satteri.bruits.org/) for the full list of compile options and feature toggles.
 
-Use `markdown.plugins` for `markdown-it-ts` compatible plugins, and `markdown.config` to pass renderer options.
-`MarkdownItConfig` is re-exported from `@jk2908/mdsrc`, and `markdown.config` is merged with the default renderer options `{ html: false, breaks: true }`.
+### Output
 
-See `examples/basic` for the default HTML output flow and `examples/components` for the shared `@comark/markdown-it` plugin used with React.
+Each entry exports a `body` field containing the rendered HTML.
 
 If you configure a collection with `name: 'post'`, `mdsrc` exposes `allPosts` from the package root.
 
@@ -61,8 +117,7 @@ import { allPosts } from '@jk2908/mdsrc'
 export const summaries = allPosts.map(post => ({
 	title: post.title,
 	slug: post.__mdsrc.slug,
-	html: post.html,
-	markdown: post.markdown,
+	body: post.body,
 }))
 ```
 
@@ -76,4 +131,4 @@ The generated files live in `./.mdsrc` on disk, so you can import them directly
 
 ## License
 
-MIT
+MIT

package/dist/index.d.ts

@@ -1,16 +1,57 @@
 import type { Plugin } from 'vite';
-import type { BuildContext, PluginConfig } from './types.js';
+import { type MarkdownToHtmlResult } from 'satteri';
+import type { BuildContext, PluginConfig, Schema } from './types.js';
+export declare const DEFAULT_COMPILE_OPTIONS: {
+    features: {
+        frontmatter: true;
+    };
+};
 export type { 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;
 /**
  * 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,EAAuC,KAAK,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAExF,OAAO,KAAK,EAAE,YAAY,EAAc,YAAY,EAAO,MAAM,EAAE,MAAM,YAAY,CAAA;AAMrF,eAAO,MAAM,uBAAuB;;;;CAIV,CAAA;AAE1B,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;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,kBAgDnE;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;AAqJD;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAgJ1D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,UAExC"}