@kubb/parser-md 5.0.0-beta.89 → 5.0.0-beta.93

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 (7) hide show
  1. package/README.md +7 -8
  2. package/dist/index.cjs +25 -23
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.ts +3 -9
  5. package/dist/index.js +25 -23
  6. package/dist/index.js.map +1 -1
  7. package/package.json +3 -3
package/README.md CHANGED
@@ -44,18 +44,18 @@ import { parserMd } from '@kubb/parser-md'
44
44
  import { parserTs } from '@kubb/parser-ts'
45
45
 
46
46
  export default defineConfig({
47
- input: { path: './petstore.yaml' },
47
+ input: './petstore.yaml',
48
48
  output: { path: './src/gen' },
49
- parsers: [parserTs, parserMd],
49
+ parsers: [parserTs(), parserMd()],
50
50
  })
51
51
  ```
52
52
 
53
- To convert a metadata object into a YAML frontmatter envelope from inside a plugin, call `print` on the parser instance:
53
+ To convert a metadata object into a YAML frontmatter envelope from inside a plugin, call `print` on a parser instance:
54
54
 
55
55
  ```typescript
56
56
  import { parserMd } from '@kubb/parser-md'
57
57
 
58
- const source = parserMd.print({ title: 'Pets', layout: 'doc' })
58
+ const source = parserMd().print({ title: 'Pets', layout: 'doc' })
59
59
  // → ---
60
60
  // title: Pets
61
61
  // layout: doc
@@ -64,12 +64,11 @@ const source = parserMd.print({ title: 'Pets', layout: 'doc' })
64
64
 
65
65
  ## API
66
66
 
67
- ### `parserMd`
67
+ ### `parserMd()`
68
68
 
69
- Parser instance for `.md` and `.markdown` files. Pass to `defineConfig({ parsers: [...] })` to emit Markdown source files.
69
+ Factory returning a parser instance for `.md` and `.markdown` files. Pass to `defineConfig({ parsers: [...] })` to emit Markdown source files.
70
70
 
71
- - `parserMd.parse(file)` — serialize a `FileNode` to Markdown source. When `file.meta.frontmatter` is set, the parser prepends the corresponding YAML envelope.
72
- - `parserMd.print(...parts)` — join markdown fragments separated by blank lines. Plain objects are serialized as YAML frontmatter; strings pass through unchanged.
71
+ The returned instance exposes `parse(file)` to serialize a `FileNode` to Markdown source (prepending the YAML envelope when `file.meta.frontmatter` is set) and `print(...parts)` to join markdown fragments separated by blank lines, serializing plain objects as YAML frontmatter and passing strings through unchanged.
73
72
 
74
73
  ## Supporting Kubb
75
74
 
package/dist/index.cjs CHANGED
@@ -53,36 +53,38 @@ function print(...parts) {
53
53
  * import { parserTs, parserTsx } from '@kubb/parser-ts'
54
54
  *
55
55
  * export default defineConfig({
56
- * input: { path: './petStore.yaml' },
56
+ * input: './petStore.yaml',
57
57
  * output: { path: './src/gen' },
58
58
  * adapter: adapterOas(),
59
- * parsers: [parserTs, parserTsx, parserMd],
59
+ * parsers: [parserTs(), parserTsx(), parserMd()],
60
60
  * plugins: [],
61
61
  * })
62
62
  * ```
63
63
  */
64
- const parserMd = (0, _kubb_core.defineParser)({
65
- name: "markdown",
66
- extNames: [".md", ".markdown"],
67
- print(...parts) {
68
- return print(...parts);
69
- },
70
- parse(file) {
71
- const sourceParts = [];
72
- for (const source of file.sources) {
73
- const text = (0, _kubb_ast.extractStringsFromNodes)(source.nodes);
74
- if (text) sourceParts.push(text.trimEnd());
64
+ const parserMd = (0, _kubb_core.defineParser)(() => {
65
+ return {
66
+ name: "markdown",
67
+ extNames: [".md", ".markdown"],
68
+ print(...parts) {
69
+ return print(...parts);
70
+ },
71
+ parse(file) {
72
+ const sourceParts = [];
73
+ for (const source of file.sources) {
74
+ const text = (0, _kubb_ast.extractStringsFromNodes)(source.nodes);
75
+ if (text) sourceParts.push(text.trimEnd());
76
+ }
77
+ const body = sourceParts.join("\n\n");
78
+ const meta = file.meta;
79
+ const frontmatter = print(meta?.frontmatter ?? void 0);
80
+ return [
81
+ file.banner,
82
+ frontmatter,
83
+ body,
84
+ file.footer
85
+ ].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
75
86
  }
76
- const body = sourceParts.join("\n\n");
77
- const meta = file.meta;
78
- const frontmatter = print(meta?.frontmatter ?? void 0);
79
- return [
80
- file.banner,
81
- frontmatter,
82
- body,
83
- file.footer
84
- ].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
85
- }
87
+ };
86
88
  });
87
89
  //#endregion
88
90
  exports.parserMd = parserMd;
package/dist/index.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","names":[],"sources":["../src/utils.ts","../src/parserMd.ts"],"sourcesContent":["import { stringify } from 'yaml'\n\n/**\n * Markdown `print` input, either a markdown text fragment (passed through\n * verbatim) or a plain object that is serialized as a YAML frontmatter envelope.\n */\nexport type PrintInput = string | Record<string, unknown>\n\n/**\n * Wraps a plain object as a YAML frontmatter envelope (`---\\n<yaml>\\n---`).\n * Returns an empty string for `null`, `undefined`, or empty objects so callers\n * can drop the result through the same filter chain as other optional fields.\n */\nfunction stringifyFrontmatter(data: Record<string, unknown> | null | undefined): string {\n if (!data || Object.keys(data).length === 0) return ''\n return `---\\n${stringify(data).trimEnd()}\\n---`\n}\n\n/**\n * Joins a list of markdown fragments with blank lines. Plain objects are\n * rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass\n * through unchanged.\n *\n * @example\n * ```ts\n * print({ title: 'Hi' }, '# Hello')\n * // '---\\ntitle: Hi\\n---\\n\\n# Hello'\n * ```\n */\nexport function print(...parts: Array<PrintInput | null | undefined>): string {\n const rendered: Array<string> = []\n for (const part of parts) {\n if (part === null || part === undefined || part === '') continue\n const text = typeof part === 'string' ? part : stringifyFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { defineParser } from '@kubb/core'\nimport { extractStringsFromNodes, type ast } from '@kubb/ast'\n\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={...}>` and\n * the parser prepends those keys as a YAML frontmatter envelope.\n */\nexport type MdMeta = {\n frontmatter?: Record<string, unknown> | null\n}\n\n/**\n * Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain\n * markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,\n * prepends a YAML frontmatter envelope produced by `parserMd.print`.\n *\n * Runs by default next to `parserTs` and `parserTsx`. Add it to a custom\n * `parsers` array yourself, since a custom list replaces the default set.\n * `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims\n * `.md`/`.markdown`.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb'\n * import { adapterOas } from '@kubb/adapter-oas'\n * import { parserMd } from '@kubb/parser-md'\n * import { parserTs, parserTsx } from '@kubb/parser-ts'\n *\n * export default defineConfig({\n * input: { path: './petStore.yaml' },\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [parserTs, parserTsx, parserMd],\n * plugins: [],\n * })\n * ```\n */\nexport const parserMd = defineParser({\n name: 'markdown',\n extNames: ['.md', '.markdown'],\n print(...parts: Array<PrintInput>) {\n return print(...parts)\n },\n parse(file) {\n const sourceParts: Array<string> = []\n for (const source of file.sources) {\n const text = extractStringsFromNodes(source.nodes as Array<ast.CodeNode>)\n if (text) sourceParts.push(text.trimEnd())\n }\n const body = sourceParts.join('\\n\\n')\n\n const meta = file.meta as MdMeta | undefined\n const frontmatter = print(meta?.frontmatter ?? undefined)\n\n const parts = [file.banner, frontmatter, body, file.footer].filter((segment): segment is string => Boolean(segment)).map((segment) => segment.trimEnd())\n\n return parts.join('\\n\\n')\n },\n})\n"],"mappings":";;;;;;;;;;;AAaA,SAAS,qBAAqB,MAA0D;CACtF,IAAI,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAAG,OAAO;CACpD,OAAO,SAAA,GAAA,KAAA,UAAA,CAAkB,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC3C;;;;;;;;;;;;AAaA,SAAgB,MAAM,GAAG,OAAqD;CAC5E,MAAM,WAA0B,CAAC;CACjC,KAAK,MAAM,QAAQ,OAAO;EACxB,IAAI,SAAS,QAAQ,SAAS,KAAA,KAAa,SAAS,IAAI;EACxD,MAAM,OAAO,OAAO,SAAS,WAAW,OAAO,qBAAqB,IAAI;EACxE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA,MAAa,YAAA,GAAA,WAAA,aAAA,CAAwB;CACnC,MAAM;CACN,UAAU,CAAC,OAAO,WAAW;CAC7B,MAAM,GAAG,OAA0B;EACjC,OAAO,MAAM,GAAG,KAAK;CACvB;CACA,MAAM,MAAM;EACV,MAAM,cAA6B,CAAC;EACpC,KAAK,MAAM,UAAU,KAAK,SAAS;GACjC,MAAM,QAAA,GAAA,UAAA,wBAAA,CAA+B,OAAO,KAA4B;GACxE,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;EAC3C;EACA,MAAM,OAAO,YAAY,KAAK,MAAM;EAEpC,MAAM,OAAO,KAAK;EAClB,MAAM,cAAc,MAAM,MAAM,eAAe,KAAA,CAAS;EAIxD,OAFc;GAAC,KAAK;GAAQ;GAAa;GAAM,KAAK;EAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;CAC1B;AACF,CAAC"}
1
+ {"version":3,"file":"index.cjs","names":[],"sources":["../src/utils.ts","../src/parserMd.ts"],"sourcesContent":["import { stringify } from 'yaml'\n\n/**\n * Markdown `print` input, either a markdown text fragment (passed through\n * verbatim) or a plain object that is serialized as a YAML frontmatter envelope.\n */\nexport type PrintInput = string | Record<string, unknown>\n\n/**\n * Wraps a plain object as a YAML frontmatter envelope (`---\\n<yaml>\\n---`).\n * Returns an empty string for `null`, `undefined`, or empty objects so callers\n * can drop the result through the same filter chain as other optional fields.\n */\nfunction stringifyFrontmatter(data: Record<string, unknown> | null | undefined): string {\n if (!data || Object.keys(data).length === 0) return ''\n return `---\\n${stringify(data).trimEnd()}\\n---`\n}\n\n/**\n * Joins a list of markdown fragments with blank lines. Plain objects are\n * rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass\n * through unchanged.\n *\n * @example\n * ```ts\n * print({ title: 'Hi' }, '# Hello')\n * // '---\\ntitle: Hi\\n---\\n\\n# Hello'\n * ```\n */\nexport function print(...parts: Array<PrintInput | null | undefined>): string {\n const rendered: Array<string> = []\n for (const part of parts) {\n if (part === null || part === undefined || part === '') continue\n const text = typeof part === 'string' ? part : stringifyFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { defineParser } from '@kubb/core'\nimport { extractStringsFromNodes, type ast } from '@kubb/ast'\n\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={...}>` and\n * the parser prepends those keys as a YAML frontmatter envelope.\n */\nexport type MdMeta = {\n frontmatter?: Record<string, unknown> | null\n}\n\n/**\n * Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain\n * markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,\n * prepends a YAML frontmatter envelope produced by `parserMd.print`.\n *\n * Runs by default next to `parserTs` and `parserTsx`. Add it to a custom\n * `parsers` array yourself, since a custom list replaces the default set.\n * `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims\n * `.md`/`.markdown`.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb'\n * import { adapterOas } from '@kubb/adapter-oas'\n * import { parserMd } from '@kubb/parser-md'\n * import { parserTs, parserTsx } from '@kubb/parser-ts'\n *\n * export default defineConfig({\n * input: './petStore.yaml',\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [parserTs(), parserTsx(), parserMd()],\n * plugins: [],\n * })\n * ```\n */\nexport const parserMd = defineParser(() => {\n return {\n name: 'markdown',\n extNames: ['.md', '.markdown'],\n print(...parts: Array<PrintInput>) {\n return print(...parts)\n },\n parse(file) {\n const sourceParts: Array<string> = []\n for (const source of file.sources) {\n const text = extractStringsFromNodes(source.nodes as Array<ast.CodeNode>)\n if (text) sourceParts.push(text.trimEnd())\n }\n const body = sourceParts.join('\\n\\n')\n\n const meta = file.meta as MdMeta | undefined\n const frontmatter = print(meta?.frontmatter ?? undefined)\n\n const parts = [file.banner, frontmatter, body, file.footer].filter((segment): segment is string => Boolean(segment)).map((segment) => segment.trimEnd())\n\n return parts.join('\\n\\n')\n },\n }\n})\n"],"mappings":";;;;;;;;;;;AAaA,SAAS,qBAAqB,MAA0D;CACtF,IAAI,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAAG,OAAO;CACpD,OAAO,SAAA,GAAA,KAAA,UAAA,CAAkB,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC3C;;;;;;;;;;;;AAaA,SAAgB,MAAM,GAAG,OAAqD;CAC5E,MAAM,WAA0B,CAAC;CACjC,KAAK,MAAM,QAAQ,OAAO;EACxB,IAAI,SAAS,QAAQ,SAAS,KAAA,KAAa,SAAS,IAAI;EACxD,MAAM,OAAO,OAAO,SAAS,WAAW,OAAO,qBAAqB,IAAI;EACxE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA,MAAa,YAAA,GAAA,WAAA,aAAA,OAA8B;CACzC,OAAO;EACL,MAAM;EACN,UAAU,CAAC,OAAO,WAAW;EAC7B,MAAM,GAAG,OAA0B;GACjC,OAAO,MAAM,GAAG,KAAK;EACvB;EACA,MAAM,MAAM;GACV,MAAM,cAA6B,CAAC;GACpC,KAAK,MAAM,UAAU,KAAK,SAAS;IACjC,MAAM,QAAA,GAAA,UAAA,wBAAA,CAA+B,OAAO,KAA4B;IACxE,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;GAC3C;GACA,MAAM,OAAO,YAAY,KAAK,MAAM;GAEpC,MAAM,OAAO,KAAK;GAClB,MAAM,cAAc,MAAM,MAAM,eAAe,KAAA,CAAS;GAIxD,OAFc;IAAC,KAAK;IAAQ;IAAa;IAAM,KAAK;GAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;EAC1B;CACF;AACF,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
2
- import { ast } from "@kubb/ast";
3
2
 
4
3
  //#region src/utils.d.ts
5
4
  /**
@@ -34,20 +33,15 @@ type MdMeta = {
34
33
  * import { parserTs, parserTsx } from '@kubb/parser-ts'
35
34
  *
36
35
  * export default defineConfig({
37
- * input: { path: './petStore.yaml' },
36
+ * input: './petStore.yaml',
38
37
  * output: { path: './src/gen' },
39
38
  * adapter: adapterOas(),
40
- * parsers: [parserTs, parserTsx, parserMd],
39
+ * parsers: [parserTs(), parserTsx(), parserMd()],
41
40
  * plugins: [],
42
41
  * })
43
42
  * ```
44
43
  */
45
- declare const parserMd: {
46
- name: string;
47
- extNames: (".md" | ".markdown")[];
48
- print(...parts: Array<PrintInput>): string;
49
- parse(file: ast.FileNode<object>): string;
50
- };
44
+ declare const parserMd: (options?: object | undefined) => import("@kubb/core").Parser<object, PrintInput>;
51
45
  //#endregion
52
46
  export { type MdMeta, parserMd };
53
47
  //# sourceMappingURL=index.d.ts.map
package/dist/index.js CHANGED
@@ -52,36 +52,38 @@ function print(...parts) {
52
52
  * import { parserTs, parserTsx } from '@kubb/parser-ts'
53
53
  *
54
54
  * export default defineConfig({
55
- * input: { path: './petStore.yaml' },
55
+ * input: './petStore.yaml',
56
56
  * output: { path: './src/gen' },
57
57
  * adapter: adapterOas(),
58
- * parsers: [parserTs, parserTsx, parserMd],
58
+ * parsers: [parserTs(), parserTsx(), parserMd()],
59
59
  * plugins: [],
60
60
  * })
61
61
  * ```
62
62
  */
63
- const parserMd = defineParser({
64
- name: "markdown",
65
- extNames: [".md", ".markdown"],
66
- print(...parts) {
67
- return print(...parts);
68
- },
69
- parse(file) {
70
- const sourceParts = [];
71
- for (const source of file.sources) {
72
- const text = extractStringsFromNodes(source.nodes);
73
- if (text) sourceParts.push(text.trimEnd());
63
+ const parserMd = defineParser(() => {
64
+ return {
65
+ name: "markdown",
66
+ extNames: [".md", ".markdown"],
67
+ print(...parts) {
68
+ return print(...parts);
69
+ },
70
+ parse(file) {
71
+ const sourceParts = [];
72
+ for (const source of file.sources) {
73
+ const text = extractStringsFromNodes(source.nodes);
74
+ if (text) sourceParts.push(text.trimEnd());
75
+ }
76
+ const body = sourceParts.join("\n\n");
77
+ const meta = file.meta;
78
+ const frontmatter = print(meta?.frontmatter ?? void 0);
79
+ return [
80
+ file.banner,
81
+ frontmatter,
82
+ body,
83
+ file.footer
84
+ ].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
74
85
  }
75
- const body = sourceParts.join("\n\n");
76
- const meta = file.meta;
77
- const frontmatter = print(meta?.frontmatter ?? void 0);
78
- return [
79
- file.banner,
80
- frontmatter,
81
- body,
82
- file.footer
83
- ].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
84
- }
86
+ };
85
87
  });
86
88
  //#endregion
87
89
  export { parserMd };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/utils.ts","../src/parserMd.ts"],"sourcesContent":["import { stringify } from 'yaml'\n\n/**\n * Markdown `print` input, either a markdown text fragment (passed through\n * verbatim) or a plain object that is serialized as a YAML frontmatter envelope.\n */\nexport type PrintInput = string | Record<string, unknown>\n\n/**\n * Wraps a plain object as a YAML frontmatter envelope (`---\\n<yaml>\\n---`).\n * Returns an empty string for `null`, `undefined`, or empty objects so callers\n * can drop the result through the same filter chain as other optional fields.\n */\nfunction stringifyFrontmatter(data: Record<string, unknown> | null | undefined): string {\n if (!data || Object.keys(data).length === 0) return ''\n return `---\\n${stringify(data).trimEnd()}\\n---`\n}\n\n/**\n * Joins a list of markdown fragments with blank lines. Plain objects are\n * rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass\n * through unchanged.\n *\n * @example\n * ```ts\n * print({ title: 'Hi' }, '# Hello')\n * // '---\\ntitle: Hi\\n---\\n\\n# Hello'\n * ```\n */\nexport function print(...parts: Array<PrintInput | null | undefined>): string {\n const rendered: Array<string> = []\n for (const part of parts) {\n if (part === null || part === undefined || part === '') continue\n const text = typeof part === 'string' ? part : stringifyFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { defineParser } from '@kubb/core'\nimport { extractStringsFromNodes, type ast } from '@kubb/ast'\n\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={...}>` and\n * the parser prepends those keys as a YAML frontmatter envelope.\n */\nexport type MdMeta = {\n frontmatter?: Record<string, unknown> | null\n}\n\n/**\n * Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain\n * markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,\n * prepends a YAML frontmatter envelope produced by `parserMd.print`.\n *\n * Runs by default next to `parserTs` and `parserTsx`. Add it to a custom\n * `parsers` array yourself, since a custom list replaces the default set.\n * `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims\n * `.md`/`.markdown`.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb'\n * import { adapterOas } from '@kubb/adapter-oas'\n * import { parserMd } from '@kubb/parser-md'\n * import { parserTs, parserTsx } from '@kubb/parser-ts'\n *\n * export default defineConfig({\n * input: { path: './petStore.yaml' },\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [parserTs, parserTsx, parserMd],\n * plugins: [],\n * })\n * ```\n */\nexport const parserMd = defineParser({\n name: 'markdown',\n extNames: ['.md', '.markdown'],\n print(...parts: Array<PrintInput>) {\n return print(...parts)\n },\n parse(file) {\n const sourceParts: Array<string> = []\n for (const source of file.sources) {\n const text = extractStringsFromNodes(source.nodes as Array<ast.CodeNode>)\n if (text) sourceParts.push(text.trimEnd())\n }\n const body = sourceParts.join('\\n\\n')\n\n const meta = file.meta as MdMeta | undefined\n const frontmatter = print(meta?.frontmatter ?? undefined)\n\n const parts = [file.banner, frontmatter, body, file.footer].filter((segment): segment is string => Boolean(segment)).map((segment) => segment.trimEnd())\n\n return parts.join('\\n\\n')\n },\n})\n"],"mappings":";;;;;;;;;;AAaA,SAAS,qBAAqB,MAA0D;CACtF,IAAI,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAAG,OAAO;CACpD,OAAO,QAAQ,UAAU,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC3C;;;;;;;;;;;;AAaA,SAAgB,MAAM,GAAG,OAAqD;CAC5E,MAAM,WAA0B,CAAC;CACjC,KAAK,MAAM,QAAQ,OAAO;EACxB,IAAI,SAAS,QAAQ,SAAS,KAAA,KAAa,SAAS,IAAI;EACxD,MAAM,OAAO,OAAO,SAAS,WAAW,OAAO,qBAAqB,IAAI;EACxE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA,MAAa,WAAW,aAAa;CACnC,MAAM;CACN,UAAU,CAAC,OAAO,WAAW;CAC7B,MAAM,GAAG,OAA0B;EACjC,OAAO,MAAM,GAAG,KAAK;CACvB;CACA,MAAM,MAAM;EACV,MAAM,cAA6B,CAAC;EACpC,KAAK,MAAM,UAAU,KAAK,SAAS;GACjC,MAAM,OAAO,wBAAwB,OAAO,KAA4B;GACxE,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;EAC3C;EACA,MAAM,OAAO,YAAY,KAAK,MAAM;EAEpC,MAAM,OAAO,KAAK;EAClB,MAAM,cAAc,MAAM,MAAM,eAAe,KAAA,CAAS;EAIxD,OAFc;GAAC,KAAK;GAAQ;GAAa;GAAM,KAAK;EAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;CAC1B;AACF,CAAC"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../src/utils.ts","../src/parserMd.ts"],"sourcesContent":["import { stringify } from 'yaml'\n\n/**\n * Markdown `print` input, either a markdown text fragment (passed through\n * verbatim) or a plain object that is serialized as a YAML frontmatter envelope.\n */\nexport type PrintInput = string | Record<string, unknown>\n\n/**\n * Wraps a plain object as a YAML frontmatter envelope (`---\\n<yaml>\\n---`).\n * Returns an empty string for `null`, `undefined`, or empty objects so callers\n * can drop the result through the same filter chain as other optional fields.\n */\nfunction stringifyFrontmatter(data: Record<string, unknown> | null | undefined): string {\n if (!data || Object.keys(data).length === 0) return ''\n return `---\\n${stringify(data).trimEnd()}\\n---`\n}\n\n/**\n * Joins a list of markdown fragments with blank lines. Plain objects are\n * rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass\n * through unchanged.\n *\n * @example\n * ```ts\n * print({ title: 'Hi' }, '# Hello')\n * // '---\\ntitle: Hi\\n---\\n\\n# Hello'\n * ```\n */\nexport function print(...parts: Array<PrintInput | null | undefined>): string {\n const rendered: Array<string> = []\n for (const part of parts) {\n if (part === null || part === undefined || part === '') continue\n const text = typeof part === 'string' ? part : stringifyFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { defineParser } from '@kubb/core'\nimport { extractStringsFromNodes, type ast } from '@kubb/ast'\n\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={...}>` and\n * the parser prepends those keys as a YAML frontmatter envelope.\n */\nexport type MdMeta = {\n frontmatter?: Record<string, unknown> | null\n}\n\n/**\n * Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain\n * markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,\n * prepends a YAML frontmatter envelope produced by `parserMd.print`.\n *\n * Runs by default next to `parserTs` and `parserTsx`. Add it to a custom\n * `parsers` array yourself, since a custom list replaces the default set.\n * `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims\n * `.md`/`.markdown`.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb'\n * import { adapterOas } from '@kubb/adapter-oas'\n * import { parserMd } from '@kubb/parser-md'\n * import { parserTs, parserTsx } from '@kubb/parser-ts'\n *\n * export default defineConfig({\n * input: './petStore.yaml',\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [parserTs(), parserTsx(), parserMd()],\n * plugins: [],\n * })\n * ```\n */\nexport const parserMd = defineParser(() => {\n return {\n name: 'markdown',\n extNames: ['.md', '.markdown'],\n print(...parts: Array<PrintInput>) {\n return print(...parts)\n },\n parse(file) {\n const sourceParts: Array<string> = []\n for (const source of file.sources) {\n const text = extractStringsFromNodes(source.nodes as Array<ast.CodeNode>)\n if (text) sourceParts.push(text.trimEnd())\n }\n const body = sourceParts.join('\\n\\n')\n\n const meta = file.meta as MdMeta | undefined\n const frontmatter = print(meta?.frontmatter ?? undefined)\n\n const parts = [file.banner, frontmatter, body, file.footer].filter((segment): segment is string => Boolean(segment)).map((segment) => segment.trimEnd())\n\n return parts.join('\\n\\n')\n },\n }\n})\n"],"mappings":";;;;;;;;;;AAaA,SAAS,qBAAqB,MAA0D;CACtF,IAAI,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAAG,OAAO;CACpD,OAAO,QAAQ,UAAU,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC3C;;;;;;;;;;;;AAaA,SAAgB,MAAM,GAAG,OAAqD;CAC5E,MAAM,WAA0B,CAAC;CACjC,KAAK,MAAM,QAAQ,OAAO;EACxB,IAAI,SAAS,QAAQ,SAAS,KAAA,KAAa,SAAS,IAAI;EACxD,MAAM,OAAO,OAAO,SAAS,WAAW,OAAO,qBAAqB,IAAI;EACxE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA,MAAa,WAAW,mBAAmB;CACzC,OAAO;EACL,MAAM;EACN,UAAU,CAAC,OAAO,WAAW;EAC7B,MAAM,GAAG,OAA0B;GACjC,OAAO,MAAM,GAAG,KAAK;EACvB;EACA,MAAM,MAAM;GACV,MAAM,cAA6B,CAAC;GACpC,KAAK,MAAM,UAAU,KAAK,SAAS;IACjC,MAAM,OAAO,wBAAwB,OAAO,KAA4B;IACxE,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;GAC3C;GACA,MAAM,OAAO,YAAY,KAAK,MAAM;GAEpC,MAAM,OAAO,KAAK;GAClB,MAAM,cAAc,MAAM,MAAM,eAAe,KAAA,CAAS;GAIxD,OAFc;IAAC,KAAK;IAAQ;IAAa;IAAM,KAAK;GAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;EAC1B;CACF;AACF,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/parser-md",
3
- "version": "5.0.0-beta.89",
3
+ "version": "5.0.0-beta.93",
4
4
  "description": "Markdown source file parser for Kubb. Converts the universal AST to `.md` source and renders YAML frontmatter via the `print` helper.",
5
5
  "keywords": [
6
6
  "codegen",
@@ -42,8 +42,8 @@
42
42
  },
43
43
  "dependencies": {
44
44
  "yaml": "^2.9.0",
45
- "@kubb/ast": "5.0.0-beta.89",
46
- "@kubb/core": "5.0.0-beta.89"
45
+ "@kubb/core": "5.0.0-beta.93",
46
+ "@kubb/ast": "5.0.0-beta.93"
47
47
  },
48
48
  "engines": {
49
49
  "node": ">=22"