@kubb/parser-md 5.8.1 → 5.8.3
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/README.md +1 -1
- package/dist/index.cjs +3 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +4 -3
- package/dist/index.js.map +1 -1
- package/docs/options.md +44 -0
- package/{OVERVIEW.md → docs/overview.md} +5 -3
- package/kubb-extension.json +2 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
[![Node][node-src]][node-href]
|
|
11
11
|
|
|
12
12
|
<h4>
|
|
13
|
-
<a href="https://kubb.dev" target="_blank">Documentation</a>
|
|
13
|
+
<a href="https://kubb.dev/extensions/kubb-labs/parser-md" target="_blank">Documentation</a>
|
|
14
14
|
<span> · </span>
|
|
15
15
|
<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
|
|
16
16
|
<span> · </span>
|
package/dist/index.cjs
CHANGED
|
@@ -9,7 +9,7 @@ var compatibility = {
|
|
|
9
9
|
};
|
|
10
10
|
//#endregion
|
|
11
11
|
//#region package.json
|
|
12
|
-
var version = "5.8.
|
|
12
|
+
var version = "5.8.3";
|
|
13
13
|
//#endregion
|
|
14
14
|
//#region src/utils.ts
|
|
15
15
|
/**
|
|
@@ -69,7 +69,8 @@ function print(...parts) {
|
|
|
69
69
|
* })
|
|
70
70
|
* ```
|
|
71
71
|
*/
|
|
72
|
-
const parserMd = (0, _kubb_kit.
|
|
72
|
+
const parserMd = (0, _kubb_kit.defineExtension)({
|
|
73
|
+
kind: "parser",
|
|
73
74
|
meta: {
|
|
74
75
|
name: "markdown",
|
|
75
76
|
version,
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["stringify","
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["stringify","defineExtension","ast"],"sources":["../kubb-extension.json","../package.json","../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 { ast, defineExtension } from '@kubb/kit'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\n\nimport { print } 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 = defineExtension({\n kind: 'parser',\n meta: { name: 'markdown', version, compatibility },\n build() {\n return {\n extNames: ['.md', '.markdown'],\n print,\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)\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})\n"],"mappings":";;;;;;;;;;;;;;;;;;;AEaA,SAAS,qBAAqB,MAA0D;CACtF,IAAI,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAAG,OAAO;CACpD,OAAO,SAAA,GAAQA,KAAAA,UAAAA,CAAU,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACGA,MAAa,YAAA,GAAWC,UAAAA,gBAAAA,CAAgB;CACtC,MAAM;CACN,MAAM;EAAE,MAAM;EAAY;EAAS;CAAc;CACjD,QAAQ;EACN,OAAO;GACL,UAAU,CAAC,OAAO,WAAW;GAC7B;GACA,MAAM,MAAM;IACV,MAAM,cAA6B,CAAC;IACpC,KAAK,MAAM,UAAU,KAAK,SAAS;KACjC,MAAM,OAAOC,UAAAA,IAAI,wBAAwB,OAAO,KAA4B;KAC5E,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;IAC3C;IACA,MAAM,OAAO,YAAY,KAAK,MAAM;IAEpC,MAAM,OAAO,KAAK;IAClB,MAAM,cAAc,MAAM,MAAM,WAAW;IAI3C,OAFc;KAAC,KAAK;KAAQ;KAAa;KAAM,KAAK;IAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;GAC1B;EACF;CACF;AACF,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import "./rolldown-runtime-C0LytTxp.js";
|
|
2
|
-
import { ast,
|
|
2
|
+
import { ast, defineExtension } from "@kubb/kit";
|
|
3
3
|
import { stringify } from "yaml";
|
|
4
4
|
//#region kubb-extension.json
|
|
5
5
|
var compatibility = {
|
|
@@ -8,7 +8,7 @@ var compatibility = {
|
|
|
8
8
|
};
|
|
9
9
|
//#endregion
|
|
10
10
|
//#region package.json
|
|
11
|
-
var version = "5.8.
|
|
11
|
+
var version = "5.8.3";
|
|
12
12
|
//#endregion
|
|
13
13
|
//#region src/utils.ts
|
|
14
14
|
/**
|
|
@@ -68,7 +68,8 @@ function print(...parts) {
|
|
|
68
68
|
* })
|
|
69
69
|
* ```
|
|
70
70
|
*/
|
|
71
|
-
const parserMd =
|
|
71
|
+
const parserMd = defineExtension({
|
|
72
|
+
kind: "parser",
|
|
72
73
|
meta: {
|
|
73
74
|
name: "markdown",
|
|
74
75
|
version,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../kubb-extension.json","../package.json","../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 { ast,
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../kubb-extension.json","../package.json","../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 { ast, defineExtension } from '@kubb/kit'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\n\nimport { print } 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 = defineExtension({\n kind: 'parser',\n meta: { name: 'markdown', version, compatibility },\n build() {\n return {\n extNames: ['.md', '.markdown'],\n print,\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)\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})\n"],"mappings":";;;;;;;;;;;;;;;;;;AEaA,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACGA,MAAa,WAAW,gBAAgB;CACtC,MAAM;CACN,MAAM;EAAE,MAAM;EAAY;EAAS;CAAc;CACjD,QAAQ;EACN,OAAO;GACL,UAAU,CAAC,OAAO,WAAW;GAC7B;GACA,MAAM,MAAM;IACV,MAAM,cAA6B,CAAC;IACpC,KAAK,MAAM,UAAU,KAAK,SAAS;KACjC,MAAM,OAAO,IAAI,wBAAwB,OAAO,KAA4B;KAC5E,IAAI,MAAM,YAAY,KAAK,KAAK,QAAQ,CAAC;IAC3C;IACA,MAAM,OAAO,YAAY,KAAK,MAAM;IAEpC,MAAM,OAAO,KAAK;IAClB,MAAM,cAAc,MAAM,MAAM,WAAW;IAI3C,OAFc;KAAC,KAAK;KAAQ;KAAa;KAAM,KAAK;IAAM,CAAC,CAAC,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,QAAQ,QAAQ,CAE3I,CAAC,CAAC,KAAK,MAAM;GAC1B;EACF;CACF;AACF,CAAC"}
|
package/docs/options.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Options
|
|
2
|
+
|
|
3
|
+
`parserMd()` takes no options. You control its output through file metadata, such as the YAML frontmatter at the top of a generated page.
|
|
4
|
+
|
|
5
|
+
## Frontmatter
|
|
6
|
+
|
|
7
|
+
Set `file.meta.frontmatter` inside a plugin. Any serializable object becomes a YAML block at the top of the generated page.
|
|
8
|
+
|
|
9
|
+
::field-group
|
|
10
|
+
|
|
11
|
+
:::field{name="meta.frontmatter" type="Record<string, unknown> | null"}
|
|
12
|
+
YAML frontmatter prepended to the generated Markdown file.
|
|
13
|
+
:::
|
|
14
|
+
|
|
15
|
+
::
|
|
16
|
+
|
|
17
|
+
::code-group
|
|
18
|
+
|
|
19
|
+
```typescript [plugin.ts]
|
|
20
|
+
import { ast } from 'kubb/kit'
|
|
21
|
+
|
|
22
|
+
const file = ast.factory.createFile({
|
|
23
|
+
baseName: 'README.md',
|
|
24
|
+
path: './src/gen/README.md',
|
|
25
|
+
meta: {
|
|
26
|
+
frontmatter: { title: 'API Reference', layout: 'doc' },
|
|
27
|
+
},
|
|
28
|
+
sources: [ast.factory.createSource({ nodes: [ast.factory.createText('# API Reference')] })],
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
```md [README.md]
|
|
33
|
+
---
|
|
34
|
+
title: API Reference
|
|
35
|
+
layout: doc
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
# API Reference
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
::
|
|
42
|
+
|
|
43
|
+
- `parserMd().print` accepts objects and Markdown strings, joined with blank lines.
|
|
44
|
+
- `parserMd().print({ title: 'Pets', layout: 'doc' })` returns `---\ntitle: Pets\nlayout: doc\n---`.
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# Markdown parser
|
|
2
2
|
|
|
3
|
-
The Markdown parser writes `.md` and `.markdown` files. It joins a file's source blocks as plain Markdown, separated by blank lines. When the file sets `meta.frontmatter
|
|
3
|
+
The Markdown parser writes `.md` and `.markdown` files. It joins a file's source blocks as plain Markdown, separated by blank lines. When the file sets [`meta.frontmatter`](https://kubb.dev/extensions/kubb-labs/parser-md/options#frontmatter), it adds that object as YAML frontmatter at the top.
|
|
4
4
|
|
|
5
5
|
It takes no options. Kubb registers it by default with the TypeScript parsers.
|
|
6
6
|
|
|
7
7
|
## Setup
|
|
8
8
|
|
|
9
|
-
Add it yourself only when you set a custom `parsers` array, since that array replaces the default set. List every parser your plugins need.
|
|
9
|
+
Add it yourself only when you set a custom `parsers` array, since that array replaces the default set. List every parser your plugins need. Files no parser claims are written as their source text.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript [kubb.config.ts]
|
|
12
14
|
import { defineConfig } from 'kubb/config'
|
|
13
15
|
import { parserMd } from '@kubb/parser-md'
|
|
14
16
|
import { parserTs, parserTsx } from '@kubb/parser-ts'
|
package/kubb-extension.json
CHANGED
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
"light": "https://kubb.dev/feature/markdown.svg"
|
|
11
11
|
},
|
|
12
12
|
"tags": ["markdown", "frontmatter", "parser", "docs", "yaml"],
|
|
13
|
-
"docs": "https://kubb.dev/
|
|
13
|
+
"docs": "https://kubb.dev/extensions/kubb-labs/parser-md",
|
|
14
|
+
"maintainers": [{ "name": "Stijn Van Hulle", "github": "stijnvanhulle" }],
|
|
14
15
|
"compatibility": {
|
|
15
16
|
"kubb": ">=5.8.0",
|
|
16
17
|
"node": ">=22"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/parser-md",
|
|
3
|
-
"version": "5.8.
|
|
3
|
+
"version": "5.8.3",
|
|
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",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"parser",
|
|
12
12
|
"yaml"
|
|
13
13
|
],
|
|
14
|
-
"homepage": "https://kubb.dev/
|
|
14
|
+
"homepage": "https://kubb.dev/extensions/kubb-labs/parser-md",
|
|
15
15
|
"license": "MIT",
|
|
16
16
|
"author": "stijnvanhulle",
|
|
17
17
|
"repository": {
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"files": [
|
|
37
37
|
"dist",
|
|
38
38
|
"kubb-extension.json",
|
|
39
|
-
"
|
|
39
|
+
"docs",
|
|
40
40
|
"!/**/**.test.**",
|
|
41
41
|
"!/**/__tests__/**",
|
|
42
42
|
"!/**/__snapshots__/**"
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"registry": "https://registry.npmjs.org/"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@kubb/kit": "5.8.
|
|
63
|
+
"@kubb/kit": "5.8.3",
|
|
64
64
|
"yaml": "^2.9.1"
|
|
65
65
|
},
|
|
66
66
|
"engines": {
|