@kubb/parser-md 5.8.4 → 5.9.1
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 +3 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/docs/options.md +2 -2
- package/docs/overview.md +20 -7
- package/package.json +2 -2
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.
|
|
12
|
+
var version = "5.9.1";
|
|
13
13
|
//#endregion
|
|
14
14
|
//#region src/utils.ts
|
|
15
15
|
/**
|
|
@@ -74,7 +74,8 @@ const parserMd = (0, _kubb_kit.defineExtension)({
|
|
|
74
74
|
meta: {
|
|
75
75
|
name: "markdown",
|
|
76
76
|
version,
|
|
77
|
-
compatibility
|
|
77
|
+
compatibility,
|
|
78
|
+
issues: "https://github.com/kubb-labs/kubb/issues"
|
|
78
79
|
},
|
|
79
80
|
build() {
|
|
80
81
|
return {
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;
|
|
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, issues: 'https://github.com/kubb-labs/kubb/issues' },\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;EAAe,QAAQ;CAA2C;CACrG,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
|
@@ -8,7 +8,7 @@ var compatibility = {
|
|
|
8
8
|
};
|
|
9
9
|
//#endregion
|
|
10
10
|
//#region package.json
|
|
11
|
-
var version = "5.
|
|
11
|
+
var version = "5.9.1";
|
|
12
12
|
//#endregion
|
|
13
13
|
//#region src/utils.ts
|
|
14
14
|
/**
|
|
@@ -73,7 +73,8 @@ const parserMd = defineExtension({
|
|
|
73
73
|
meta: {
|
|
74
74
|
name: "markdown",
|
|
75
75
|
version,
|
|
76
|
-
compatibility
|
|
76
|
+
compatibility,
|
|
77
|
+
issues: "https://github.com/kubb-labs/kubb/issues"
|
|
77
78
|
},
|
|
78
79
|
build() {
|
|
79
80
|
return {
|
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, 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;
|
|
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, issues: 'https://github.com/kubb-labs/kubb/issues' },\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;EAAe,QAAQ;CAA2C;CACrG,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
CHANGED
|
@@ -25,7 +25,7 @@ const file = ast.factory.createFile({
|
|
|
25
25
|
meta: {
|
|
26
26
|
frontmatter: { title: 'API Reference', layout: 'doc' },
|
|
27
27
|
},
|
|
28
|
-
sources: [ast.factory.createSource({ nodes: [ast.factory.createText('
|
|
28
|
+
sources: [ast.factory.createSource({ nodes: [ast.factory.createText('Endpoints generated from the OpenAPI spec.')] })],
|
|
29
29
|
})
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ title: API Reference
|
|
|
35
35
|
layout: doc
|
|
36
36
|
---
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Endpoints generated from the OpenAPI spec.
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
::
|
package/docs/overview.md
CHANGED
|
@@ -1,24 +1,37 @@
|
|
|
1
|
-
# Markdown
|
|
1
|
+
# Markdown
|
|
2
2
|
|
|
3
|
-
The Markdown parser
|
|
4
|
-
|
|
5
|
-
It takes no options. Kubb registers it by default with the TypeScript parsers.
|
|
3
|
+
The Markdown parser joins a file's source blocks as plain Markdown, separated by blank lines. When a file sets `meta.frontmatter`, the parser writes that object as YAML frontmatter above the content, after the file banner if one is set.
|
|
6
4
|
|
|
7
5
|
## Setup
|
|
8
6
|
|
|
9
|
-
Add it yourself only when you set a custom `parsers` array,
|
|
7
|
+
With `defineConfig` from `kubb/config`, Kubb registers the parser by default, next to `parserTs` and `parserTsx`, so no setup is needed. Bundler integrations leave it out. Add it yourself only when you set a custom `parsers` array, because that array replaces the default set. List every parser your plugins need. Files that no parser claims are written as their source text only, without imports, exports, banner, or footer.
|
|
8
|
+
|
|
9
|
+
## Options worth knowing
|
|
10
|
+
|
|
11
|
+
The parser takes no options. Plugins control the output through `meta.frontmatter` on each file, and an empty object writes none.
|
|
12
|
+
|
|
13
|
+
See [Options](https://kubb.dev/extensions/kubb-labs/parser-md/options) for how a plugin sets frontmatter.
|
|
10
14
|
|
|
11
15
|
## Example
|
|
12
16
|
|
|
17
|
+
The config below sets a custom `parsers` array and keeps the Markdown parser in it.
|
|
18
|
+
|
|
13
19
|
```typescript [kubb.config.ts]
|
|
14
20
|
import { defineConfig } from 'kubb/config'
|
|
15
21
|
import { parserMd } from '@kubb/parser-md'
|
|
16
22
|
import { parserTs, parserTsx } from '@kubb/parser-ts'
|
|
23
|
+
import { pluginTs } from '@kubb/plugin-ts'
|
|
17
24
|
|
|
18
25
|
export default defineConfig({
|
|
19
26
|
input: './petStore.yaml',
|
|
20
27
|
output: { path: './src/gen' },
|
|
21
|
-
parsers: [
|
|
22
|
-
|
|
28
|
+
parsers: [
|
|
29
|
+
parserTs(),
|
|
30
|
+
parserTsx(),
|
|
31
|
+
parserMd(),
|
|
32
|
+
],
|
|
33
|
+
plugins: [
|
|
34
|
+
pluginTs(),
|
|
35
|
+
],
|
|
23
36
|
})
|
|
24
37
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/parser-md",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.9.1",
|
|
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",
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"registry": "https://registry.npmjs.org/"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@kubb/kit": "5.
|
|
63
|
+
"@kubb/kit": "5.9.1",
|
|
64
64
|
"yaml": "^2.9.1"
|
|
65
65
|
},
|
|
66
66
|
"engines": {
|