@hanzo/docs-docgen 3.0.5 → 3.0.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/README.md +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +67 -91
- package/dist/index.js.map +1 -1
- package/dist/remark-ts2js.d.ts +1 -1
- package/dist/remark-ts2js.d.ts.map +1 -1
- package/dist/remark-ts2js.js +51 -59
- package/dist/remark-ts2js.js.map +1 -1
- package/package.json +32 -14
- package/dist/asyncToGenerator-Ux3KppAy.js +0 -28
package/README.md
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"mappings":";;;;;;;;KAKK,SAAA,MAAe,CAAA,GAAI,OAAA,CAAQ,CAAA;AAAA,UAEf,YAAA;EACf,IAAA;;;AALiC;EAUjC,GAAA,GAAM,KAAA,WAAgB,OAAA,EAAS,OAAA,KAAY,SAAA;EAE3C,MAAA,IAAU,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,KAAA;AAAA;AAAA,UAGpB,OAAA;EACR,IAAA,EAAM,IAAA;EACN,IAAA;EACA,GAAA;AAAA;AAAA,UAGe,mBAAA;EACf,UAAA,GAAa,YAAA;AAAA;AAAA,iBAKC,YAAA,CAAA;EAAe;AAAA,GAAmB,mBAAA,GAAsB,WAAA,CAAY,IAAA,EAAM,IAAA;;;iBC3B1E,aAAA,CAAc,IAAA,UAAc,UAAA,YAAsB,QAAA;AAAA,iBAYlD,qBAAA,CAAsB,GAAA,UAAa,KAAA,EAAO,UAAA,GAAa,eAAA;;;UCTtD,oBAAA;;EAEf,IAAA;;;;AFLiC;;EEYjC,QAAA;AAAA;AAAA,KAGU,kBAAA,GAAqB,CAAA,CAAE,MAAA,QAAc,mBAAA;AAAA,cAEpC,mBAAA,EAAmB,CAAA,CAAA,SAAA;;;;;;;iBAmBhB,aAAA,CAAA;EACd,QAAA;EACA;AAAA,IACC,oBAAA,GAA4B,YAAA;;;UCpCrB,cAAA;EACR,IAAA;;;;EAKA,OAAA,GAAU,OAAA;AAAA;AAAA,KAGA,oBAAA;EACV,IAAA;EACA,GAAA;EHZ8B;;;;;EGmB9B,OAAA;IAEM,EAAA;EAAA;EAIN,eAAA,GAAkB,cAAA;AAAA;AHvBpB;;;;;;;;;;;;;AAAA,iBGuCgB,aAAA,CAAA;EACd,GAAA;EACA,IAAA;EACA,OAAA;EACA;AAAA,IAMC,oBAAA,GAA4B,WAAA,CAAY,IAAA,EAAM,IAAA;;;iBCnDjC,UAAA,CAAW,OAAA;EACzB,SAAA,GAAY,MAAA;AAAA,IACV,WAAA,CAAY,IAAA,EAAM,IAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { t as _asyncToGenerator } from "./asyncToGenerator-Ux3KppAy.js";
|
|
2
1
|
import { visit } from "unist-util-visit";
|
|
3
2
|
import * as fs from "node:fs/promises";
|
|
4
3
|
import * as path from "node:path";
|
|
@@ -6,46 +5,33 @@ import { z } from "zod";
|
|
|
6
5
|
import convert from "npm-to-yarn";
|
|
7
6
|
|
|
8
7
|
//#region src/remark-docgen.ts
|
|
9
|
-
const metaRegex =
|
|
8
|
+
const metaRegex = /doc-gen:(?<name>.+)/;
|
|
10
9
|
function remarkDocGen({ generators = [] }) {
|
|
11
|
-
return
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
const items = Array.isArray(result) ? result : [result];
|
|
34
|
-
parent.children.splice(index, 1, ...items);
|
|
35
|
-
}
|
|
36
|
-
});
|
|
37
|
-
return function run$1() {
|
|
38
|
-
return _ref.apply(this, arguments);
|
|
39
|
-
};
|
|
40
|
-
}();
|
|
41
|
-
queue.push(run());
|
|
42
|
-
});
|
|
43
|
-
yield Promise.all(queue);
|
|
10
|
+
return async (tree, file) => {
|
|
11
|
+
generators.forEach((gen) => gen.onFile?.(tree, file));
|
|
12
|
+
const queue = [];
|
|
13
|
+
visit(tree, "code", (code, _, parent) => {
|
|
14
|
+
if (code.lang !== "json" || !code.meta || !parent) return;
|
|
15
|
+
const matches = metaRegex.exec(code.meta);
|
|
16
|
+
if (!matches) return;
|
|
17
|
+
const name = matches[1];
|
|
18
|
+
const gen = generators.find((g) => g.name === name);
|
|
19
|
+
const run = async () => {
|
|
20
|
+
const result = await gen?.run(JSON.parse(code.value), {
|
|
21
|
+
cwd: file.cwd,
|
|
22
|
+
path: file.path,
|
|
23
|
+
node: code
|
|
24
|
+
});
|
|
25
|
+
const index = parent.children.findIndex((c) => c === code);
|
|
26
|
+
if (result && index !== -1) {
|
|
27
|
+
const items = Array.isArray(result) ? result : [result];
|
|
28
|
+
parent.children.splice(index, 1, ...items);
|
|
29
|
+
}
|
|
30
|
+
};
|
|
31
|
+
queue.push(run());
|
|
44
32
|
});
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
};
|
|
48
|
-
}();
|
|
33
|
+
await Promise.all(queue);
|
|
34
|
+
};
|
|
49
35
|
}
|
|
50
36
|
|
|
51
37
|
//#endregion
|
|
@@ -89,28 +75,25 @@ const fileGeneratorSchema = z.object({
|
|
|
89
75
|
function fileGenerator({ relative = false, trim = true } = {}) {
|
|
90
76
|
return {
|
|
91
77
|
name: "file",
|
|
92
|
-
run(input, ctx) {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
type: "
|
|
101
|
-
children: [{
|
|
102
|
-
type: "text",
|
|
103
|
-
value
|
|
104
|
-
}]
|
|
105
|
-
};
|
|
106
|
-
const codeOptions = codeblock === true ? {} : codeblock;
|
|
107
|
-
return {
|
|
108
|
-
type: "code",
|
|
109
|
-
lang: (_codeOptions$lang = codeOptions.lang) !== null && _codeOptions$lang !== void 0 ? _codeOptions$lang : path.extname(dest).slice(1),
|
|
110
|
-
meta: codeOptions.meta,
|
|
78
|
+
async run(input, ctx) {
|
|
79
|
+
const { file, codeblock = false } = fileGeneratorSchema.parse(input);
|
|
80
|
+
const dest = relative ? path.resolve(ctx.cwd, path.dirname(ctx.path), file) : path.resolve(ctx.cwd, file);
|
|
81
|
+
let value = await fs.readFile(dest).then((res) => res.toString());
|
|
82
|
+
if (trim) value = value.trim();
|
|
83
|
+
if (codeblock === false) return {
|
|
84
|
+
type: "paragraph",
|
|
85
|
+
children: [{
|
|
86
|
+
type: "text",
|
|
111
87
|
value
|
|
112
|
-
}
|
|
113
|
-
}
|
|
88
|
+
}]
|
|
89
|
+
};
|
|
90
|
+
const codeOptions = codeblock === true ? {} : codeblock;
|
|
91
|
+
return {
|
|
92
|
+
type: "code",
|
|
93
|
+
lang: codeOptions.lang ?? path.extname(dest).slice(1),
|
|
94
|
+
meta: codeOptions.meta,
|
|
95
|
+
value
|
|
96
|
+
};
|
|
114
97
|
}
|
|
115
98
|
};
|
|
116
99
|
}
|
|
@@ -189,38 +172,31 @@ function remarkInstall({ Tab = "Tab", Tabs = "Tabs", persist = false, packageMan
|
|
|
189
172
|
//#endregion
|
|
190
173
|
//#region src/remark-show.ts
|
|
191
174
|
function remarkShow(options) {
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
if (
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
const
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
})());
|
|
215
|
-
return "skip";
|
|
216
|
-
}
|
|
217
|
-
});
|
|
218
|
-
yield Promise.all(tasks);
|
|
175
|
+
const variables = options?.variables ?? {};
|
|
176
|
+
return async (tree, file) => {
|
|
177
|
+
const { toJs } = await import("estree-util-to-js");
|
|
178
|
+
const tasks = [];
|
|
179
|
+
visit(tree, "mdxJsxFlowElement", (node) => {
|
|
180
|
+
if (node.name !== "show") return;
|
|
181
|
+
for (const attr of node.attributes) {
|
|
182
|
+
if (attr.type !== "mdxJsxAttribute" || attr.name !== "on") continue;
|
|
183
|
+
if (!attr.value || typeof attr.value !== "object" || !attr.value.data?.estree) return "skip";
|
|
184
|
+
const js = toJs(attr.value.data.estree);
|
|
185
|
+
const callback = new Function(...Object.keys(variables), `return ${js.value}`)(...Object.values(variables));
|
|
186
|
+
tasks.push((async () => {
|
|
187
|
+
const value = typeof callback === "function" ? await callback(file) : callback;
|
|
188
|
+
Object.assign(node, {
|
|
189
|
+
type: "mdxJsxFlowElement",
|
|
190
|
+
name: null,
|
|
191
|
+
attributes: [],
|
|
192
|
+
children: value === true ? node.children : []
|
|
193
|
+
});
|
|
194
|
+
})());
|
|
195
|
+
return "skip";
|
|
196
|
+
}
|
|
219
197
|
});
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
};
|
|
223
|
-
}();
|
|
198
|
+
await Promise.all(tasks);
|
|
199
|
+
};
|
|
224
200
|
}
|
|
225
201
|
|
|
226
202
|
//#endregion
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["queue: Promise<void>[]","element: Record<string, unknown>","tasks: Promise<void>[]"],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"sourcesContent":["import { type BlockContent, type Code, type Root } from 'mdast';\nimport { type Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport type { VFile } from 'vfile';\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface DocGenerator {\n name: string;\n\n /**\n * Transform codeblocks to another mdast element\n */\n run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;\n\n onFile?: (tree: Root, file: VFile) => void;\n}\n\ninterface Context {\n node: Code;\n path: string;\n cwd: string;\n}\n\nexport interface RemarkDocGenOptions {\n generators?: DocGenerator[];\n}\n\nconst metaRegex = /doc-gen:(?<name>.+)/;\n\nexport function remarkDocGen({ generators = [] }: RemarkDocGenOptions): Transformer<Root, Root> {\n return async (tree, file) => {\n generators.forEach((gen) => gen.onFile?.(tree, file));\n const queue: Promise<void>[] = [];\n\n visit(tree, 'code', (code, _, parent) => {\n if (code.lang !== 'json' || !code.meta || !parent) return;\n\n const matches = metaRegex.exec(code.meta);\n if (!matches) return;\n\n const name = matches[1];\n const gen = generators.find((g) => g.name === name);\n\n const run = async (): Promise<void> => {\n const result = await gen?.run(JSON.parse(code.value), {\n cwd: file.cwd,\n path: file.path,\n node: code,\n });\n const index = parent.children.findIndex((c) => c === code);\n\n if (result && index !== -1) {\n const items = Array.isArray(result)\n ? (result as BlockContent[])\n : [result as BlockContent];\n\n parent.children.splice(index, 1, ...items);\n }\n };\n\n queue.push(run());\n });\n\n await Promise.all(queue);\n };\n}\n","import type { Expression, Program } from 'estree';\nimport type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';\n\nexport function createElement(name: string, attributes: object[], children?: unknown): object {\n const element: Record<string, unknown> = {\n type: 'mdxJsxFlowElement',\n name,\n attributes,\n };\n\n if (children) element.children = children;\n\n return element;\n}\n\nexport function expressionToAttribute(key: string, value: Expression): MdxJsxAttribute {\n return {\n type: 'mdxJsxAttribute',\n name: key,\n value: {\n type: 'mdxJsxAttributeValueExpression',\n value: '',\n data: {\n estree: {\n type: 'Program',\n body: [\n {\n type: 'ExpressionStatement',\n expression: value,\n },\n ],\n } as Program,\n },\n },\n };\n}\n","import * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport type { Code, Paragraph } from 'mdast';\nimport { z } from 'zod';\nimport type { DocGenerator } from './remark-docgen';\n\nexport interface FileGeneratorOptions {\n /** @defaultValue true */\n trim?: boolean;\n\n /**\n * Resolve reference files relative to `vfile.path`\n *\n * @defaultValue false\n */\n relative?: boolean;\n}\n\nexport type FileGeneratorInput = z.output<typeof fileGeneratorSchema>;\n\nexport const fileGeneratorSchema = z.object({\n file: z.string(),\n\n /**\n * Turn file content into a code block\n *\n * @defaultValue false\n */\n codeblock: z\n .union([\n z.object({\n lang: z.string().optional(),\n meta: z.string().optional(),\n }),\n z.boolean(),\n ])\n .default(false),\n});\n\nexport function fileGenerator({\n relative = false,\n trim = true,\n}: FileGeneratorOptions = {}): DocGenerator {\n return {\n name: 'file',\n async run(input, ctx) {\n const { file, codeblock = false } = fileGeneratorSchema.parse(input);\n\n const dest = relative\n ? path.resolve(ctx.cwd, path.dirname(ctx.path), file)\n : path.resolve(ctx.cwd, file);\n let value = await fs.readFile(dest).then((res) => res.toString());\n if (trim) value = value.trim();\n\n if (codeblock === false) {\n return {\n type: 'paragraph',\n children: [{ type: 'text', value }],\n } as Paragraph;\n }\n\n const codeOptions = codeblock === true ? {} : codeblock;\n\n return {\n type: 'code',\n lang: codeOptions.lang ?? path.extname(dest).slice(1),\n meta: codeOptions.meta,\n value,\n } as Code;\n },\n };\n}\n","import type { Code, Root } from 'mdast';\nimport type { Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport convert from 'npm-to-yarn';\nimport { createElement, expressionToAttribute } from './utils';\n\ninterface PackageManager {\n name: string;\n\n /**\n * Convert from npm to another package manager\n */\n command: (command: string) => string;\n}\n\nexport type RemarkInstallOptions = {\n Tabs?: string;\n Tab?: string;\n\n /**\n * Persist Tab value (Fumadocs UI only)\n *\n * @defaultValue false\n */\n persist?:\n | {\n id: string;\n }\n | false;\n\n packageManagers?: PackageManager[];\n};\n\n/**\n * It generates the following structure from a code block with `package-install` as language\n *\n * @example\n * ```tsx\n * <Tabs items={[\"npm\", \"pnpm\", \"yarn\", \"bun\"]}>\n * <Tab value=\"pnpm\">...</Tab>\n * ...\n * </Tabs>\n * ```\n *\n * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.\n */\nexport function remarkInstall({\n Tab = 'Tab',\n Tabs = 'Tabs',\n persist = false,\n packageManagers = [\n { command: (cmd) => convert(cmd, 'npm'), name: 'npm' },\n { command: (cmd) => convert(cmd, 'pnpm'), name: 'pnpm' },\n { command: (cmd) => convert(cmd, 'yarn'), name: 'yarn' },\n { command: (cmd) => convert(cmd, 'bun'), name: 'bun' },\n ],\n}: RemarkInstallOptions = {}): Transformer<Root, Root> {\n return (tree) => {\n visit(tree, 'code', (node) => {\n if (node.lang !== 'package-install') return 'skip';\n\n const value =\n node.value.startsWith('npm') || node.value.startsWith('npx')\n ? node.value\n : `npm install ${node.value}`;\n\n const insert = createElement(\n Tabs,\n [\n ...(typeof persist === 'object'\n ? [\n {\n type: 'mdxJsxAttribute',\n name: 'groupId',\n value: persist.id,\n },\n {\n type: 'mdxJsxAttribute',\n name: 'persist',\n value: null,\n },\n ]\n : []),\n expressionToAttribute('items', {\n type: 'ArrayExpression',\n elements: packageManagers.map(({ name }) => ({\n type: 'Literal',\n value: name,\n })),\n }),\n ],\n packageManagers.map(({ command, name }) => ({\n type: 'mdxJsxFlowElement',\n name: Tab,\n attributes: [{ type: 'mdxJsxAttribute', name: 'value', value: name }],\n children: [\n {\n type: 'code',\n lang: 'bash',\n meta: node.meta,\n value: command(value),\n } satisfies Code,\n ],\n })),\n );\n\n Object.assign(node, insert);\n });\n };\n}\n","/// <reference types=\"mdast-util-mdx-jsx\" />\nimport type { Transformer } from 'unified';\nimport type { Root, RootContent } from 'mdast';\nimport { visit } from 'unist-util-visit';\n\nexport function remarkShow(options?: {\n variables?: Record<string, unknown>;\n}): Transformer<Root, Root> {\n const variables = options?.variables ?? {};\n\n return async (tree, file) => {\n const { toJs } = await import('estree-util-to-js');\n const tasks: Promise<void>[] = [];\n\n visit(tree, 'mdxJsxFlowElement', (node) => {\n if (node.name !== 'show') return;\n\n for (const attr of node.attributes) {\n if (attr.type !== 'mdxJsxAttribute' || attr.name !== 'on') continue;\n\n if (!attr.value || typeof attr.value !== 'object' || !attr.value.data?.estree)\n // skip invalid <show> components and its children\n return 'skip';\n\n const js = toJs(attr.value.data.estree);\n\n const callback = new Function(...Object.keys(variables), `return ${js.value}`)(\n ...Object.values(variables),\n );\n\n tasks.push(\n (async () => {\n const value = typeof callback === 'function' ? await callback(file) : callback;\n\n Object.assign(node, {\n type: 'mdxJsxFlowElement',\n name: null,\n attributes: [],\n children: value === true ? node.children : [],\n } satisfies RootContent);\n })(),\n );\n\n return 'skip';\n }\n });\n\n await Promise.all(tasks);\n };\n}\n"],"mappings":";;;;;;;;AA4BA,MAAM,YAAY,qCAAqB;AAEvC,SAAgB,aAAa,EAAE,aAAa,EAAE,IAAkD;AAC9F;2CAAc,MAAM,MAAS;AAC3B,cAAW,SAAS,QAAQ;;8BAAI,4EAAS,MAAM,KAAK;KAAC;GACrD,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,MAAM,GAAG,WAAW;AACvC,QAAI,KAAK,SAAS,UAAU,CAAC,KAAK,QAAQ,CAAC,OAAQ;IAEnD,MAAM,UAAU,UAAU,KAAK,KAAK,KAAK;AACzC,QAAI,CAAC,QAAS;IAEd,MAAM,OAAO,QAAQ;IACrB,MAAM,MAAM,WAAW,MAAM,MAAM,EAAE,SAAS,KAAK;IAEnD,MAAM;+CAAiC;MACrC,MAAM,yDAAe,IAAK,IAAI,KAAK,MAAM,KAAK,MAAM,EAAE;OACpD,KAAK,KAAK;OACV,MAAM,KAAK;OACX,MAAM;OACP,CAAC;MACF,MAAM,QAAQ,OAAO,SAAS,WAAW,MAAM,MAAM,KAAK;AAE1D,UAAI,UAAU,UAAU,IAAI;OAC1B,MAAM,QAAQ,MAAM,QAAQ,OAAO,GAC9B,SACD,CAAC,OAAuB;AAE5B,cAAO,SAAS,OAAO,OAAO,GAAG,GAAG,MAAM;;;;;;;AAI9C,UAAM,KAAK,KAAK,CAAC;KACjB;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAjCZ,IAAM;;;;;;;;AC5BtB,SAAgB,cAAc,MAAc,YAAsB,UAA4B;CAC5F,MAAMC,UAAmC;EACvC,MAAM;EACN;EACA;EACD;AAED,KAAI,SAAU,SAAQ,WAAW;AAEjC,QAAO;;AAGT,SAAgB,sBAAsB,KAAa,OAAoC;AACrF,QAAO;EACL,MAAM;EACN,MAAM;EACN,OAAO;GACL,MAAM;GACN,OAAO;GACP,MAAM,EACJ,QAAQ;IACN,MAAM;IACN,MAAM,CACJ;KACE,MAAM;KACN,YAAY;KACb,CACF;IACF,EACF;GACF;EACF;;;;;ACdH,MAAa,sBAAsB,EAAE,OAAO;CAC1C,MAAM,EAAE,QAAQ;CAOhB,WAAW,EACR,MAAM,CACL,EAAE,OAAO;EACP,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC5B,CAAC,EACF,EAAE,SAAS,CACZ,CAAC,CACD,QAAQ,MAAM;CAClB,CAAC;AAEF,SAAgB,cAAc,EAC5B,WAAW,OACX,OAAO,SACiB,EAAE,EAAgB;AAC1C,QAAO;EACL,MAAM;EACN,AAAM,IAAI,OAAO;yCAAK;;IACpB,MAAM,EAAE,MAAM,YAAY,UAAU,oBAAoB,MAAM,MAAM;IAEpE,MAAM,OAAO,WACT,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,KAAK,GACnD,KAAK,QAAQ,IAAI,KAAK,KAAK;IAC/B,IAAI,cAAc,GAAG,SAAS,KAAK,CAAC,MAAM,QAAQ,IAAI,UAAU,CAAC;AACjE,QAAI,KAAM,SAAQ,MAAM,MAAM;AAE9B,QAAI,cAAc,MAChB,QAAO;KACL,MAAM;KACN,UAAU,CAAC;MAAE,MAAM;MAAQ;MAAO,CAAC;KACpC;IAGH,MAAM,cAAc,cAAc,OAAO,EAAE,GAAG;AAE9C,WAAO;KACL,MAAM;KACN,2BAAM,YAAY,qEAAQ,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE;KACrD,MAAM,YAAY;KAClB;KACD;;;EAEJ;;;;;;;;;;;;;;;;;;ACxBH,SAAgB,cAAc,EAC5B,MAAM,OACN,OAAO,QACP,UAAU,OACV,kBAAkB;CAChB;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACtD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACvD,KACuB,EAAE,EAA2B;AACrD,SAAQ,SAAS;AACf,QAAM,MAAM,SAAS,SAAS;AAC5B,OAAI,KAAK,SAAS,kBAAmB,QAAO;GAE5C,MAAM,QACJ,KAAK,MAAM,WAAW,MAAM,IAAI,KAAK,MAAM,WAAW,MAAM,GACxD,KAAK,QACL,eAAe,KAAK;GAE1B,MAAM,SAAS,cACb,MACA,CACE,GAAI,OAAO,YAAY,WACnB,CACE;IACE,MAAM;IACN,MAAM;IACN,OAAO,QAAQ;IAChB,EACD;IACE,MAAM;IACN,MAAM;IACN,OAAO;IACR,CACF,GACD,EAAE,EACN,sBAAsB,SAAS;IAC7B,MAAM;IACN,UAAU,gBAAgB,KAAK,EAAE,YAAY;KAC3C,MAAM;KACN,OAAO;KACR,EAAE;IACJ,CAAC,CACH,EACD,gBAAgB,KAAK,EAAE,SAAS,YAAY;IAC1C,MAAM;IACN,MAAM;IACN,YAAY,CAAC;KAAE,MAAM;KAAmB,MAAM;KAAS,OAAO;KAAM,CAAC;IACrE,UAAU,CACR;KACE,MAAM;KACN,MAAM;KACN,MAAM,KAAK;KACX,OAAO,QAAQ,MAAM;KACtB,CACF;IACF,EAAE,CACJ;AAED,UAAO,OAAO,MAAM,OAAO;IAC3B;;;;;;ACtGN,SAAgB,WAAW,SAEC;;CAC1B,MAAM,oFAAY,QAAS,4EAAa,EAAE;AAE1C;0CAAc,MAAM,MAAS;GAC3B,MAAM,EAAE,eAAe,OAAO;GAC9B,MAAMC,QAAyB,EAAE;AAEjC,SAAM,MAAM,sBAAsB,SAAS;AACzC,QAAI,KAAK,SAAS,OAAQ;AAE1B,SAAK,MAAM,QAAQ,KAAK,YAAY;;AAClC,SAAI,KAAK,SAAS,qBAAqB,KAAK,SAAS,KAAM;AAE3D,SAAI,CAAC,KAAK,SAAS,OAAO,KAAK,UAAU,YAAY,sBAAC,KAAK,MAAM,0EAAM,QAErE,QAAO;KAET,MAAM,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO;KAEvC,MAAM,WAAW,IAAI,SAAS,GAAG,OAAO,KAAK,UAAU,EAAE,UAAU,GAAG,QAAQ,CAC5E,GAAG,OAAO,OAAO,UAAU,CAC5B;AAED,WAAM,oCACS;MACX,MAAM,QAAQ,OAAO,aAAa,mBAAmB,SAAS,KAAK,GAAG;AAEtE,aAAO,OAAO,MAAM;OAClB,MAAM;OACN,MAAM;OACN,YAAY,EAAE;OACd,UAAU,UAAU,OAAO,KAAK,WAAW,EAAE;OAC9C,CAAuB;SACtB,CACL;AAED,YAAO;;KAET;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBArCZ,IAAM"}
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/remark-docgen.ts","../src/utils.ts","../src/file-generator.ts","../src/remark-install.ts","../src/remark-show.ts"],"sourcesContent":["import { type BlockContent, type Code, type Root } from 'mdast';\nimport { type Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport type { VFile } from 'vfile';\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface DocGenerator {\n name: string;\n\n /**\n * Transform codeblocks to another mdast element\n */\n run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;\n\n onFile?: (tree: Root, file: VFile) => void;\n}\n\ninterface Context {\n node: Code;\n path: string;\n cwd: string;\n}\n\nexport interface RemarkDocGenOptions {\n generators?: DocGenerator[];\n}\n\nconst metaRegex = /doc-gen:(?<name>.+)/;\n\nexport function remarkDocGen({ generators = [] }: RemarkDocGenOptions): Transformer<Root, Root> {\n return async (tree, file) => {\n generators.forEach((gen) => gen.onFile?.(tree, file));\n const queue: Promise<void>[] = [];\n\n visit(tree, 'code', (code, _, parent) => {\n if (code.lang !== 'json' || !code.meta || !parent) return;\n\n const matches = metaRegex.exec(code.meta);\n if (!matches) return;\n\n const name = matches[1];\n const gen = generators.find((g) => g.name === name);\n\n const run = async (): Promise<void> => {\n const result = await gen?.run(JSON.parse(code.value), {\n cwd: file.cwd,\n path: file.path,\n node: code,\n });\n const index = parent.children.findIndex((c) => c === code);\n\n if (result && index !== -1) {\n const items = Array.isArray(result)\n ? (result as BlockContent[])\n : [result as BlockContent];\n\n parent.children.splice(index, 1, ...items);\n }\n };\n\n queue.push(run());\n });\n\n await Promise.all(queue);\n };\n}\n","import type { Expression, Program } from 'estree';\nimport type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';\n\nexport function createElement(name: string, attributes: object[], children?: unknown): object {\n const element: Record<string, unknown> = {\n type: 'mdxJsxFlowElement',\n name,\n attributes,\n };\n\n if (children) element.children = children;\n\n return element;\n}\n\nexport function expressionToAttribute(key: string, value: Expression): MdxJsxAttribute {\n return {\n type: 'mdxJsxAttribute',\n name: key,\n value: {\n type: 'mdxJsxAttributeValueExpression',\n value: '',\n data: {\n estree: {\n type: 'Program',\n body: [\n {\n type: 'ExpressionStatement',\n expression: value,\n },\n ],\n } as Program,\n },\n },\n };\n}\n","import * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport type { Code, Paragraph } from 'mdast';\nimport { z } from 'zod';\nimport type { DocGenerator } from './remark-docgen';\n\nexport interface FileGeneratorOptions {\n /** @defaultValue true */\n trim?: boolean;\n\n /**\n * Resolve reference files relative to `vfile.path`\n *\n * @defaultValue false\n */\n relative?: boolean;\n}\n\nexport type FileGeneratorInput = z.output<typeof fileGeneratorSchema>;\n\nexport const fileGeneratorSchema = z.object({\n file: z.string(),\n\n /**\n * Turn file content into a code block\n *\n * @defaultValue false\n */\n codeblock: z\n .union([\n z.object({\n lang: z.string().optional(),\n meta: z.string().optional(),\n }),\n z.boolean(),\n ])\n .default(false),\n});\n\nexport function fileGenerator({\n relative = false,\n trim = true,\n}: FileGeneratorOptions = {}): DocGenerator {\n return {\n name: 'file',\n async run(input, ctx) {\n const { file, codeblock = false } = fileGeneratorSchema.parse(input);\n\n const dest = relative\n ? path.resolve(ctx.cwd, path.dirname(ctx.path), file)\n : path.resolve(ctx.cwd, file);\n let value = await fs.readFile(dest).then((res) => res.toString());\n if (trim) value = value.trim();\n\n if (codeblock === false) {\n return {\n type: 'paragraph',\n children: [{ type: 'text', value }],\n } as Paragraph;\n }\n\n const codeOptions = codeblock === true ? {} : codeblock;\n\n return {\n type: 'code',\n lang: codeOptions.lang ?? path.extname(dest).slice(1),\n meta: codeOptions.meta,\n value,\n } as Code;\n },\n };\n}\n","import type { Code, Root } from 'mdast';\nimport type { Transformer } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport convert from 'npm-to-yarn';\nimport { createElement, expressionToAttribute } from './utils';\n\ninterface PackageManager {\n name: string;\n\n /**\n * Convert from npm to another package manager\n */\n command: (command: string) => string;\n}\n\nexport type RemarkInstallOptions = {\n Tabs?: string;\n Tab?: string;\n\n /**\n * Persist Tab value (Hanzo Docs UI only)\n *\n * @defaultValue false\n */\n persist?:\n | {\n id: string;\n }\n | false;\n\n packageManagers?: PackageManager[];\n};\n\n/**\n * It generates the following structure from a code block with `package-install` as language\n *\n * @example\n * ```tsx\n * <Tabs items={[\"npm\", \"pnpm\", \"yarn\", \"bun\"]}>\n * <Tab value=\"pnpm\">...</Tab>\n * ...\n * </Tabs>\n * ```\n *\n * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.\n */\nexport function remarkInstall({\n Tab = 'Tab',\n Tabs = 'Tabs',\n persist = false,\n packageManagers = [\n { command: (cmd) => convert(cmd, 'npm'), name: 'npm' },\n { command: (cmd) => convert(cmd, 'pnpm'), name: 'pnpm' },\n { command: (cmd) => convert(cmd, 'yarn'), name: 'yarn' },\n { command: (cmd) => convert(cmd, 'bun'), name: 'bun' },\n ],\n}: RemarkInstallOptions = {}): Transformer<Root, Root> {\n return (tree) => {\n visit(tree, 'code', (node) => {\n if (node.lang !== 'package-install') return 'skip';\n\n const value =\n node.value.startsWith('npm') || node.value.startsWith('npx')\n ? node.value\n : `npm install ${node.value}`;\n\n const insert = createElement(\n Tabs,\n [\n ...(typeof persist === 'object'\n ? [\n {\n type: 'mdxJsxAttribute',\n name: 'groupId',\n value: persist.id,\n },\n {\n type: 'mdxJsxAttribute',\n name: 'persist',\n value: null,\n },\n ]\n : []),\n expressionToAttribute('items', {\n type: 'ArrayExpression',\n elements: packageManagers.map(({ name }) => ({\n type: 'Literal',\n value: name,\n })),\n }),\n ],\n packageManagers.map(({ command, name }) => ({\n type: 'mdxJsxFlowElement',\n name: Tab,\n attributes: [{ type: 'mdxJsxAttribute', name: 'value', value: name }],\n children: [\n {\n type: 'code',\n lang: 'bash',\n meta: node.meta,\n value: command(value),\n } satisfies Code,\n ],\n })),\n );\n\n Object.assign(node, insert);\n });\n };\n}\n","/// <reference types=\"mdast-util-mdx-jsx\" />\nimport type { Transformer } from 'unified';\nimport type { Root, RootContent } from 'mdast';\nimport { visit } from 'unist-util-visit';\n\nexport function remarkShow(options?: {\n variables?: Record<string, unknown>;\n}): Transformer<Root, Root> {\n const variables = options?.variables ?? {};\n\n return async (tree, file) => {\n const { toJs } = await import('estree-util-to-js');\n const tasks: Promise<void>[] = [];\n\n visit(tree, 'mdxJsxFlowElement', (node) => {\n if (node.name !== 'show') return;\n\n for (const attr of node.attributes) {\n if (attr.type !== 'mdxJsxAttribute' || attr.name !== 'on') continue;\n\n if (!attr.value || typeof attr.value !== 'object' || !attr.value.data?.estree)\n // skip invalid <show> components and its children\n return 'skip';\n\n const js = toJs(attr.value.data.estree);\n\n const callback = new Function(...Object.keys(variables), `return ${js.value}`)(\n ...Object.values(variables),\n );\n\n tasks.push(\n (async () => {\n const value = typeof callback === 'function' ? await callback(file) : callback;\n\n Object.assign(node, {\n type: 'mdxJsxFlowElement',\n name: null,\n attributes: [],\n children: value === true ? node.children : [],\n } satisfies RootContent);\n })(),\n );\n\n return 'skip';\n }\n });\n\n await Promise.all(tasks);\n };\n}\n"],"mappings":";;;;;;;AA4BA,MAAM,YAAY;AAElB,SAAgB,aAAa,EAAE,aAAa,EAAE,IAAkD;AAC9F,QAAO,OAAO,MAAM,SAAS;AAC3B,aAAW,SAAS,QAAQ,IAAI,SAAS,MAAM,KAAK,CAAC;EACrD,MAAM,QAAyB,EAAE;AAEjC,QAAM,MAAM,SAAS,MAAM,GAAG,WAAW;AACvC,OAAI,KAAK,SAAS,UAAU,CAAC,KAAK,QAAQ,CAAC,OAAQ;GAEnD,MAAM,UAAU,UAAU,KAAK,KAAK,KAAK;AACzC,OAAI,CAAC,QAAS;GAEd,MAAM,OAAO,QAAQ;GACrB,MAAM,MAAM,WAAW,MAAM,MAAM,EAAE,SAAS,KAAK;GAEnD,MAAM,MAAM,YAA2B;IACrC,MAAM,SAAS,MAAM,KAAK,IAAI,KAAK,MAAM,KAAK,MAAM,EAAE;KACpD,KAAK,KAAK;KACV,MAAM,KAAK;KACX,MAAM;KACP,CAAC;IACF,MAAM,QAAQ,OAAO,SAAS,WAAW,MAAM,MAAM,KAAK;AAE1D,QAAI,UAAU,UAAU,IAAI;KAC1B,MAAM,QAAQ,MAAM,QAAQ,OAAO,GAC9B,SACD,CAAC,OAAuB;AAE5B,YAAO,SAAS,OAAO,OAAO,GAAG,GAAG,MAAM;;;AAI9C,SAAM,KAAK,KAAK,CAAC;IACjB;AAEF,QAAM,QAAQ,IAAI,MAAM;;;;;;AC7D5B,SAAgB,cAAc,MAAc,YAAsB,UAA4B;CAC5F,MAAM,UAAmC;EACvC,MAAM;EACN;EACA;EACD;AAED,KAAI,SAAU,SAAQ,WAAW;AAEjC,QAAO;;AAGT,SAAgB,sBAAsB,KAAa,OAAoC;AACrF,QAAO;EACL,MAAM;EACN,MAAM;EACN,OAAO;GACL,MAAM;GACN,OAAO;GACP,MAAM,EACJ,QAAQ;IACN,MAAM;IACN,MAAM,CACJ;KACE,MAAM;KACN,YAAY;KACb,CACF;IACF,EACF;GACF;EACF;;;;;ACdH,MAAa,sBAAsB,EAAE,OAAO;CAC1C,MAAM,EAAE,QAAQ;CAOhB,WAAW,EACR,MAAM,CACL,EAAE,OAAO;EACP,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC5B,CAAC,EACF,EAAE,SAAS,CACZ,CAAC,CACD,QAAQ,MAAM;CAClB,CAAC;AAEF,SAAgB,cAAc,EAC5B,WAAW,OACX,OAAO,SACiB,EAAE,EAAgB;AAC1C,QAAO;EACL,MAAM;EACN,MAAM,IAAI,OAAO,KAAK;GACpB,MAAM,EAAE,MAAM,YAAY,UAAU,oBAAoB,MAAM,MAAM;GAEpE,MAAM,OAAO,WACT,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,KAAK,GACnD,KAAK,QAAQ,IAAI,KAAK,KAAK;GAC/B,IAAI,QAAQ,MAAM,GAAG,SAAS,KAAK,CAAC,MAAM,QAAQ,IAAI,UAAU,CAAC;AACjE,OAAI,KAAM,SAAQ,MAAM,MAAM;AAE9B,OAAI,cAAc,MAChB,QAAO;IACL,MAAM;IACN,UAAU,CAAC;KAAE,MAAM;KAAQ;KAAO,CAAC;IACpC;GAGH,MAAM,cAAc,cAAc,OAAO,EAAE,GAAG;AAE9C,UAAO;IACL,MAAM;IACN,MAAM,YAAY,QAAQ,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE;IACrD,MAAM,YAAY;IAClB;IACD;;EAEJ;;;;;;;;;;;;;;;;;;ACxBH,SAAgB,cAAc,EAC5B,MAAM,OACN,OAAO,QACP,UAAU,OACV,kBAAkB;CAChB;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACtD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,OAAO;EAAE,MAAM;EAAQ;CACxD;EAAE,UAAU,QAAQ,QAAQ,KAAK,MAAM;EAAE,MAAM;EAAO;CACvD,KACuB,EAAE,EAA2B;AACrD,SAAQ,SAAS;AACf,QAAM,MAAM,SAAS,SAAS;AAC5B,OAAI,KAAK,SAAS,kBAAmB,QAAO;GAE5C,MAAM,QACJ,KAAK,MAAM,WAAW,MAAM,IAAI,KAAK,MAAM,WAAW,MAAM,GACxD,KAAK,QACL,eAAe,KAAK;GAE1B,MAAM,SAAS,cACb,MACA,CACE,GAAI,OAAO,YAAY,WACnB,CACE;IACE,MAAM;IACN,MAAM;IACN,OAAO,QAAQ;IAChB,EACD;IACE,MAAM;IACN,MAAM;IACN,OAAO;IACR,CACF,GACD,EAAE,EACN,sBAAsB,SAAS;IAC7B,MAAM;IACN,UAAU,gBAAgB,KAAK,EAAE,YAAY;KAC3C,MAAM;KACN,OAAO;KACR,EAAE;IACJ,CAAC,CACH,EACD,gBAAgB,KAAK,EAAE,SAAS,YAAY;IAC1C,MAAM;IACN,MAAM;IACN,YAAY,CAAC;KAAE,MAAM;KAAmB,MAAM;KAAS,OAAO;KAAM,CAAC;IACrE,UAAU,CACR;KACE,MAAM;KACN,MAAM;KACN,MAAM,KAAK;KACX,OAAO,QAAQ,MAAM;KACtB,CACF;IACF,EAAE,CACJ;AAED,UAAO,OAAO,MAAM,OAAO;IAC3B;;;;;;ACtGN,SAAgB,WAAW,SAEC;CAC1B,MAAM,YAAY,SAAS,aAAa,EAAE;AAE1C,QAAO,OAAO,MAAM,SAAS;EAC3B,MAAM,EAAE,SAAS,MAAM,OAAO;EAC9B,MAAM,QAAyB,EAAE;AAEjC,QAAM,MAAM,sBAAsB,SAAS;AACzC,OAAI,KAAK,SAAS,OAAQ;AAE1B,QAAK,MAAM,QAAQ,KAAK,YAAY;AAClC,QAAI,KAAK,SAAS,qBAAqB,KAAK,SAAS,KAAM;AAE3D,QAAI,CAAC,KAAK,SAAS,OAAO,KAAK,UAAU,YAAY,CAAC,KAAK,MAAM,MAAM,OAErE,QAAO;IAET,MAAM,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO;IAEvC,MAAM,WAAW,IAAI,SAAS,GAAG,OAAO,KAAK,UAAU,EAAE,UAAU,GAAG,QAAQ,CAC5E,GAAG,OAAO,OAAO,UAAU,CAC5B;AAED,UAAM,MACH,YAAY;KACX,MAAM,QAAQ,OAAO,aAAa,aAAa,MAAM,SAAS,KAAK,GAAG;AAEtE,YAAO,OAAO,MAAM;MAClB,MAAM;MACN,MAAM;MACN,YAAY,EAAE;MACd,UAAU,UAAU,OAAO,KAAK,WAAW,EAAE;MAC9C,CAAuB;QACtB,CACL;AAED,WAAO;;IAET;AAEF,QAAM,QAAQ,IAAI,MAAM"}
|
package/dist/remark-ts2js.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"remark-ts2js.d.ts","names":[],"sources":["../src/remark-ts2js.ts"],"
|
|
1
|
+
{"version":3,"file":"remark-ts2js.d.ts","names":[],"sources":["../src/remark-ts2js.ts"],"mappings":";;;;UAQiB,6BAAA;;AAAjB;;;;EAME,OAAA;IAEM,EAAA;EAAA;EAIN,YAAA;EAKc;;AAiBhB;EAjBE,cAAA;AAAA;;;;;;;;;;;;;;;iBAiBc,4BAAA,CAAA;EACd,OAAA;EACA,YAAA;EACA;AAAA,IACC,6BAAA,GAAqC,WAAA,CAAY,IAAA"}
|
package/dist/remark-ts2js.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { t as _asyncToGenerator } from "./asyncToGenerator-Ux3KppAy.js";
|
|
2
1
|
import { visit } from "unist-util-visit";
|
|
3
2
|
import { generateCodeBlockTabs, parseCodeBlockAttributes } from "@hanzo/docs-core/mdx-plugins/codeblock-utils";
|
|
4
3
|
|
|
@@ -18,66 +17,59 @@ import { generateCodeBlockTabs, parseCodeBlockAttributes } from "@hanzo/docs-cor
|
|
|
18
17
|
* ````
|
|
19
18
|
*/
|
|
20
19
|
function remarkTypeScriptToJavaScript({ persist = false, defaultValue = "ts", disableTrigger = false } = {}) {
|
|
21
|
-
return
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
value: "
|
|
42
|
-
children: [{
|
|
43
|
-
type: "text",
|
|
44
|
-
value: "TypeScript"
|
|
45
|
-
}]
|
|
46
|
-
}, {
|
|
47
|
-
value: "js",
|
|
48
|
-
children: [{
|
|
49
|
-
type: "text",
|
|
50
|
-
value: "JavaScript"
|
|
51
|
-
}]
|
|
52
|
-
}],
|
|
53
|
-
tabs: [{
|
|
54
|
-
value: "ts",
|
|
55
|
-
children: [{
|
|
56
|
-
type: "code",
|
|
57
|
-
lang: node.lang,
|
|
58
|
-
meta: meta.rest,
|
|
59
|
-
value: node.value
|
|
60
|
-
}]
|
|
61
|
-
}, {
|
|
62
|
-
value: "js",
|
|
63
|
-
children: [{
|
|
64
|
-
type: "code",
|
|
65
|
-
lang: lang === "tsx" ? "jsx" : "js",
|
|
66
|
-
meta: (_meta$attributes$ts2j = meta.attributes.ts2js) !== null && _meta$attributes$ts2j !== void 0 ? _meta$attributes$ts2j : meta.rest,
|
|
67
|
-
value: result.code
|
|
68
|
-
}]
|
|
20
|
+
return async (tree, file) => {
|
|
21
|
+
const oxc = await import("oxc-transform");
|
|
22
|
+
const tasks = [];
|
|
23
|
+
visit(tree, "code", (node) => {
|
|
24
|
+
const lang = node.lang;
|
|
25
|
+
if (lang !== "ts" && lang !== "tsx") return;
|
|
26
|
+
const meta = parseCodeBlockAttributes(node.meta ?? "", ["ts2js"]);
|
|
27
|
+
if (!disableTrigger && !("ts2js" in meta.attributes)) return;
|
|
28
|
+
tasks.push((async () => {
|
|
29
|
+
const result = await oxc.transform(`${file.path ?? "test"}.${lang}`, node.value, {
|
|
30
|
+
sourcemap: false,
|
|
31
|
+
jsx: "preserve"
|
|
32
|
+
});
|
|
33
|
+
const replacement = generateCodeBlockTabs({
|
|
34
|
+
persist,
|
|
35
|
+
defaultValue,
|
|
36
|
+
triggers: [{
|
|
37
|
+
value: "ts",
|
|
38
|
+
children: [{
|
|
39
|
+
type: "text",
|
|
40
|
+
value: "TypeScript"
|
|
69
41
|
}]
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
42
|
+
}, {
|
|
43
|
+
value: "js",
|
|
44
|
+
children: [{
|
|
45
|
+
type: "text",
|
|
46
|
+
value: "JavaScript"
|
|
47
|
+
}]
|
|
48
|
+
}],
|
|
49
|
+
tabs: [{
|
|
50
|
+
value: "ts",
|
|
51
|
+
children: [{
|
|
52
|
+
type: "code",
|
|
53
|
+
lang: node.lang,
|
|
54
|
+
meta: meta.rest,
|
|
55
|
+
value: node.value
|
|
56
|
+
}]
|
|
57
|
+
}, {
|
|
58
|
+
value: "js",
|
|
59
|
+
children: [{
|
|
60
|
+
type: "code",
|
|
61
|
+
lang: lang === "tsx" ? "jsx" : "js",
|
|
62
|
+
meta: meta.attributes.ts2js ?? meta.rest,
|
|
63
|
+
value: result.code
|
|
64
|
+
}]
|
|
65
|
+
}]
|
|
66
|
+
});
|
|
67
|
+
Object.assign(node, replacement);
|
|
68
|
+
})());
|
|
69
|
+
return "skip";
|
|
76
70
|
});
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
};
|
|
80
|
-
}();
|
|
71
|
+
await Promise.all(tasks);
|
|
72
|
+
};
|
|
81
73
|
}
|
|
82
74
|
|
|
83
75
|
//#endregion
|
package/dist/remark-ts2js.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"remark-ts2js.js","names":[
|
|
1
|
+
{"version":3,"file":"remark-ts2js.js","names":[],"sources":["../src/remark-ts2js.ts"],"sourcesContent":["import type { Transformer } from 'unified';\nimport type { Root } from 'mdast';\nimport { visit } from 'unist-util-visit';\nimport {\n generateCodeBlockTabs,\n parseCodeBlockAttributes,\n} from '@hanzo/docs-core/mdx-plugins/codeblock-utils';\n\nexport interface TypeScriptToJavaScriptOptions {\n /**\n * Persist Tab value (Hanzo Docs UI only)\n *\n * @defaultValue false\n */\n persist?:\n | {\n id: string;\n }\n | false;\n\n defaultValue?: 'js' | 'ts';\n\n /**\n * Transform all TypeScript codeblocks by default, without a trigger\n */\n disableTrigger?: boolean;\n}\n\n/**\n * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.\n *\n * Add `ts2js` to enable transformation:\n * ````md\n * ```tsx ts2js\n * import { ReactNode } from \"react\";\n *\n * export default function Layout({ children }: { children: ReactNode }) {\n * return <div>{children}</div>\n * }\n * ```\n * ````\n */\nexport function remarkTypeScriptToJavaScript({\n persist = false,\n defaultValue = 'ts',\n disableTrigger = false,\n}: TypeScriptToJavaScriptOptions = {}): Transformer<Root> {\n return async (tree, file) => {\n const oxc = await import('oxc-transform');\n const tasks: Promise<void>[] = [];\n\n visit(tree, 'code', (node) => {\n const lang = node.lang;\n if (lang !== 'ts' && lang !== 'tsx') return;\n\n const meta = parseCodeBlockAttributes(node.meta ?? '', ['ts2js']);\n if (!disableTrigger && !('ts2js' in meta.attributes)) return;\n\n tasks.push(\n (async () => {\n const result = await oxc.transform(`${file.path ?? 'test'}.${lang}`, node.value, {\n sourcemap: false,\n jsx: 'preserve',\n });\n\n const replacement = generateCodeBlockTabs({\n persist,\n defaultValue,\n triggers: [\n {\n value: 'ts',\n children: [{ type: 'text', value: 'TypeScript' }],\n },\n {\n value: 'js',\n children: [{ type: 'text', value: 'JavaScript' }],\n },\n ],\n tabs: [\n {\n value: 'ts',\n children: [\n {\n type: 'code',\n lang: node.lang,\n meta: meta.rest,\n value: node.value,\n },\n ],\n },\n {\n value: 'js',\n children: [\n {\n type: 'code',\n lang: lang === 'tsx' ? 'jsx' : 'js',\n meta: meta.attributes.ts2js ?? meta.rest,\n value: result.code,\n },\n ],\n },\n ],\n });\n\n Object.assign(node, replacement);\n })(),\n );\n\n return 'skip';\n });\n\n await Promise.all(tasks);\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA0CA,SAAgB,6BAA6B,EAC3C,UAAU,OACV,eAAe,MACf,iBAAiB,UACgB,EAAE,EAAqB;AACxD,QAAO,OAAO,MAAM,SAAS;EAC3B,MAAM,MAAM,MAAM,OAAO;EACzB,MAAM,QAAyB,EAAE;AAEjC,QAAM,MAAM,SAAS,SAAS;GAC5B,MAAM,OAAO,KAAK;AAClB,OAAI,SAAS,QAAQ,SAAS,MAAO;GAErC,MAAM,OAAO,yBAAyB,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC;AACjE,OAAI,CAAC,kBAAkB,EAAE,WAAW,KAAK,YAAa;AAEtD,SAAM,MACH,YAAY;IACX,MAAM,SAAS,MAAM,IAAI,UAAU,GAAG,KAAK,QAAQ,OAAO,GAAG,QAAQ,KAAK,OAAO;KAC/E,WAAW;KACX,KAAK;KACN,CAAC;IAEF,MAAM,cAAc,sBAAsB;KACxC;KACA;KACA,UAAU,CACR;MACE,OAAO;MACP,UAAU,CAAC;OAAE,MAAM;OAAQ,OAAO;OAAc,CAAC;MAClD,EACD;MACE,OAAO;MACP,UAAU,CAAC;OAAE,MAAM;OAAQ,OAAO;OAAc,CAAC;MAClD,CACF;KACD,MAAM,CACJ;MACE,OAAO;MACP,UAAU,CACR;OACE,MAAM;OACN,MAAM,KAAK;OACX,MAAM,KAAK;OACX,OAAO,KAAK;OACb,CACF;MACF,EACD;MACE,OAAO;MACP,UAAU,CACR;OACE,MAAM;OACN,MAAM,SAAS,QAAQ,QAAQ;OAC/B,MAAM,KAAK,WAAW,SAAS,KAAK;OACpC,OAAO,OAAO;OACf,CACF;MACF,CACF;KACF,CAAC;AAEF,WAAO,OAAO,MAAM,YAAY;OAC9B,CACL;AAED,UAAO;IACP;AAEF,QAAM,QAAQ,IAAI,MAAM"}
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hanzo/docs-docgen",
|
|
3
|
-
"version": "3.0.
|
|
4
|
-
"description": "Useful remark utilities and plugins
|
|
3
|
+
"version": "3.0.7",
|
|
4
|
+
"description": "Useful remark utilities and plugins",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Docs",
|
|
7
7
|
"hanzo-docs",
|
|
8
8
|
"mdx",
|
|
9
9
|
"remark"
|
|
10
10
|
],
|
|
11
|
-
"homepage": "https://
|
|
11
|
+
"homepage": "https://hanzoai.github.io/docs",
|
|
12
12
|
"license": "MIT",
|
|
13
|
-
"author": "
|
|
13
|
+
"author": "Hanzo AI",
|
|
14
14
|
"repository": "github:hanzoai/docs",
|
|
15
15
|
"files": [
|
|
16
16
|
"dist/*"
|
|
@@ -35,28 +35,46 @@
|
|
|
35
35
|
"estree-util-to-js": "^2.0.0",
|
|
36
36
|
"estree-util-value-to-estree": "^3.5.0",
|
|
37
37
|
"npm-to-yarn": "^3.0.1",
|
|
38
|
-
"oxc-transform": "^0.
|
|
39
|
-
"
|
|
40
|
-
"
|
|
38
|
+
"oxc-transform": "^0.112.0",
|
|
39
|
+
"unified": "^11.0.5",
|
|
40
|
+
"unist-util-visit": "^5.1.0",
|
|
41
|
+
"vfile": "^6.0.3",
|
|
42
|
+
"zod": "^4.3.6"
|
|
41
43
|
},
|
|
42
44
|
"devDependencies": {
|
|
43
45
|
"@mdx-js/mdx": "^3.1.1",
|
|
44
46
|
"@types/estree": "^1.0.8",
|
|
45
47
|
"@types/hast": "^3.0.4",
|
|
46
48
|
"@types/mdast": "^4.0.4",
|
|
47
|
-
"@types/node": "
|
|
49
|
+
"@types/node": "25.2.1",
|
|
48
50
|
"mdast-util-mdx-jsx": "^3.2.0",
|
|
49
51
|
"remark": "^15.0.1",
|
|
50
|
-
"tsdown": "^0.
|
|
52
|
+
"tsdown": "^0.20.3",
|
|
51
53
|
"typescript": "^5.9.3",
|
|
52
|
-
"unified": "^11.0.5",
|
|
53
|
-
"vfile": "^6.0.3",
|
|
54
54
|
"eslint-config-custom": "0.0.0",
|
|
55
|
-
"
|
|
56
|
-
"
|
|
55
|
+
"@hanzo/docs-core": "16.5.3",
|
|
56
|
+
"tsconfig": "0.0.0"
|
|
57
57
|
},
|
|
58
58
|
"peerDependencies": {
|
|
59
|
-
"@
|
|
59
|
+
"@types/estree": "*",
|
|
60
|
+
"@types/hast": "*",
|
|
61
|
+
"@types/mdast": "*",
|
|
62
|
+
"@hanzo/docs-core": "^15.7.2 || ^16.0.0",
|
|
63
|
+
"mdast-util-mdx-jsx": "*"
|
|
64
|
+
},
|
|
65
|
+
"peerDependenciesMeta": {
|
|
66
|
+
"mdast-util-mdx-jsx": {
|
|
67
|
+
"optional": true
|
|
68
|
+
},
|
|
69
|
+
"@types/hast": {
|
|
70
|
+
"optional": true
|
|
71
|
+
},
|
|
72
|
+
"@types/mdast": {
|
|
73
|
+
"optional": true
|
|
74
|
+
},
|
|
75
|
+
"@types/estree": {
|
|
76
|
+
"optional": true
|
|
77
|
+
}
|
|
60
78
|
},
|
|
61
79
|
"scripts": {
|
|
62
80
|
"build": "tsdown",
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
//#region \0@oxc-project+runtime@0.103.0/helpers/asyncToGenerator.js
|
|
2
|
-
function asyncGeneratorStep(n, t, e, r, o, a, c) {
|
|
3
|
-
try {
|
|
4
|
-
var i = n[a](c), u = i.value;
|
|
5
|
-
} catch (n$1) {
|
|
6
|
-
e(n$1);
|
|
7
|
-
return;
|
|
8
|
-
}
|
|
9
|
-
i.done ? t(u) : Promise.resolve(u).then(r, o);
|
|
10
|
-
}
|
|
11
|
-
function _asyncToGenerator(n) {
|
|
12
|
-
return function() {
|
|
13
|
-
var t = this, e = arguments;
|
|
14
|
-
return new Promise(function(r, o) {
|
|
15
|
-
var a = n.apply(t, e);
|
|
16
|
-
function _next(n$1) {
|
|
17
|
-
asyncGeneratorStep(a, r, o, _next, _throw, "next", n$1);
|
|
18
|
-
}
|
|
19
|
-
function _throw(n$1) {
|
|
20
|
-
asyncGeneratorStep(a, r, o, _next, _throw, "throw", n$1);
|
|
21
|
-
}
|
|
22
|
-
_next(void 0);
|
|
23
|
-
});
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
//#endregion
|
|
28
|
-
export { _asyncToGenerator as t };
|