@kubb/parser-md 5.0.0-beta.51 → 5.0.0-beta.53
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.
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -3
- package/src/utils.ts +1 -1
- package/extension.yaml +0 -92
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["ast"],"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 *\n * ```\n * ---\n * <yaml>\n * ---\n * ```\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 banner/footer fields.\n */\
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["ast"],"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 *\n * ```\n * ---\n * <yaml>\n * ---\n * ```\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 banner/footer fields.\n */\nfunction printFrontmatter(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 printFrontmatter}; 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 : printFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { ast } from '@kubb/core'\nimport { defineParser } from '@kubb/core'\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={…}>` to\n * have the parser prepend the corresponding YAML 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 * Add to the `parsers` array on `defineConfig` to opt in. `parserTs` keeps\n * handling `.ts`/`.js` files, `parserMd` claims `.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 *\n * export default defineConfig({\n * input: { path: './petStore.yaml' },\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [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 = ast.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 return parts.join('\\n\\n')\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;AAoBA,SAAS,iBAAiB,MAA0D;CAClF,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,iBAAiB,IAAI;EACpE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;ACTA,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,OAAOA,WAAAA,IAAI,wBAAwB,OAAO,KAA4B;GAC5E,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;EAGxD,OADc;GAAC,KAAK;GAAQ;GAAa;GAAM,KAAK;EAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAC3I,CAAC,CAAC,KAAK,MAAM;CAC1B;AACF,CAAC"}
|
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 *\n * ```\n * ---\n * <yaml>\n * ---\n * ```\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 banner/footer fields.\n */\
|
|
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 *\n * ```\n * ---\n * <yaml>\n * ---\n * ```\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 banner/footer fields.\n */\nfunction printFrontmatter(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 printFrontmatter}; 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 : printFrontmatter(part)\n if (text) rendered.push(text.trimEnd())\n }\n return rendered.join('\\n\\n')\n}\n","import { ast } from '@kubb/core'\nimport { defineParser } from '@kubb/core'\nimport { print, type PrintInput } from './utils.ts'\n\n/**\n * Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={…}>` to\n * have the parser prepend the corresponding YAML 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 * Add to the `parsers` array on `defineConfig` to opt in. `parserTs` keeps\n * handling `.ts`/`.js` files, `parserMd` claims `.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 *\n * export default defineConfig({\n * input: { path: './petStore.yaml' },\n * output: { path: './src/gen' },\n * adapter: adapterOas(),\n * parsers: [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 = ast.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 return parts.join('\\n\\n')\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;AAoBA,SAAS,iBAAiB,MAA0D;CAClF,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,iBAAiB,IAAI;EACpE,IAAI,MAAM,SAAS,KAAK,KAAK,QAAQ,CAAC;CACxC;CACA,OAAO,SAAS,KAAK,MAAM;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;ACTA,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,IAAI,wBAAwB,OAAO,KAA4B;GAC5E,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;EAGxD,OADc;GAAC,KAAK;GAAQ;GAAa;GAAM,KAAK;EAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAC3I,CAAC,CAAC,KAAK,MAAM;CAC1B;AACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/parser-md",
|
|
3
|
-
"version": "5.0.0-beta.
|
|
3
|
+
"version": "5.0.0-beta.53",
|
|
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",
|
|
@@ -20,7 +20,6 @@
|
|
|
20
20
|
"files": [
|
|
21
21
|
"src",
|
|
22
22
|
"dist",
|
|
23
|
-
"extension.yaml",
|
|
24
23
|
"!/**/**.test.**",
|
|
25
24
|
"!/**/__tests__/**",
|
|
26
25
|
"!/**/__snapshots__/**"
|
|
@@ -43,7 +42,7 @@
|
|
|
43
42
|
},
|
|
44
43
|
"dependencies": {
|
|
45
44
|
"yaml": "^2.9.0",
|
|
46
|
-
"@kubb/core": "5.0.0-beta.
|
|
45
|
+
"@kubb/core": "5.0.0-beta.53"
|
|
47
46
|
},
|
|
48
47
|
"devDependencies": {
|
|
49
48
|
"@internals/utils": "0.0.0"
|
package/src/utils.ts
CHANGED
|
@@ -18,7 +18,7 @@ export type PrintInput = string | Record<string, unknown>
|
|
|
18
18
|
* Returns an empty string for `null`, `undefined`, or empty objects so callers
|
|
19
19
|
* can drop the result through the same filter chain as banner/footer fields.
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
function printFrontmatter(data: Record<string, unknown> | null | undefined): string {
|
|
22
22
|
if (!data || Object.keys(data).length === 0) return ''
|
|
23
23
|
return `---\n${stringify(data).trimEnd()}\n---`
|
|
24
24
|
}
|
package/extension.yaml
DELETED
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
$schema: https://kubb.dev/schemas/extension.json
|
|
2
|
-
kind: parser
|
|
3
|
-
id: parser-md
|
|
4
|
-
name: Markdown
|
|
5
|
-
description: Markdown file parser for Kubb. Joins source blocks as plain markdown and renders YAML frontmatter via `parserMd.print`.
|
|
6
|
-
category: docs
|
|
7
|
-
type: official
|
|
8
|
-
npmPackage: '@kubb/parser-md'
|
|
9
|
-
docsPath: /parsers/parser-md
|
|
10
|
-
repo: https://github.com/kubb-labs/kubb
|
|
11
|
-
maintainers:
|
|
12
|
-
- name: Stijn Van Hulle
|
|
13
|
-
github: stijnvanhulle
|
|
14
|
-
compatibility:
|
|
15
|
-
kubb: '>=5.0.0'
|
|
16
|
-
node: '>=22'
|
|
17
|
-
tags:
|
|
18
|
-
- markdown
|
|
19
|
-
- frontmatter
|
|
20
|
-
- parser
|
|
21
|
-
- docs
|
|
22
|
-
- yaml
|
|
23
|
-
resources:
|
|
24
|
-
documentation: https://kubb.dev/parsers/parser-md
|
|
25
|
-
repository: https://github.com/kubb-labs/kubb
|
|
26
|
-
issues: https://github.com/kubb-labs/kubb/issues
|
|
27
|
-
changelog: https://github.com/kubb-labs/kubb/blob/main/packages/parser-md/CHANGELOG.md
|
|
28
|
-
featured: false
|
|
29
|
-
intro: |-
|
|
30
|
-
`@kubb/parser-md` lets Kubb emit `.md` and `.markdown` files. Register it alongside `parserTs` and any plugin that writes a markdown source will have its output serialized automatically.
|
|
31
|
-
|
|
32
|
-
The parser joins source blocks with blank lines. When `file.meta.frontmatter` is set, it prepends the YAML envelope — no separate `yaml` dependency needed. Pair it with `parserTs` when a generator emits both TypeScript and documentation files side by side.
|
|
33
|
-
options:
|
|
34
|
-
- name: frontmatter
|
|
35
|
-
type: 'Record<string, unknown> | null'
|
|
36
|
-
required: false
|
|
37
|
-
default: 'undefined'
|
|
38
|
-
description: |-
|
|
39
|
-
Set `frontmatter` on `file.meta` inside a plugin to have the parser prepend a YAML frontmatter block. Any serializable key-value object works.
|
|
40
|
-
codeBlock:
|
|
41
|
-
lang: typescript
|
|
42
|
-
title: plugin example
|
|
43
|
-
twoslash: false
|
|
44
|
-
code: |-
|
|
45
|
-
createFile({
|
|
46
|
-
baseName: 'README.md',
|
|
47
|
-
path: `${config.output.path}/README.md`,
|
|
48
|
-
meta: {
|
|
49
|
-
frontmatter: { title: 'API Reference', layout: 'doc' },
|
|
50
|
-
},
|
|
51
|
-
sources: [...],
|
|
52
|
-
})
|
|
53
|
-
examples:
|
|
54
|
-
- name: Standalone markdown
|
|
55
|
-
files:
|
|
56
|
-
- name: kubb.config.ts
|
|
57
|
-
lang: typescript
|
|
58
|
-
twoslash: false
|
|
59
|
-
code: |-
|
|
60
|
-
import { defineConfig } from 'kubb'
|
|
61
|
-
import { adapterOas } from '@kubb/adapter-oas'
|
|
62
|
-
import { parserMd } from '@kubb/parser-md'
|
|
63
|
-
|
|
64
|
-
export default defineConfig({
|
|
65
|
-
input: { path: './petStore.yaml' },
|
|
66
|
-
output: { path: './src/gen' },
|
|
67
|
-
adapter: adapterOas(),
|
|
68
|
-
parsers: [parserMd],
|
|
69
|
-
plugins: [],
|
|
70
|
-
})
|
|
71
|
-
- name: Markdown alongside TypeScript
|
|
72
|
-
files:
|
|
73
|
-
- name: kubb.config.ts
|
|
74
|
-
lang: typescript
|
|
75
|
-
twoslash: false
|
|
76
|
-
code: |-
|
|
77
|
-
import { defineConfig } from 'kubb'
|
|
78
|
-
import { adapterOas } from '@kubb/adapter-oas'
|
|
79
|
-
import { parserMd } from '@kubb/parser-md'
|
|
80
|
-
import { parserTs } from '@kubb/parser-ts'
|
|
81
|
-
|
|
82
|
-
export default defineConfig({
|
|
83
|
-
input: { path: './petStore.yaml' },
|
|
84
|
-
output: { path: './src/gen' },
|
|
85
|
-
adapter: adapterOas(),
|
|
86
|
-
parsers: [parserTs, parserMd],
|
|
87
|
-
plugins: [],
|
|
88
|
-
})
|
|
89
|
-
notes:
|
|
90
|
-
- type: tip
|
|
91
|
-
body: |-
|
|
92
|
-
`parserMd.print({ title: 'Pets', layout: 'doc' })` returns `---\ntitle: Pets\nlayout: doc\n---`. Render it from a plugin to inject frontmatter into a generated page without depending on `yaml` directly.
|