@kubb/parser-md 5.18.5 → 5.18.7
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 +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -2
- package/dist/index.d.ts +1 -2
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/docs/options.md +3 -2
- package/docs/overview.md +1 -1
- package/package.json +3 -3
package/dist/index.cjs
CHANGED
|
@@ -33,7 +33,7 @@ const parserMd = (0, _kubb_core.defineExtension)({
|
|
|
33
33
|
kind: "parser",
|
|
34
34
|
meta: {
|
|
35
35
|
name: "markdown",
|
|
36
|
-
version: "5.18.
|
|
36
|
+
version: "5.18.7",
|
|
37
37
|
compatibility: {
|
|
38
38
|
"kubb": ">=5.8.3",
|
|
39
39
|
"node": ">=22.22"
|
|
@@ -45,7 +45,7 @@ const parserMd = (0, _kubb_core.defineExtension)({
|
|
|
45
45
|
extNames: [".md", ".markdown"],
|
|
46
46
|
print: (...parts) => parts.filter(Boolean).join("\n\n"),
|
|
47
47
|
parse(file) {
|
|
48
|
-
const body = file.sources.map((source) => _kubb_ast.ast.
|
|
48
|
+
const body = file.sources.map((source) => _kubb_ast.ast.node.getText(source.nodes)).filter(Boolean).map((text) => text.trimEnd()).join("\n\n");
|
|
49
49
|
const frontmatter = file.meta?.frontmatter;
|
|
50
50
|
const envelope = frontmatter && Object.keys(frontmatter).length ? `---\n${(0, yaml.stringify)(frontmatter).trimEnd()}\n---` : "";
|
|
51
51
|
return [
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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.
|
|
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.node.getText(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,KAAK,QAAQ,OAAO,KAAK,CAAC,CAAC,CAC/C,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.cts
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -32,7 +32,7 @@ const parserMd = defineExtension({
|
|
|
32
32
|
kind: "parser",
|
|
33
33
|
meta: {
|
|
34
34
|
name: "markdown",
|
|
35
|
-
version: "5.18.
|
|
35
|
+
version: "5.18.7",
|
|
36
36
|
compatibility: {
|
|
37
37
|
"kubb": ">=5.8.3",
|
|
38
38
|
"node": ">=22.22"
|
|
@@ -44,7 +44,7 @@ const parserMd = defineExtension({
|
|
|
44
44
|
extNames: [".md", ".markdown"],
|
|
45
45
|
print: (...parts) => parts.filter(Boolean).join("\n\n"),
|
|
46
46
|
parse(file) {
|
|
47
|
-
const body = file.sources.map((source) => ast.
|
|
47
|
+
const body = file.sources.map((source) => ast.node.getText(source.nodes)).filter(Boolean).map((text) => text.trimEnd()).join("\n\n");
|
|
48
48
|
const frontmatter = file.meta?.frontmatter;
|
|
49
49
|
const envelope = frontmatter && Object.keys(frontmatter).length ? `---\n${stringify(frontmatter).trimEnd()}\n---` : "";
|
|
50
50
|
return [
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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.
|
|
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.node.getText(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,KAAK,QAAQ,OAAO,KAAK,CAAC,CAAC,CAC/C,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/docs/options.md
CHANGED
|
@@ -40,5 +40,6 @@ Endpoints generated from the OpenAPI spec.
|
|
|
40
40
|
|
|
41
41
|
::
|
|
42
42
|
|
|
43
|
-
|
|
44
|
-
|
|
43
|
+
An empty object or `null` writes no frontmatter. A file banner, when set, goes above the frontmatter.
|
|
44
|
+
|
|
45
|
+
`parserMd().print(...parts)` joins Markdown strings with blank lines and skips empty ones. It takes strings only, so frontmatter always comes from `meta.frontmatter`.
|
package/docs/overview.md
CHANGED
|
@@ -4,7 +4,7 @@ The Markdown parser joins a file's source blocks as plain Markdown, separated by
|
|
|
4
4
|
|
|
5
5
|
## Setup
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Kubb registers the parser by default, next to `parserTs` and `parserTsx`, in `defineConfig` and in the bundler integrations, so no setup is needed. 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
8
|
|
|
9
9
|
## Options worth knowing
|
|
10
10
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/parser-md",
|
|
3
|
-
"version": "5.18.
|
|
3
|
+
"version": "5.18.7",
|
|
4
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",
|
|
@@ -65,8 +65,8 @@
|
|
|
65
65
|
"registry": "https://registry.npmjs.org/"
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
68
|
-
"@kubb/ast": "^5.18.
|
|
69
|
-
"@kubb/core": "^5.18.
|
|
68
|
+
"@kubb/ast": "^5.18.7",
|
|
69
|
+
"@kubb/core": "^5.18.7",
|
|
70
70
|
"yaml": "^2.9.1"
|
|
71
71
|
},
|
|
72
72
|
"engines": {
|