@tabnas/markdown 0.2.1 → 0.4.2

package/README.md

@@ -1,10 +1,6 @@
 # @tabnas/markdown (TypeScript)
 
-A [Tabnas](https://github.com/tabnas/parser) grammar plugin that parses
-delimited record text — a header row, comma-separated fields, one record per
-line, with RFC-4180 quoting — into arrays of objects or arrays. Despite the
-name it is a configurable CSV/TSV-family reader, with support for headers,
-quoted fields, custom delimiters, streaming, and strict / non-strict modes.
+A [Tabnas](https://github.com/tabnas/parser) grammar plugin that parses **CommonMark / GFM Markdown** into a JSON AST. Built on the bare `@tabnas/parser` engine.
 
 [![npm version](https://img.shields.io/npm/v/@tabnas/markdown.svg)](https://npmjs.com/package/@tabnas/markdown)
 [![build](https://github.com/tabnas/markdown/actions/workflows/build.yml/badge.svg)](https://github.com/tabnas/markdown/actions/workflows/build.yml)
@@ -15,50 +11,26 @@ quoted fields, custom delimiters, streaming, and strict / non-strict modes.
 ## Install
 
 ```bash
-npm install @tabnas/markdown @tabnas/parser @tabnas/jsonic
+npm install @tabnas/markdown @tabnas/parser
 ```
 
-`@tabnas/parser` (>=2) and `@tabnas/jsonic` are peer dependencies. Requires
-Node >=24.
+`@tabnas/parser` (>=0) is the only peer dependency. Requires Node >=24.
 
 ## Example
 
 ```js
 import { Tabnas } from '@tabnas/parser'
-import { jsonic } from '@tabnas/jsonic'
 import { Markdown } from '@tabnas/markdown'
 
-const j = new Tabnas().use(jsonic).use(Markdown)
+const j = new Tabnas().use(Markdown)
 
-j.parse('name,age\nAlice,30\nBob,25') // => [{ name: 'Alice', age: '30' }, { name: 'Bob', age: '25' }]
-
-// quoted fields use "" to escape a quote:
-j.parse('a\n"b""c"') // => [{ a: 'b"c' }]
+j.parse('# Hello\n\nHello *world*') // => { type: 'document', children: [{ type: 'heading', depth: 1, children: [{ type: 'text', value: 'Hello' }] }, { type: 'paragraph', children: [{ type: 'text', value: 'Hello ' }, { type: 'emphasis', children: [{ type: 'text', value: 'world' }] }] }] }
+j.parse('# Hello') // => { type: 'document', children: [{ type: 'heading', depth: 1, children: [{ type: 'text', value: 'Hello' }] }] }
 ```
 
 ## Documentation
 
-Documentation follows the [Diátaxis](https://diataxis.fr) framework:
-
-- [Tutorial](doc/tutorial.md) — a guided first run.
-- [How-to guide](doc/guide.md) — task recipes (delimiters, no-header, streaming, errors, embedded JSON).
-- [Reference](doc/reference.md) — the full API, every option, and the grammar accepted.
-- [Concepts](doc/concepts.md) — how the plugin works on the engine and why.
-
-For the Go version, see [../go/README.md](../go/README.md).
-
-## Grammar diagram
-
-The live grammar as a railroad diagram (regenerated with
-[`@tabnas/railroad`](https://github.com/tabnas/railroad)):
-
-![markdown grammar railroad diagram](doc/grammar.svg)
-
-ASCII version: [`doc/grammar.txt`](doc/grammar.txt). The grammar source is the
-top-level [`markdown-grammar.jsonic`](../markdown-grammar.jsonic), embedded by
-[`embed-grammar.js`](embed-grammar.js) during `npm run build`.
-
-## License
-
-Copyright (c) 2021-2025 Richard Rodger and other contributors,
-[MIT License](LICENSE).
+- [Tutorial](doc/tutorial.md) — first parse in 5 minutes.
+- [How-to guide](doc/guide.md) — task recipes.
+- [Reference](doc/reference.md) — API + options + AST.
+- [Concepts](doc/concepts.md) — how it works.

package/dist/markdown.d.ts

@@ -1,30 +1,90 @@
-import { Plugin, Config, TabnasOptions, Lex, Token } from '@tabnas/parser';
-type MarkdownOptions = {
-    trim: boolean | null;
-    comment: boolean | null;
-    number: boolean | null;
-    value: boolean | null;
-    header: boolean;
-    object: boolean;
-    stream: null | ((what: string, record?: Record<string, any> | Error) => void);
-    strict: boolean;
-    field: {
-        separation: null | string;
-        nonameprefix: string;
-        empty: any;
-        names: undefined | string[];
-        exact: boolean;
-    };
-    record: {
-        separators: null | string;
-        empty: boolean;
-    };
-    string: {
-        quote: string;
-        markdown: null | boolean;
-    };
+import { Plugin } from '@tabnas/parser';
+export type MarkdownOptions = {
+    /** Enable GFM extensions (strikethrough `~~`, task lists, tables — tables deferred, see dx-report). */
+    gfm?: boolean;
+    /** When true, a single soft break becomes a hard break. Default false. */
+    breaks?: boolean;
 };
+export type DocumentNode = {
+    type: 'document';
+    children: Block[];
+};
+export type Block = HeadingNode | ParagraphNode | BlockquoteNode | ListNode | ListItemNode | CodeNode | HtmlNode | ThematicBreakNode;
+export type HeadingNode = {
+    type: 'heading';
+    depth: 1 | 2 | 3 | 4 | 5 | 6;
+    children: Inline[];
+};
+export type ParagraphNode = {
+    type: 'paragraph';
+    children: Inline[];
+};
+export type BlockquoteNode = {
+    type: 'blockquote';
+    children: Block[];
+};
+export type ListNode = {
+    type: 'list';
+    ordered: boolean;
+    start: number | null;
+    spread: boolean;
+    children: ListItemNode[];
+};
+export type ListItemNode = {
+    type: 'listItem';
+    spread: boolean;
+    children: Block[];
+};
+export type CodeNode = {
+    type: 'code';
+    lang: string | null;
+    meta: string | null;
+    value: string;
+};
+export type HtmlNode = {
+    type: 'html';
+    value: string;
+};
+export type ThematicBreakNode = {
+    type: 'thematicBreak';
+};
+export type Inline = TextNode | EmphasisNode | StrongNode | InlineCodeNode | LinkNode | ImageNode | BreakNode | DeleteNode;
+export type TextNode = {
+    type: 'text';
+    value: string;
+};
+export type EmphasisNode = {
+    type: 'emphasis';
+    children: Inline[];
+};
+export type StrongNode = {
+    type: 'strong';
+    children: Inline[];
+};
+export type InlineCodeNode = {
+    type: 'inlineCode';
+    value: string;
+};
+export type LinkNode = {
+    type: 'link';
+    url: string;
+    title: string | null;
+    children: Inline[];
+};
+export type ImageNode = {
+    type: 'image';
+    url: string;
+    title: string | null;
+    alt: string;
+};
+export type BreakNode = {
+    type: 'break';
+};
+export type DeleteNode = {
+    type: 'delete';
+    children: Inline[];
+};
+declare function parseInline(text: string, opts: Required<MarkdownOptions>): Inline[];
+declare function parseDocument(src: string, opts: Required<MarkdownOptions>): DocumentNode;
 declare const Markdown: Plugin;
-declare function buildMarkdownStringMatcher(mdopts: MarkdownOptions): (cfg: Config, _opts: TabnasOptions) => (lex: Lex) => Token | undefined;
-export { Markdown, buildMarkdownStringMatcher };
-export type { MarkdownOptions };
+export { Markdown, parseDocument, parseInline, };