@kubb/parser-md 5.9.3 → 5.9.5
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 +14 -54
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2 -9
- package/dist/index.js +13 -53
- package/dist/index.js.map +1 -1
- package/package.json +4 -3
package/dist/index.cjs
CHANGED
|
@@ -1,52 +1,14 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
//#endregion
|
|
3
|
-
let
|
|
3
|
+
let _kubb_ast = require("@kubb/ast");
|
|
4
|
+
let _kubb_core = require("@kubb/core");
|
|
4
5
|
let yaml = require("yaml");
|
|
5
|
-
//#region kubb-extension.json
|
|
6
|
-
var compatibility = {
|
|
7
|
-
"kubb": ">=5.8.3",
|
|
8
|
-
"node": ">=22"
|
|
9
|
-
};
|
|
10
|
-
//#endregion
|
|
11
|
-
//#region package.json
|
|
12
|
-
var version = "5.9.3";
|
|
13
|
-
//#endregion
|
|
14
|
-
//#region src/utils.ts
|
|
15
|
-
/**
|
|
16
|
-
* Wraps a plain object as a YAML frontmatter envelope (`---\n<yaml>\n---`).
|
|
17
|
-
* Returns an empty string for `null`, `undefined`, or empty objects so callers
|
|
18
|
-
* can drop the result through the same filter chain as other optional fields.
|
|
19
|
-
*/
|
|
20
|
-
function stringifyFrontmatter(data) {
|
|
21
|
-
if (!data || Object.keys(data).length === 0) return "";
|
|
22
|
-
return `---\n${(0, yaml.stringify)(data).trimEnd()}\n---`;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Joins a list of markdown fragments with blank lines. Plain objects are
|
|
26
|
-
* rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass
|
|
27
|
-
* through unchanged.
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* ```ts
|
|
31
|
-
* print({ title: 'Hi' }, '# Hello')
|
|
32
|
-
* // '---\ntitle: Hi\n---\n\n# Hello'
|
|
33
|
-
* ```
|
|
34
|
-
*/
|
|
35
|
-
function print(...parts) {
|
|
36
|
-
const rendered = [];
|
|
37
|
-
for (const part of parts) {
|
|
38
|
-
if (part === null || part === void 0 || part === "") continue;
|
|
39
|
-
const text = typeof part === "string" ? part : stringifyFrontmatter(part);
|
|
40
|
-
if (text) rendered.push(text.trimEnd());
|
|
41
|
-
}
|
|
42
|
-
return rendered.join("\n\n");
|
|
43
|
-
}
|
|
44
6
|
//#endregion
|
|
45
7
|
//#region src/parserMd.ts
|
|
46
8
|
/**
|
|
47
9
|
* Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain
|
|
48
10
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
49
|
-
* prepends a YAML frontmatter envelope
|
|
11
|
+
* prepends a YAML frontmatter envelope.
|
|
50
12
|
*
|
|
51
13
|
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
52
14
|
* `parsers` array yourself, since a custom list replaces the default set.
|
|
@@ -69,30 +31,28 @@ function print(...parts) {
|
|
|
69
31
|
* })
|
|
70
32
|
* ```
|
|
71
33
|
*/
|
|
72
|
-
const parserMd = (0,
|
|
34
|
+
const parserMd = (0, _kubb_core.defineExtension)({
|
|
73
35
|
kind: "parser",
|
|
74
36
|
meta: {
|
|
75
37
|
name: "markdown",
|
|
76
|
-
version,
|
|
77
|
-
compatibility
|
|
38
|
+
version: "5.9.5",
|
|
39
|
+
compatibility: {
|
|
40
|
+
"kubb": ">=5.8.3",
|
|
41
|
+
"node": ">=22"
|
|
42
|
+
},
|
|
78
43
|
issues: "https://github.com/kubb-labs/kubb/issues"
|
|
79
44
|
},
|
|
80
45
|
build() {
|
|
81
46
|
return {
|
|
82
47
|
extNames: [".md", ".markdown"],
|
|
83
|
-
print,
|
|
48
|
+
print: (...parts) => parts.filter(Boolean).join("\n\n"),
|
|
84
49
|
parse(file) {
|
|
85
|
-
const
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
if (text) sourceParts.push(text.trimEnd());
|
|
89
|
-
}
|
|
90
|
-
const body = sourceParts.join("\n\n");
|
|
91
|
-
const meta = file.meta;
|
|
92
|
-
const frontmatter = print(meta?.frontmatter);
|
|
50
|
+
const body = file.sources.map((source) => _kubb_ast.ast.extractStringsFromNodes(source.nodes)).filter(Boolean).map((text) => text.trimEnd()).join("\n\n");
|
|
51
|
+
const frontmatter = file.meta?.frontmatter;
|
|
52
|
+
const envelope = frontmatter && Object.keys(frontmatter).length ? `---\n${(0, yaml.stringify)(frontmatter).trimEnd()}\n---` : "";
|
|
93
53
|
return [
|
|
94
54
|
file.banner,
|
|
95
|
-
|
|
55
|
+
envelope,
|
|
96
56
|
body,
|
|
97
57
|
file.footer
|
|
98
58
|
].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["defineExtension","ast","stringify"],"sources":["../kubb-extension.json","../package.json","../src/parserMd.ts"],"sourcesContent":["","","import { ast } from '@kubb/ast'\nimport { defineExtension } from '@kubb/core'\nimport { stringify } from 'yaml'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\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.\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, issues: 'https://github.com/kubb-labs/kubb/issues' },\n build() {\n return {\n extNames: ['.md', '.markdown'],\n print: (...parts: Array<string>) => parts.filter(Boolean).join('\\n\\n'),\n parse(file) {\n const body = file.sources\n .map((source) => ast.extractStringsFromNodes(source.nodes))\n .filter(Boolean)\n .map((text) => text.trimEnd())\n .join('\\n\\n')\n\n const frontmatter = (file.meta as MdMeta | undefined)?.frontmatter\n const envelope = frontmatter && Object.keys(frontmatter).length ? `---\\n${stringify(frontmatter).trimEnd()}\\n---` : ''\n\n return [file.banner, envelope, body, file.footer]\n .filter((segment): segment is string => Boolean(segment))\n .map((segment) => segment.trimEnd())\n .join('\\n\\n')\n },\n }\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AEwCA,MAAa,YAAA,GAAWA,WAAAA,gBAAAA,CAAgB;CACtC,MAAM;CACN,MAAM;EAAE,MAAM;EAAY;EAAS;;;EAAA;EAAe,QAAQ;CAA2C;CACrG,QAAQ;EACN,OAAO;GACL,UAAU,CAAC,OAAO,WAAW;GAC7B,QAAQ,GAAG,UAAyB,MAAM,OAAO,OAAO,CAAC,CAAC,KAAK,MAAM;GACrE,MAAM,MAAM;IACV,MAAM,OAAO,KAAK,QACf,KAAK,WAAWC,UAAAA,IAAI,wBAAwB,OAAO,KAAK,CAAC,CAAC,CAC1D,OAAO,OAAO,CAAC,CACf,KAAK,SAAS,KAAK,QAAQ,CAAC,CAAC,CAC7B,KAAK,MAAM;IAEd,MAAM,cAAe,KAAK,MAA6B;IACvD,MAAM,WAAW,eAAe,OAAO,KAAK,WAAW,CAAC,CAAC,SAAS,SAAA,GAAQC,KAAAA,UAAAA,CAAU,WAAW,CAAC,CAAC,QAAQ,EAAE,SAAS;IAEpH,OAAO;KAAC,KAAK;KAAQ;KAAU;KAAM,KAAK;IAAM,CAAC,CAC9C,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CACxD,KAAK,YAAY,QAAQ,QAAQ,CAAC,CAAC,CACnC,KAAK,MAAM;GAChB;EACF;CACF;AACF,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,4 @@
|
|
|
1
1
|
import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
|
|
2
|
-
//#region src/utils.d.ts
|
|
3
|
-
/**
|
|
4
|
-
* Markdown `print` input, either a markdown text fragment (passed through
|
|
5
|
-
* verbatim) or a plain object that is serialized as a YAML frontmatter envelope.
|
|
6
|
-
*/
|
|
7
|
-
type PrintInput = string | Record<string, unknown>;
|
|
8
|
-
//#endregion
|
|
9
2
|
//#region src/parserMd.d.ts
|
|
10
3
|
/**
|
|
11
4
|
* Metadata accepted by `parserMd`. Set `frontmatter` on a `<File meta={...}>` and
|
|
@@ -17,7 +10,7 @@ type MdMeta = {
|
|
|
17
10
|
/**
|
|
18
11
|
* Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain
|
|
19
12
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
20
|
-
* prepends a YAML frontmatter envelope
|
|
13
|
+
* prepends a YAML frontmatter envelope.
|
|
21
14
|
*
|
|
22
15
|
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
23
16
|
* `parsers` array yourself, since a custom list replaces the default set.
|
|
@@ -40,7 +33,7 @@ type MdMeta = {
|
|
|
40
33
|
* })
|
|
41
34
|
* ```
|
|
42
35
|
*/
|
|
43
|
-
export declare const parserMd: import("@kubb/core").ParserFactory<object, object,
|
|
36
|
+
export declare const parserMd: import("@kubb/core").ParserFactory<object, object, string>;
|
|
44
37
|
//#endregion
|
|
45
38
|
export type { MdMeta };
|
|
46
39
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,51 +1,13 @@
|
|
|
1
1
|
import "./rolldown-runtime-C0LytTxp.js";
|
|
2
|
-
import { ast
|
|
2
|
+
import { ast } from "@kubb/ast";
|
|
3
|
+
import { defineExtension } from "@kubb/core";
|
|
3
4
|
import { stringify } from "yaml";
|
|
4
|
-
//#region kubb-extension.json
|
|
5
|
-
var compatibility = {
|
|
6
|
-
"kubb": ">=5.8.3",
|
|
7
|
-
"node": ">=22"
|
|
8
|
-
};
|
|
9
|
-
//#endregion
|
|
10
|
-
//#region package.json
|
|
11
|
-
var version = "5.9.3";
|
|
12
|
-
//#endregion
|
|
13
|
-
//#region src/utils.ts
|
|
14
|
-
/**
|
|
15
|
-
* Wraps a plain object as a YAML frontmatter envelope (`---\n<yaml>\n---`).
|
|
16
|
-
* Returns an empty string for `null`, `undefined`, or empty objects so callers
|
|
17
|
-
* can drop the result through the same filter chain as other optional fields.
|
|
18
|
-
*/
|
|
19
|
-
function stringifyFrontmatter(data) {
|
|
20
|
-
if (!data || Object.keys(data).length === 0) return "";
|
|
21
|
-
return `---\n${stringify(data).trimEnd()}\n---`;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Joins a list of markdown fragments with blank lines. Plain objects are
|
|
25
|
-
* rendered as YAML frontmatter via {@link stringifyFrontmatter}, and strings pass
|
|
26
|
-
* through unchanged.
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```ts
|
|
30
|
-
* print({ title: 'Hi' }, '# Hello')
|
|
31
|
-
* // '---\ntitle: Hi\n---\n\n# Hello'
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
function print(...parts) {
|
|
35
|
-
const rendered = [];
|
|
36
|
-
for (const part of parts) {
|
|
37
|
-
if (part === null || part === void 0 || part === "") continue;
|
|
38
|
-
const text = typeof part === "string" ? part : stringifyFrontmatter(part);
|
|
39
|
-
if (text) rendered.push(text.trimEnd());
|
|
40
|
-
}
|
|
41
|
-
return rendered.join("\n\n");
|
|
42
|
-
}
|
|
43
5
|
//#endregion
|
|
44
6
|
//#region src/parserMd.ts
|
|
45
7
|
/**
|
|
46
8
|
* Kubb parser for `.md` and `.markdown` files. Joins source blocks as plain
|
|
47
9
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
48
|
-
* prepends a YAML frontmatter envelope
|
|
10
|
+
* prepends a YAML frontmatter envelope.
|
|
49
11
|
*
|
|
50
12
|
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
51
13
|
* `parsers` array yourself, since a custom list replaces the default set.
|
|
@@ -72,26 +34,24 @@ const parserMd = defineExtension({
|
|
|
72
34
|
kind: "parser",
|
|
73
35
|
meta: {
|
|
74
36
|
name: "markdown",
|
|
75
|
-
version,
|
|
76
|
-
compatibility
|
|
37
|
+
version: "5.9.5",
|
|
38
|
+
compatibility: {
|
|
39
|
+
"kubb": ">=5.8.3",
|
|
40
|
+
"node": ">=22"
|
|
41
|
+
},
|
|
77
42
|
issues: "https://github.com/kubb-labs/kubb/issues"
|
|
78
43
|
},
|
|
79
44
|
build() {
|
|
80
45
|
return {
|
|
81
46
|
extNames: [".md", ".markdown"],
|
|
82
|
-
print,
|
|
47
|
+
print: (...parts) => parts.filter(Boolean).join("\n\n"),
|
|
83
48
|
parse(file) {
|
|
84
|
-
const
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
if (text) sourceParts.push(text.trimEnd());
|
|
88
|
-
}
|
|
89
|
-
const body = sourceParts.join("\n\n");
|
|
90
|
-
const meta = file.meta;
|
|
91
|
-
const frontmatter = print(meta?.frontmatter);
|
|
49
|
+
const body = file.sources.map((source) => ast.extractStringsFromNodes(source.nodes)).filter(Boolean).map((text) => text.trimEnd()).join("\n\n");
|
|
50
|
+
const frontmatter = file.meta?.frontmatter;
|
|
51
|
+
const envelope = frontmatter && Object.keys(frontmatter).length ? `---\n${stringify(frontmatter).trimEnd()}\n---` : "";
|
|
92
52
|
return [
|
|
93
53
|
file.banner,
|
|
94
|
-
|
|
54
|
+
envelope,
|
|
95
55
|
body,
|
|
96
56
|
file.footer
|
|
97
57
|
].filter((segment) => Boolean(segment)).map((segment) => segment.trimEnd()).join("\n\n");
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../kubb-extension.json","../package.json","../src/
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../kubb-extension.json","../package.json","../src/parserMd.ts"],"sourcesContent":["","","import { ast } from '@kubb/ast'\nimport { defineExtension } from '@kubb/core'\nimport { stringify } from 'yaml'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\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.\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, issues: 'https://github.com/kubb-labs/kubb/issues' },\n build() {\n return {\n extNames: ['.md', '.markdown'],\n print: (...parts: Array<string>) => parts.filter(Boolean).join('\\n\\n'),\n parse(file) {\n const body = file.sources\n .map((source) => ast.extractStringsFromNodes(source.nodes))\n .filter(Boolean)\n .map((text) => text.trimEnd())\n .join('\\n\\n')\n\n const frontmatter = (file.meta as MdMeta | undefined)?.frontmatter\n const envelope = frontmatter && Object.keys(frontmatter).length ? `---\\n${stringify(frontmatter).trimEnd()}\\n---` : ''\n\n return [file.banner, envelope, body, file.footer]\n .filter((segment): segment is string => Boolean(segment))\n .map((segment) => segment.trimEnd())\n .join('\\n\\n')\n },\n }\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AEwCA,MAAa,WAAW,gBAAgB;CACtC,MAAM;CACN,MAAM;EAAE,MAAM;EAAY;EAAS;;;EAAA;EAAe,QAAQ;CAA2C;CACrG,QAAQ;EACN,OAAO;GACL,UAAU,CAAC,OAAO,WAAW;GAC7B,QAAQ,GAAG,UAAyB,MAAM,OAAO,OAAO,CAAC,CAAC,KAAK,MAAM;GACrE,MAAM,MAAM;IACV,MAAM,OAAO,KAAK,QACf,KAAK,WAAW,IAAI,wBAAwB,OAAO,KAAK,CAAC,CAAC,CAC1D,OAAO,OAAO,CAAC,CACf,KAAK,SAAS,KAAK,QAAQ,CAAC,CAAC,CAC7B,KAAK,MAAM;IAEd,MAAM,cAAe,KAAK,MAA6B;IACvD,MAAM,WAAW,eAAe,OAAO,KAAK,WAAW,CAAC,CAAC,SAAS,QAAQ,UAAU,WAAW,CAAC,CAAC,QAAQ,EAAE,SAAS;IAEpH,OAAO;KAAC,KAAK;KAAQ;KAAU;KAAM,KAAK;IAAM,CAAC,CAC9C,QAAQ,YAA+B,QAAQ,OAAO,CAAC,CAAC,CACxD,KAAK,YAAY,QAAQ,QAAQ,CAAC,CAAC,CACnC,KAAK,MAAM;GAChB;EACF;CACF;AACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/parser-md",
|
|
3
|
-
"version": "5.9.
|
|
4
|
-
"description": "Markdown source file parser for Kubb. Converts the universal AST to `.md` source and
|
|
3
|
+
"version": "5.9.5",
|
|
4
|
+
"description": "Markdown source file parser for Kubb. Converts the universal AST to `.md` source and prepends YAML frontmatter from the file meta.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"codegen",
|
|
7
7
|
"frontmatter",
|
|
@@ -60,7 +60,8 @@
|
|
|
60
60
|
"registry": "https://registry.npmjs.org/"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@kubb/
|
|
63
|
+
"@kubb/ast": "5.9.5",
|
|
64
|
+
"@kubb/core": "5.9.5",
|
|
64
65
|
"yaml": "^2.9.1"
|
|
65
66
|
},
|
|
66
67
|
"engines": {
|