npm - comark - Versions diffs - 0.3.1 → 0.4.0 - Mend

comark 0.3.1 → 0.4.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 (93) hide show

package/dist/internal/frontmatter.d.ts +1 -0
package/dist/internal/frontmatter.js +4 -2
package/dist/internal/parse/auto-close/index.js +69 -31
package/dist/internal/parse/auto-close/table.js +12 -9
package/dist/internal/parse/auto-unwrap.js +6 -10
package/dist/internal/parse/html/html_block_rule.js +10 -16
package/dist/internal/parse/html/html_inline_rule.js +3 -7
package/dist/internal/parse/html/html_re.js +1 -1
package/dist/internal/parse/html/index.d.ts +1 -0
package/dist/internal/parse/html/index.js +15 -3
package/dist/internal/parse/syntax/block-params.d.ts +9 -0
package/dist/internal/parse/syntax/block-params.js +48 -0
package/dist/internal/parse/syntax/brackets.d.ts +8 -0
package/dist/internal/parse/syntax/brackets.js +20 -0
package/dist/internal/parse/syntax/props.d.ts +5 -0
package/dist/internal/parse/syntax/props.js +119 -0
package/dist/internal/parse/token-processor.js +89 -50
package/dist/internal/props-validation.js +4 -9
package/dist/internal/stringify/attributes.d.ts +7 -0
package/dist/internal/stringify/attributes.js +56 -1
package/dist/internal/stringify/handlers/a.js +1 -3
package/dist/internal/stringify/handlers/blockquote.js +19 -4
package/dist/internal/stringify/handlers/code.js +1 -3
package/dist/internal/stringify/handlers/emphesis.js +1 -3
package/dist/internal/stringify/handlers/heading.js +6 -1
package/dist/internal/stringify/handlers/html.js +34 -18
package/dist/internal/stringify/handlers/img.js +1 -3
package/dist/internal/stringify/handlers/li.js +18 -9
package/dist/internal/stringify/handlers/mdc.js +3 -4
package/dist/internal/stringify/handlers/ol.js +12 -2
package/dist/internal/stringify/handlers/p.d.ts +1 -1
package/dist/internal/stringify/handlers/p.js +8 -1
package/dist/internal/stringify/handlers/pre.js +20 -14
package/dist/internal/stringify/handlers/strong.js +1 -3
package/dist/internal/stringify/handlers/table.js +14 -5
package/dist/internal/stringify/handlers/template.js +5 -2
package/dist/internal/stringify/handlers/ul.js +12 -2
package/dist/internal/stringify/state.js +1 -1
package/dist/internal/yaml.js +1 -1
package/dist/parse.d.ts +4 -4
package/dist/parse.js +20 -10
package/dist/plugins/alert.d.ts +1 -1
package/dist/plugins/alert.js +1 -1
package/dist/plugins/binding.d.ts +1 -1
package/dist/plugins/binding.js +1 -3
package/dist/plugins/breaks.d.ts +1 -1
package/dist/plugins/breaks.js +1 -1
package/dist/plugins/emoji.d.ts +1 -1
package/dist/plugins/emoji.js +8 -8
package/dist/plugins/footnotes.d.ts +1 -1
package/dist/plugins/footnotes.js +19 -13
package/dist/plugins/headings.d.ts +19 -8
package/dist/plugins/headings.js +27 -19
package/dist/plugins/highlight.d.ts +2 -12
package/dist/plugins/highlight.js +201 -103
package/dist/plugins/json-render.d.ts +1 -1
package/dist/plugins/json-render.js +5 -9
package/dist/plugins/math.d.ts +1 -1
package/dist/plugins/math.js +4 -6
package/dist/plugins/mermaid.d.ts +1 -1
package/dist/plugins/mermaid.js +6 -20
package/dist/plugins/punctuation.d.ts +1 -1
package/dist/plugins/punctuation.js +5 -6
package/dist/plugins/security.d.ts +1 -1
package/dist/plugins/security.js +2 -2
package/dist/plugins/summary.d.ts +4 -1
package/dist/plugins/syntax.d.ts +49 -0
package/dist/plugins/syntax.js +558 -0
package/dist/plugins/task-list.d.ts +2 -2
package/dist/plugins/task-list.js +11 -8
package/dist/plugins/toc.d.ts +3 -1
package/dist/plugins/toc.js +1 -1
package/dist/types.d.ts +57 -12
package/dist/utils/comark.tmLanguage.d.ts +335 -0
package/dist/utils/comark.tmLanguage.js +597 -0
package/dist/utils/helpers.d.ts +16 -4
package/dist/utils/helpers.js +16 -6
package/dist/utils/index.d.ts +5 -0
package/dist/utils/index.js +25 -3
package/package.json +40 -40
package/skills/comark/references/rendering-svelte.md +51 -7
package/dist/internal/stringify/indent.d.ts +0 -5
package/dist/internal/stringify/indent.js +0 -9
package/dist/vite.d.ts +0 -1
package/dist/vite.js +0 -1
package/skills/skills/comark/AGENTS.md +0 -261
package/skills/skills/comark/SKILL.md +0 -489
package/skills/skills/comark/references/markdown-syntax.md +0 -599
package/skills/skills/comark/references/parsing-ast.md +0 -378
package/skills/skills/comark/references/rendering-react.md +0 -445
package/skills/skills/comark/references/rendering-svelte.md +0 -453
package/skills/skills/comark/references/rendering-vue.md +0 -462
/package/skills/{skills/migrate-mdc-to-comark → migrate-mdc-to-comark}/SKILL.md +0 -0

package/dist/types.d.ts CHANGED Viewed

@@ -1,6 +1,12 @@
 import type { DumpOptions } from 'js-yaml';
 import type MarkdownExit from 'markdown-exit';
 import type MarkdownIt from 'markdown-it';
+/**
+ * The `[keyof T] extends [never]` form (rather than `keyof T extends never`)
+ * is the standard trick to prevent TS from distributing the check over a
+ * union — we want to test "is T's keyset empty?" as one yes/no question.
+ */
+type Writable<T> = [keyof T] extends [never] ? Record<string, any> : T;
 /**
  * The Comark text
  * @param string - The text content
@@ -43,11 +49,14 @@ export type ComarkNode = ComarkElement | ComarkText | ComarkComment;
  * @param nodes - The nodes of the tree
  * @param frontmatter - The frontmatter data which is the data at the top of the file
  * @param meta - The meta data of tree, it can be used to store additional data for the tree
+ *
+ * The `TMeta` and `TFrontmatter` type parameters allow `parse` / `createParse`
+ * to surface plugin-contributed keys with narrow types (see `MergePluginMeta`).
  */
-export interface ComarkTree {
+export interface ComarkTree<TMeta = Record<string, any>, TFrontmatter = Record<string, any>> {
     nodes: ComarkNode[];
-    frontmatter: Record<string, any>;
-    meta: Record<string, any>;
+    frontmatter: TFrontmatter;
+    meta: TMeta;
 }
 export interface ContextBase {
     /**
@@ -228,31 +237,66 @@ export interface NodeRenderData {
 }
 export type MarkdownExitPlugin = (md: MarkdownExit) => void;
 export type MarkdownItPlugin = (md: MarkdownIt) => void;
+export type MarkdownItPluginWithOptions<T> = (md: MarkdownIt, options: T) => void;
 export type ComarkParsePreState = {
     markdown: string;
     options: ParseOptions;
     [key: string]: any;
 };
-export type ComarkParsePostState = {
+export type ComarkParsePostState<TMeta = Record<string, any>, TFrontmatter = Record<string, any>> = {
     markdown: string;
-    tree: ComarkTree;
+    tree: ComarkTree<TMeta, TFrontmatter>;
     options: ParseOptions;
     tokens: unknown[];
     [key: string]: any;
 };
-export type ComarkPlugin = {
+/**
+ * A Comark plugin.
+ *
+ * `TMeta` / `TFrontmatter` are phantom type parameters that record what this
+ * plugin contributes to `tree.meta` / `tree.frontmatter`. They are surfaced
+ * only via the optional `__meta` / `__frontmatter` markers — implementations
+ * never set these at runtime; they exist purely so the contribution survives
+ * `ReturnType<typeof factory>` inference and can be merged in `createParse`.
+ */
+export type ComarkPlugin<TMeta = {}, TFrontmatter = {}> = {
     name: string;
     markdownItPlugins?: MarkdownItPlugin[];
     pre?: (state: ComarkParsePreState) => Promise<void> | void;
-    post?: (state: ComarkParsePostState) => Promise<void> | void;
+    post?: (state: ComarkParsePostState<Writable<TMeta>, Writable<TFrontmatter>>) => Promise<void> | void;
+    /** Phantom — used for type inference only. Never set at runtime. */
+    __meta?: TMeta;
+    /** Phantom — used for type inference only. Never set at runtime. */
+    __frontmatter?: TFrontmatter;
 };
-export type ComarkPluginFactory<Options> = (opts?: Options) => ComarkPlugin;
-export type ComponentManifest = (name: string) => Promise<unknown> | undefined | null;
+export type ComarkPluginFactory<Options, TMeta = {}, TFrontmatter = {}> = (opts?: Options) => ComarkPlugin<TMeta, TFrontmatter>;
+type PluginMetaOf<P> = P extends ComarkPlugin<infer M, any> ? M : {};
+type PluginFrontmatterOf<P> = P extends ComarkPlugin<any, infer F> ? F : {};
+/**
+ * Walk a tuple of plugins and intersect their meta contributions.
+ * Returns `{}` when the tuple is empty or when nothing was contributed.
+ */
+export type MergePluginMeta<TPlugins extends readonly unknown[]> = TPlugins extends readonly [infer Head, ...infer Rest] ? PluginMetaOf<Head> & MergePluginMeta<Rest extends readonly unknown[] ? Rest : []> : {};
+/**
+ * Walk a tuple of plugins and intersect their frontmatter contributions.
+ */
+export type MergePluginFrontmatter<TPlugins extends readonly unknown[]> = TPlugins extends readonly [
+    infer Head,
+    ...infer Rest
+] ? PluginFrontmatterOf<Head> & MergePluginFrontmatter<Rest extends readonly unknown[] ? Rest : []> : {};
+/**
+ * When no plugin contributed meta keys, fall back to the permissive
+ * `Record<string, any>` (backwards-compatible). Otherwise, preserve narrow
+ * keys and type unknown accesses as `unknown` (safer than `any`).
+ */
+export type ResolvedMeta<T> = [keyof T] extends [never] ? Record<string, any> : T & Record<string, unknown>;
+export type ResolvedFrontmatter<T> = [keyof T] extends [never] ? Record<string, any> : T & Record<string, unknown>;
+export type ComponentManifest = (name: string) => unknown | Promise<unknown> | undefined | null;
 export interface ComarkContextProvider {
     components: Record<string, any>;
     componentManifest: ComponentManifest;
 }
-export interface ParseOptions {
+export interface ParseOptions<TPlugins extends readonly ComarkPlugin<any, any>[] = readonly ComarkPlugin<any, any>[]> {
     /**
      * Whether to automatically unwrap single paragraphs in container components.
      * When enabled, if a container component (alert, card, callout, note, warning, tip, info)
@@ -299,7 +343,7 @@ export interface ParseOptions {
      * Additional plugins to use
      * @default []
      */
-    plugins?: ComarkPlugin[];
+    plugins?: TPlugins;
 }
 /**
  * Type signature for the options object passed to the Comark parser function returned by createParse().
@@ -311,4 +355,5 @@ export type ComarkParseFnOptions = {
  * Type signature for the async Comark parser function returned by createParse().
  * Accepts a markdown string and optional parsing options, and returns a Promise of ComarkTree.
  */
-export type ComarkParseFn = (markdown: string, opts?: ComarkParseFnOptions) => Promise<ComarkTree>;
+export type ComarkParseFn<TMeta = Record<string, any>, TFrontmatter = Record<string, any>> = (markdown: string, opts?: ComarkParseFnOptions) => Promise<ComarkTree<TMeta, TFrontmatter>>;
+export {};

package/dist/utils/comark.tmLanguage.d.ts ADDED Viewed

@@ -0,0 +1,335 @@
+declare const _default: ({
+    $schema: string;
+    name: string;
+    aliases: string[];
+    displayName: string;
+    injectionSelector: string;
+    scopeName: string;
+    patterns: {
+        include: string;
+    }[];
+    repository: {
+        block: {
+            patterns: {
+                include: string;
+            }[];
+        };
+        inline: {
+            patterns: {
+                include: string;
+            }[];
+        };
+        binding: {
+            match: string;
+            name: string;
+            captures: {
+                '1': {
+                    name: string;
+                };
+                '2': {
+                    name: string;
+                };
+                '3': {
+                    name: string;
+                };
+                '4': {
+                    name: string;
+                };
+                '5': {
+                    name: string;
+                };
+            };
+        };
+        span: {
+            match: string;
+            name: string;
+            captures: {
+                '1': {
+                    name: string;
+                };
+                '2': {
+                    name: string;
+                };
+                '3': {
+                    name: string;
+                };
+                '4': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+            };
+        };
+        attributes: {
+            match: string;
+            name: string;
+            captures: {
+                '1': {
+                    name: string;
+                };
+                '3': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+                '4': {
+                    name: string;
+                };
+            };
+        };
+        component_inline: {
+            match: string;
+            name: string;
+            captures: {
+                '2': {
+                    name: string;
+                };
+                '3': {
+                    name: string;
+                };
+                '5': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+                '6': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+                '7': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+                '8': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+            };
+        };
+        component_block: {
+            begin: string;
+            name: string;
+            end: string;
+            beginCaptures: {
+                '3': {
+                    name: string;
+                };
+                '4': {
+                    name: string;
+                };
+                '5': {
+                    patterns: {
+                        include: string;
+                    }[];
+                };
+            };
+            endCaptures: {
+                '3': {
+                    name: string;
+                };
+            };
+            patterns: ({
+                match: string;
+                captures: {
+                    '2': {
+                        name: string;
+                    };
+                    '3'?: undefined;
+                };
+                begin?: undefined;
+                end?: undefined;
+                patterns?: undefined;
+                include?: undefined;
+            } | {
+                begin: string;
+                end: string;
+                patterns: {
+                    include: string;
+                }[];
+                match?: undefined;
+                captures?: undefined;
+                include?: undefined;
+            } | {
+                match: string;
+                captures: {
+                    '2': {
+                        name: string;
+                    };
+                    '3': {
+                        name: string;
+                    };
+                };
+                begin?: undefined;
+                end?: undefined;
+                patterns?: undefined;
+                include?: undefined;
+            } | {
+                include: string;
+                match?: undefined;
+                captures?: undefined;
+                begin?: undefined;
+                end?: undefined;
+                patterns?: undefined;
+            })[];
+        };
+        attribute: {
+            patterns: {
+                match: string;
+                captures: {
+                    '2': {
+                        name: string;
+                    };
+                    '3': {
+                        patterns: {
+                            include: string;
+                        }[];
+                    };
+                };
+            }[];
+        };
+        'attribute-interior': {
+            patterns: {
+                begin: string;
+                beginCaptures: {
+                    '0': {
+                        name: string;
+                    };
+                };
+                end: string;
+                patterns: ({
+                    match: string;
+                    name: string;
+                    begin?: undefined;
+                    beginCaptures?: undefined;
+                    end?: undefined;
+                    endCaptures?: undefined;
+                    patterns?: undefined;
+                } | {
+                    begin: string;
+                    beginCaptures: {
+                        '0': {
+                            name: string;
+                        };
+                    };
+                    end: string;
+                    endCaptures: {
+                        '0': {
+                            name: string;
+                        };
+                    };
+                    name: string;
+                    patterns: {
+                        include: string;
+                    }[];
+                    match?: undefined;
+                })[];
+            }[];
+        };
+        entities: {
+            patterns: ({
+                captures: {
+                    '1': {
+                        name: string;
+                    };
+                    '912': {
+                        name: string;
+                    };
+                    '3'?: undefined;
+                };
+                match: string;
+                name: string;
+            } | {
+                captures: {
+                    '1': {
+                        name: string;
+                    };
+                    '3': {
+                        name: string;
+                    };
+                    '912'?: undefined;
+                };
+                match: string;
+                name: string;
+            } | {
+                match: string;
+                name: string;
+                captures?: undefined;
+            })[];
+        };
+        heading: {
+            match: string;
+            captures: {
+                '1': {
+                    patterns: {
+                        match: string;
+                        name: string;
+                        captures: {
+                            '1': {
+                                name: string;
+                            };
+                            '2': {
+                                name: string;
+                                patterns: {
+                                    include: string;
+                                }[];
+                            };
+                            '3': {
+                                name: string;
+                            };
+                        };
+                    }[];
+                };
+            };
+            name: string;
+            patterns: {
+                include: string;
+            }[];
+        };
+        'heading-setext': {
+            patterns: {
+                match: string;
+                name: string;
+            }[];
+        };
+        lists: {
+            patterns: {
+                begin: string;
+                beginCaptures: {
+                    '3': {
+                        name: string;
+                    };
+                };
+                name: string;
+                patterns: {
+                    include: string;
+                }[];
+                while: string;
+            }[];
+        };
+        paragraph: {
+            begin: string;
+            name: string;
+            patterns: {
+                include: string;
+            }[];
+            while: string;
+        };
+        blockquote: {
+            begin: string;
+            captures: {
+                '2': {
+                    name: string;
+                };
+            };
+            name: string;
+            patterns: {
+                include: string;
+            }[];
+            while: string;
+        };
+    };
+} | import("shiki").LanguageRegistration)[];
+export default _default;