@kubb/parser-md 5.0.0-beta.79 → 5.0.0-beta.81
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 +8 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +7 -4
- package/dist/index.js +7 -4
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.cjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
//#endregion
|
|
3
3
|
let _kubb_core = require("@kubb/core");
|
|
4
|
-
let
|
|
4
|
+
let _kubb_ast = require("@kubb/ast");
|
|
5
5
|
let yaml = require("yaml");
|
|
6
6
|
//#region src/utils.ts
|
|
7
7
|
/**
|
|
@@ -40,20 +40,23 @@ function print(...parts) {
|
|
|
40
40
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
41
41
|
* prepends a YAML frontmatter envelope produced by `parserMd.print`.
|
|
42
42
|
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
43
|
+
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
44
|
+
* `parsers` array yourself, since a custom list replaces the default set.
|
|
45
|
+
* `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims
|
|
46
|
+
* `.md`/`.markdown`.
|
|
45
47
|
*
|
|
46
48
|
* @example
|
|
47
49
|
* ```ts
|
|
48
50
|
* import { defineConfig } from 'kubb'
|
|
49
51
|
* import { adapterOas } from '@kubb/adapter-oas'
|
|
50
52
|
* import { parserMd } from '@kubb/parser-md'
|
|
53
|
+
* import { parserTs, parserTsx } from '@kubb/parser-ts'
|
|
51
54
|
*
|
|
52
55
|
* export default defineConfig({
|
|
53
56
|
* input: { path: './petStore.yaml' },
|
|
54
57
|
* output: { path: './src/gen' },
|
|
55
58
|
* adapter: adapterOas(),
|
|
56
|
-
* parsers: [parserMd],
|
|
59
|
+
* parsers: [parserTs, parserTsx, parserMd],
|
|
57
60
|
* plugins: [],
|
|
58
61
|
* })
|
|
59
62
|
* ```
|
|
@@ -67,7 +70,7 @@ const parserMd = (0, _kubb_core.defineParser)({
|
|
|
67
70
|
parse(file) {
|
|
68
71
|
const sourceParts = [];
|
|
69
72
|
for (const source of file.sources) {
|
|
70
|
-
const text = (0,
|
|
73
|
+
const text = (0, _kubb_ast.extractStringsFromNodes)(source.nodes);
|
|
71
74
|
if (text) sourceParts.push(text.trimEnd());
|
|
72
75
|
}
|
|
73
76
|
const body = sourceParts.join("\n\n");
|
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
|
|
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"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
|
|
2
|
-
import { ast } from "@kubb/
|
|
2
|
+
import { ast } from "@kubb/ast";
|
|
3
3
|
|
|
4
4
|
//#region src/utils.d.ts
|
|
5
5
|
/**
|
|
@@ -21,20 +21,23 @@ type MdMeta = {
|
|
|
21
21
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
22
22
|
* prepends a YAML frontmatter envelope produced by `parserMd.print`.
|
|
23
23
|
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
25
|
+
* `parsers` array yourself, since a custom list replaces the default set.
|
|
26
|
+
* `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims
|
|
27
|
+
* `.md`/`.markdown`.
|
|
26
28
|
*
|
|
27
29
|
* @example
|
|
28
30
|
* ```ts
|
|
29
31
|
* import { defineConfig } from 'kubb'
|
|
30
32
|
* import { adapterOas } from '@kubb/adapter-oas'
|
|
31
33
|
* import { parserMd } from '@kubb/parser-md'
|
|
34
|
+
* import { parserTs, parserTsx } from '@kubb/parser-ts'
|
|
32
35
|
*
|
|
33
36
|
* export default defineConfig({
|
|
34
37
|
* input: { path: './petStore.yaml' },
|
|
35
38
|
* output: { path: './src/gen' },
|
|
36
39
|
* adapter: adapterOas(),
|
|
37
|
-
* parsers: [parserMd],
|
|
40
|
+
* parsers: [parserTs, parserTsx, parserMd],
|
|
38
41
|
* plugins: [],
|
|
39
42
|
* })
|
|
40
43
|
* ```
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import "./rolldown-runtime-C0LytTxp.js";
|
|
2
2
|
import { defineParser } from "@kubb/core";
|
|
3
|
-
import { extractStringsFromNodes } from "@kubb/ast
|
|
3
|
+
import { extractStringsFromNodes } from "@kubb/ast";
|
|
4
4
|
import { stringify } from "yaml";
|
|
5
5
|
//#region src/utils.ts
|
|
6
6
|
/**
|
|
@@ -39,20 +39,23 @@ function print(...parts) {
|
|
|
39
39
|
* markdown (separated by blank lines) and, when `file.meta.frontmatter` is set,
|
|
40
40
|
* prepends a YAML frontmatter envelope produced by `parserMd.print`.
|
|
41
41
|
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* Runs by default next to `parserTs` and `parserTsx`. Add it to a custom
|
|
43
|
+
* `parsers` array yourself, since a custom list replaces the default set.
|
|
44
|
+
* `parserTs` keeps handling `.ts`/`.js` files, `parserMd` claims
|
|
45
|
+
* `.md`/`.markdown`.
|
|
44
46
|
*
|
|
45
47
|
* @example
|
|
46
48
|
* ```ts
|
|
47
49
|
* import { defineConfig } from 'kubb'
|
|
48
50
|
* import { adapterOas } from '@kubb/adapter-oas'
|
|
49
51
|
* import { parserMd } from '@kubb/parser-md'
|
|
52
|
+
* import { parserTs, parserTsx } from '@kubb/parser-ts'
|
|
50
53
|
*
|
|
51
54
|
* export default defineConfig({
|
|
52
55
|
* input: { path: './petStore.yaml' },
|
|
53
56
|
* output: { path: './src/gen' },
|
|
54
57
|
* adapter: adapterOas(),
|
|
55
|
-
* parsers: [parserMd],
|
|
58
|
+
* parsers: [parserTs, parserTsx, parserMd],
|
|
56
59
|
* plugins: [],
|
|
57
60
|
* })
|
|
58
61
|
* ```
|
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
|
|
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"}
|
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.81",
|
|
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.
|
|
46
|
-
"@kubb/core": "5.0.0-beta.
|
|
45
|
+
"@kubb/ast": "5.0.0-beta.81",
|
|
46
|
+
"@kubb/core": "5.0.0-beta.81"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@internals/utils": "0.0.0"
|