@hanzo/docs-docgen 3.0.4 → 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 CHANGED
@@ -1,3 +1,3 @@
1
- # Fumadocs Doc Gen
1
+ # Hanzo Docs Doc Gen
2
2
 
3
3
  Remark plugins & Docs Generator utilities.
package/dist/index.d.ts CHANGED
@@ -1,71 +1,80 @@
1
- import { Code, Root } from 'mdast';
2
- import { Transformer } from 'unified';
3
- import { VFile } from 'vfile';
4
- import { Expression } from 'estree';
5
- import { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
6
- import { z } from 'zod';
1
+ import { z } from "zod";
2
+ import { Code, Root } from "mdast";
3
+ import { Transformer } from "unified";
4
+ import { VFile } from "vfile";
5
+ import { Expression } from "estree";
6
+ import { MdxJsxAttribute } from "mdast-util-mdx-jsx";
7
7
 
8
+ //#region src/remark-docgen.d.ts
8
9
  type Awaitable<T> = T | Promise<T>;
9
10
  interface DocGenerator {
10
- name: string;
11
- /**
12
- * Transform codeblocks to another mdast element
13
- */
14
- run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;
15
- onFile?: (tree: Root, file: VFile) => void;
11
+ name: string;
12
+ /**
13
+ * Transform codeblocks to another mdast element
14
+ */
15
+ run: (input: unknown, context: Context) => Awaitable<object | object[] | undefined>;
16
+ onFile?: (tree: Root, file: VFile) => void;
16
17
  }
17
18
  interface Context {
18
- node: Code;
19
- path: string;
20
- cwd: string;
19
+ node: Code;
20
+ path: string;
21
+ cwd: string;
21
22
  }
22
23
  interface RemarkDocGenOptions {
23
- generators?: DocGenerator[];
24
+ generators?: DocGenerator[];
24
25
  }
25
- declare function remarkDocGen({ generators, }: RemarkDocGenOptions): Transformer<Root, Root>;
26
-
26
+ declare function remarkDocGen({
27
+ generators
28
+ }: RemarkDocGenOptions): Transformer<Root, Root>;
29
+ //#endregion
30
+ //#region src/utils.d.ts
27
31
  declare function createElement(name: string, attributes: object[], children?: unknown): object;
28
32
  declare function expressionToAttribute(key: string, value: Expression): MdxJsxAttribute;
29
-
33
+ //#endregion
34
+ //#region src/file-generator.d.ts
30
35
  interface FileGeneratorOptions {
31
- /** @defaultValue true */
32
- trim?: boolean;
33
- /**
34
- * Resolve reference files relative to `vfile.path`
35
- *
36
- * @defaultValue false
37
- */
38
- relative?: boolean;
36
+ /** @defaultValue true */
37
+ trim?: boolean;
38
+ /**
39
+ * Resolve reference files relative to `vfile.path`
40
+ *
41
+ * @defaultValue false
42
+ */
43
+ relative?: boolean;
39
44
  }
40
45
  type FileGeneratorInput = z.output<typeof fileGeneratorSchema>;
41
46
  declare const fileGeneratorSchema: z.ZodObject<{
42
- file: z.ZodString;
43
- codeblock: z.ZodDefault<z.ZodUnion<readonly [z.ZodObject<{
44
- lang: z.ZodOptional<z.ZodString>;
45
- meta: z.ZodOptional<z.ZodString>;
46
- }, z.core.$strip>, z.ZodBoolean]>>;
47
+ file: z.ZodString;
48
+ codeblock: z.ZodDefault<z.ZodUnion<readonly [z.ZodObject<{
49
+ lang: z.ZodOptional<z.ZodString>;
50
+ meta: z.ZodOptional<z.ZodString>;
51
+ }, z.core.$strip>, z.ZodBoolean]>>;
47
52
  }, z.core.$strip>;
48
- declare function fileGenerator({ relative, trim, }?: FileGeneratorOptions): DocGenerator;
49
-
53
+ declare function fileGenerator({
54
+ relative,
55
+ trim
56
+ }?: FileGeneratorOptions): DocGenerator;
57
+ //#endregion
58
+ //#region src/remark-install.d.ts
50
59
  interface PackageManager {
51
- name: string;
52
- /**
53
- * Convert from npm to another package manager
54
- */
55
- command: (command: string) => string;
60
+ name: string;
61
+ /**
62
+ * Convert from npm to another package manager
63
+ */
64
+ command: (command: string) => string;
56
65
  }
57
66
  type RemarkInstallOptions = {
58
- Tabs?: string;
59
- Tab?: string;
60
- /**
61
- * Persist Tab value (Fumadocs UI only)
62
- *
63
- * @defaultValue false
64
- */
65
- persist?: {
66
- id: string;
67
- } | false;
68
- packageManagers?: PackageManager[];
67
+ Tabs?: string;
68
+ Tab?: string;
69
+ /**
70
+ * Persist Tab value (Hanzo Docs UI only)
71
+ *
72
+ * @defaultValue false
73
+ */
74
+ persist?: {
75
+ id: string;
76
+ } | false;
77
+ packageManagers?: PackageManager[];
69
78
  };
70
79
  /**
71
80
  * It generates the following structure from a code block with `package-install` as language
@@ -80,10 +89,17 @@ type RemarkInstallOptions = {
80
89
  *
81
90
  * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.
82
91
  */
83
- declare function remarkInstall({ Tab, Tabs, persist, packageManagers, }?: RemarkInstallOptions): Transformer<Root, Root>;
84
-
92
+ declare function remarkInstall({
93
+ Tab,
94
+ Tabs,
95
+ persist,
96
+ packageManagers
97
+ }?: RemarkInstallOptions): Transformer<Root, Root>;
98
+ //#endregion
99
+ //#region src/remark-show.d.ts
85
100
  declare function remarkShow(options?: {
86
- variables?: Record<string, unknown>;
101
+ variables?: Record<string, unknown>;
87
102
  }): Transformer<Root, Root>;
88
-
89
- export { type DocGenerator, type FileGeneratorInput, type FileGeneratorOptions, type RemarkDocGenOptions, type RemarkInstallOptions, createElement, expressionToAttribute, fileGenerator, fileGeneratorSchema, remarkDocGen, remarkInstall, remarkShow };
103
+ //#endregion
104
+ export { DocGenerator, FileGeneratorInput, FileGeneratorOptions, RemarkDocGenOptions, RemarkInstallOptions, createElement, expressionToAttribute, fileGenerator, fileGeneratorSchema, remarkDocGen, remarkInstall, remarkShow };
105
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +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"],"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,228 +1,204 @@
1
- import {
2
- __async
3
- } from "./chunk-4AFQP74Z.js";
4
-
5
- // src/remark-docgen.ts
6
1
  import { visit } from "unist-util-visit";
7
- var metaRegex = new RegExp("doc-gen:(?<name>.+)");
8
- function remarkDocGen({
9
- generators = []
10
- }) {
11
- return (tree, file) => __async(null, null, function* () {
12
- generators.forEach((gen) => {
13
- var _a;
14
- return (_a = gen.onFile) == null ? void 0 : _a.call(gen, tree, file);
15
- });
16
- const queue = [];
17
- visit(tree, "code", (code, _, parent) => {
18
- if (code.lang !== "json" || !code.meta || !parent) return;
19
- const matches = metaRegex.exec(code.meta);
20
- if (!matches) return;
21
- const name = matches[1];
22
- const gen = generators.find((g) => g.name === name);
23
- const run = () => __async(null, null, function* () {
24
- const result = yield gen == null ? void 0 : gen.run(JSON.parse(code.value), {
25
- cwd: file.cwd,
26
- path: file.path,
27
- node: code
28
- });
29
- const index = parent.children.findIndex((c) => c === code);
30
- if (result && index !== -1) {
31
- const items = Array.isArray(result) ? result : [result];
32
- parent.children.splice(index, 1, ...items);
33
- }
34
- });
35
- queue.push(run());
36
- });
37
- yield Promise.all(queue);
38
- });
2
+ import * as fs from "node:fs/promises";
3
+ import * as path from "node:path";
4
+ import { z } from "zod";
5
+ import convert from "npm-to-yarn";
6
+
7
+ //#region src/remark-docgen.ts
8
+ const metaRegex = /doc-gen:(?<name>.+)/;
9
+ function remarkDocGen({ generators = [] }) {
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());
32
+ });
33
+ await Promise.all(queue);
34
+ };
39
35
  }
40
36
 
41
- // src/utils.ts
37
+ //#endregion
38
+ //#region src/utils.ts
42
39
  function createElement(name, attributes, children) {
43
- const element = {
44
- type: "mdxJsxFlowElement",
45
- name,
46
- attributes
47
- };
48
- if (children) element.children = children;
49
- return element;
40
+ const element = {
41
+ type: "mdxJsxFlowElement",
42
+ name,
43
+ attributes
44
+ };
45
+ if (children) element.children = children;
46
+ return element;
50
47
  }
51
48
  function expressionToAttribute(key, value) {
52
- return {
53
- type: "mdxJsxAttribute",
54
- name: key,
55
- value: {
56
- type: "mdxJsxAttributeValueExpression",
57
- value: "",
58
- data: {
59
- estree: {
60
- type: "Program",
61
- body: [
62
- {
63
- type: "ExpressionStatement",
64
- expression: value
65
- }
66
- ]
67
- }
68
- }
69
- }
70
- };
49
+ return {
50
+ type: "mdxJsxAttribute",
51
+ name: key,
52
+ value: {
53
+ type: "mdxJsxAttributeValueExpression",
54
+ value: "",
55
+ data: { estree: {
56
+ type: "Program",
57
+ body: [{
58
+ type: "ExpressionStatement",
59
+ expression: value
60
+ }]
61
+ } }
62
+ }
63
+ };
71
64
  }
72
65
 
73
- // src/file-generator.ts
74
- import * as fs from "fs/promises";
75
- import * as path from "path";
76
- import { z } from "zod";
77
- var fileGeneratorSchema = z.object({
78
- file: z.string(),
79
- /**
80
- * Turn file content into a code block
81
- *
82
- * @defaultValue false
83
- */
84
- codeblock: z.union([
85
- z.object({
86
- lang: z.string().optional(),
87
- meta: z.string().optional()
88
- }),
89
- z.boolean()
90
- ]).default(false)
66
+ //#endregion
67
+ //#region src/file-generator.ts
68
+ const fileGeneratorSchema = z.object({
69
+ file: z.string(),
70
+ codeblock: z.union([z.object({
71
+ lang: z.string().optional(),
72
+ meta: z.string().optional()
73
+ }), z.boolean()]).default(false)
91
74
  });
92
- function fileGenerator({
93
- relative = false,
94
- trim = true
95
- } = {}) {
96
- return {
97
- name: "file",
98
- run(input, ctx) {
99
- return __async(this, null, function* () {
100
- var _a2;
101
- const { file, codeblock = false } = fileGeneratorSchema.parse(input);
102
- const dest = relative ? path.resolve(ctx.cwd, path.dirname(ctx.path), file) : path.resolve(ctx.cwd, file);
103
- let value = yield fs.readFile(dest).then((res) => res.toString());
104
- if (trim) value = value.trim();
105
- if (codeblock === false) {
106
- return {
107
- type: "paragraph",
108
- children: [{ type: "text", value }]
109
- };
110
- }
111
- const codeOptions = codeblock === true ? {} : codeblock;
112
- return {
113
- type: "code",
114
- lang: (_a2 = codeOptions.lang) != null ? _a2 : path.extname(dest).slice(1),
115
- meta: codeOptions.meta,
116
- value
117
- };
118
- });
119
- }
120
- };
75
+ function fileGenerator({ relative = false, trim = true } = {}) {
76
+ return {
77
+ name: "file",
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",
87
+ value
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
+ };
97
+ }
98
+ };
121
99
  }
122
100
 
123
- // src/remark-install.ts
124
- import { visit as visit2 } from "unist-util-visit";
125
- import convert from "npm-to-yarn";
126
- function remarkInstall({
127
- Tab = "Tab",
128
- Tabs = "Tabs",
129
- persist = false,
130
- packageManagers = [
131
- { command: (cmd) => convert(cmd, "npm"), name: "npm" },
132
- { command: (cmd) => convert(cmd, "pnpm"), name: "pnpm" },
133
- { command: (cmd) => convert(cmd, "yarn"), name: "yarn" },
134
- { command: (cmd) => convert(cmd, "bun"), name: "bun" }
135
- ]
136
- } = {}) {
137
- return (tree) => {
138
- visit2(tree, "code", (node) => {
139
- if (node.lang !== "package-install") return "skip";
140
- const value = node.value.startsWith("npm") || node.value.startsWith("npx") ? node.value : `npm install ${node.value}`;
141
- const insert = createElement(
142
- Tabs,
143
- [
144
- ...typeof persist === "object" ? [
145
- {
146
- type: "mdxJsxAttribute",
147
- name: "groupId",
148
- value: persist.id
149
- },
150
- {
151
- type: "mdxJsxAttribute",
152
- name: "persist",
153
- value: null
154
- }
155
- ] : [],
156
- expressionToAttribute("items", {
157
- type: "ArrayExpression",
158
- elements: packageManagers.map(({ name }) => ({
159
- type: "Literal",
160
- value: name
161
- }))
162
- })
163
- ],
164
- packageManagers.map(({ command, name }) => ({
165
- type: "mdxJsxFlowElement",
166
- name: Tab,
167
- attributes: [{ type: "mdxJsxAttribute", name: "value", value: name }],
168
- children: [
169
- {
170
- type: "code",
171
- lang: "bash",
172
- meta: node.meta,
173
- value: command(value)
174
- }
175
- ]
176
- }))
177
- );
178
- Object.assign(node, insert);
179
- });
180
- };
101
+ //#endregion
102
+ //#region src/remark-install.ts
103
+ /**
104
+ * It generates the following structure from a code block with `package-install` as language
105
+ *
106
+ * @example
107
+ * ```tsx
108
+ * <Tabs items={["npm", "pnpm", "yarn", "bun"]}>
109
+ * <Tab value="pnpm">...</Tab>
110
+ * ...
111
+ * </Tabs>
112
+ * ```
113
+ *
114
+ * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.
115
+ */
116
+ function remarkInstall({ Tab = "Tab", Tabs = "Tabs", persist = false, packageManagers = [
117
+ {
118
+ command: (cmd) => convert(cmd, "npm"),
119
+ name: "npm"
120
+ },
121
+ {
122
+ command: (cmd) => convert(cmd, "pnpm"),
123
+ name: "pnpm"
124
+ },
125
+ {
126
+ command: (cmd) => convert(cmd, "yarn"),
127
+ name: "yarn"
128
+ },
129
+ {
130
+ command: (cmd) => convert(cmd, "bun"),
131
+ name: "bun"
132
+ }
133
+ ] } = {}) {
134
+ return (tree) => {
135
+ visit(tree, "code", (node) => {
136
+ if (node.lang !== "package-install") return "skip";
137
+ const value = node.value.startsWith("npm") || node.value.startsWith("npx") ? node.value : `npm install ${node.value}`;
138
+ const insert = createElement(Tabs, [...typeof persist === "object" ? [{
139
+ type: "mdxJsxAttribute",
140
+ name: "groupId",
141
+ value: persist.id
142
+ }, {
143
+ type: "mdxJsxAttribute",
144
+ name: "persist",
145
+ value: null
146
+ }] : [], expressionToAttribute("items", {
147
+ type: "ArrayExpression",
148
+ elements: packageManagers.map(({ name }) => ({
149
+ type: "Literal",
150
+ value: name
151
+ }))
152
+ })], packageManagers.map(({ command, name }) => ({
153
+ type: "mdxJsxFlowElement",
154
+ name: Tab,
155
+ attributes: [{
156
+ type: "mdxJsxAttribute",
157
+ name: "value",
158
+ value: name
159
+ }],
160
+ children: [{
161
+ type: "code",
162
+ lang: "bash",
163
+ meta: node.meta,
164
+ value: command(value)
165
+ }]
166
+ })));
167
+ Object.assign(node, insert);
168
+ });
169
+ };
181
170
  }
182
171
 
183
- // src/remark-show.ts
184
- import { visit as visit3 } from "unist-util-visit";
172
+ //#endregion
173
+ //#region src/remark-show.ts
185
174
  function remarkShow(options) {
186
- var _a;
187
- const variables = (_a = options == null ? void 0 : options.variables) != null ? _a : {};
188
- return (tree, file) => __async(null, null, function* () {
189
- const { toJs } = yield import("estree-util-to-js");
190
- const tasks = [];
191
- visit3(tree, "mdxJsxFlowElement", (node) => {
192
- var _a2;
193
- if (node.name !== "show") return;
194
- for (const attr of node.attributes) {
195
- if (attr.type !== "mdxJsxAttribute" || attr.name !== "on") continue;
196
- if (!attr.value || typeof attr.value !== "object" || !((_a2 = attr.value.data) == null ? void 0 : _a2.estree))
197
- return "skip";
198
- const js = toJs(attr.value.data.estree);
199
- const callback = new Function(
200
- ...Object.keys(variables),
201
- `return ${js.value}`
202
- )(...Object.values(variables));
203
- tasks.push(
204
- (() => __async(null, null, function* () {
205
- const value = typeof callback === "function" ? yield callback(file) : callback;
206
- Object.assign(node, {
207
- type: "mdxJsxFlowElement",
208
- name: null,
209
- attributes: [],
210
- children: value === true ? node.children : []
211
- });
212
- }))()
213
- );
214
- return "skip";
215
- }
216
- });
217
- yield Promise.all(tasks);
218
- });
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
+ }
197
+ });
198
+ await Promise.all(tasks);
199
+ };
219
200
  }
220
- export {
221
- createElement,
222
- expressionToAttribute,
223
- fileGenerator,
224
- fileGeneratorSchema,
225
- remarkDocGen,
226
- remarkInstall,
227
- remarkShow
228
- };
201
+
202
+ //#endregion
203
+ export { createElement, expressionToAttribute, fileGenerator, fileGeneratorSchema, remarkDocGen, remarkInstall, remarkShow };
204
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
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"}
@@ -1,20 +1,21 @@
1
- import { Transformer } from 'unified';
2
- import { Root } from 'mdast';
1
+ import { Root } from "mdast";
2
+ import { Transformer } from "unified";
3
3
 
4
+ //#region src/remark-ts2js.d.ts
4
5
  interface TypeScriptToJavaScriptOptions {
5
- /**
6
- * Persist Tab value (Fumadocs UI only)
7
- *
8
- * @defaultValue false
9
- */
10
- persist?: {
11
- id: string;
12
- } | false;
13
- defaultValue?: 'js' | 'ts';
14
- /**
15
- * Transform all TypeScript codeblocks by default, without a trigger
16
- */
17
- disableTrigger?: boolean;
6
+ /**
7
+ * Persist Tab value (Hanzo Docs UI only)
8
+ *
9
+ * @defaultValue false
10
+ */
11
+ persist?: {
12
+ id: string;
13
+ } | false;
14
+ defaultValue?: 'js' | 'ts';
15
+ /**
16
+ * Transform all TypeScript codeblocks by default, without a trigger
17
+ */
18
+ disableTrigger?: boolean;
18
19
  }
19
20
  /**
20
21
  * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.
@@ -30,6 +31,11 @@ interface TypeScriptToJavaScriptOptions {
30
31
  * ```
31
32
  * ````
32
33
  */
33
- declare function remarkTypeScriptToJavaScript({ persist, defaultValue, disableTrigger, }?: TypeScriptToJavaScriptOptions): Transformer<Root>;
34
-
35
- export { type TypeScriptToJavaScriptOptions, remarkTypeScriptToJavaScript };
34
+ declare function remarkTypeScriptToJavaScript({
35
+ persist,
36
+ defaultValue,
37
+ disableTrigger
38
+ }?: TypeScriptToJavaScriptOptions): Transformer<Root>;
39
+ //#endregion
40
+ export { TypeScriptToJavaScriptOptions, remarkTypeScriptToJavaScript };
41
+ //# sourceMappingURL=remark-ts2js.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -1,84 +1,77 @@
1
- import {
2
- __async
3
- } from "./chunk-4AFQP74Z.js";
4
-
5
- // src/remark-ts2js.ts
6
1
  import { visit } from "unist-util-visit";
7
- import {
8
- generateCodeBlockTabs,
9
- parseCodeBlockAttributes
10
- } from "@hanzo/docs-core/mdx-plugins/codeblock-utils";
11
- function remarkTypeScriptToJavaScript({
12
- persist = false,
13
- defaultValue = "ts",
14
- disableTrigger = false
15
- } = {}) {
16
- return (tree, file) => __async(null, null, function* () {
17
- const oxc = yield import("oxc-transform");
18
- const tasks = [];
19
- visit(tree, "code", (node) => {
20
- var _a;
21
- const lang = node.lang;
22
- if (lang !== "ts" && lang !== "tsx") return;
23
- const meta = parseCodeBlockAttributes((_a = node.meta) != null ? _a : "", ["ts2js"]);
24
- if (!disableTrigger && !("ts2js" in meta.attributes)) return;
25
- tasks.push(
26
- (() => __async(null, null, function* () {
27
- var _a2, _b;
28
- const result = yield oxc.transform(
29
- `${(_a2 = file.path) != null ? _a2 : "test"}.${lang}`,
30
- node.value,
31
- {
32
- sourcemap: false,
33
- jsx: "preserve"
34
- }
35
- );
36
- const replacement = generateCodeBlockTabs({
37
- persist,
38
- defaultValue,
39
- triggers: [
40
- {
41
- value: "ts",
42
- children: [{ type: "text", value: "TypeScript" }]
43
- },
44
- {
45
- value: "js",
46
- children: [{ type: "text", value: "JavaScript" }]
47
- }
48
- ],
49
- tabs: [
50
- {
51
- value: "ts",
52
- children: [
53
- {
54
- type: "code",
55
- lang: node.lang,
56
- meta: meta.rest,
57
- value: node.value
58
- }
59
- ]
60
- },
61
- {
62
- value: "js",
63
- children: [
64
- {
65
- type: "code",
66
- lang: lang === "tsx" ? "jsx" : "js",
67
- meta: (_b = meta.attributes.ts2js) != null ? _b : meta.rest,
68
- value: result.code
69
- }
70
- ]
71
- }
72
- ]
73
- });
74
- Object.assign(node, replacement);
75
- }))()
76
- );
77
- return "skip";
78
- });
79
- yield Promise.all(tasks);
80
- });
2
+ import { generateCodeBlockTabs, parseCodeBlockAttributes } from "@hanzo/docs-core/mdx-plugins/codeblock-utils";
3
+
4
+ //#region src/remark-ts2js.ts
5
+ /**
6
+ * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.
7
+ *
8
+ * Add `ts2js` to enable transformation:
9
+ * ````md
10
+ * ```tsx ts2js
11
+ * import { ReactNode } from "react";
12
+ *
13
+ * export default function Layout({ children }: { children: ReactNode }) {
14
+ * return <div>{children}</div>
15
+ * }
16
+ * ```
17
+ * ````
18
+ */
19
+ function remarkTypeScriptToJavaScript({ persist = false, defaultValue = "ts", disableTrigger = false } = {}) {
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"
41
+ }]
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";
70
+ });
71
+ await Promise.all(tasks);
72
+ };
81
73
  }
82
- export {
83
- remarkTypeScriptToJavaScript
84
- };
74
+
75
+ //#endregion
76
+ export { remarkTypeScriptToJavaScript };
77
+ //# sourceMappingURL=remark-ts2js.js.map
@@ -0,0 +1 @@
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,67 +1,85 @@
1
1
  {
2
2
  "name": "@hanzo/docs-docgen",
3
- "version": "3.0.4",
4
- "description": "Useful remark utilities and plugins for Hanzo Docs",
3
+ "version": "3.0.7",
4
+ "description": "Useful remark utilities and plugins",
5
5
  "keywords": [
6
- "Hanzo",
7
6
  "Docs",
8
- "remark",
7
+ "hanzo-docs",
9
8
  "mdx",
10
- "Docgen"
9
+ "remark"
11
10
  ],
12
- "homepage": "https://hanzo.ai/docs",
13
- "repository": "github:hanzoai/docs",
11
+ "homepage": "https://hanzoai.github.io/docs",
14
12
  "license": "MIT",
15
- "author": "Fuma Nama",
16
- "type": "module",
17
- "main": "./dist/index.js",
18
- "types": "./dist/index.d.ts",
13
+ "author": "Hanzo AI",
14
+ "repository": "github:hanzoai/docs",
19
15
  "files": [
20
16
  "dist/*"
21
17
  ],
18
+ "type": "module",
19
+ "main": "./dist/index.js",
20
+ "types": "./dist/index.d.ts",
22
21
  "exports": {
23
22
  ".": {
24
- "import": "./dist/index.js",
25
- "types": "./dist/index.d.ts"
23
+ "types": "./dist/index.d.ts",
24
+ "import": "./dist/index.js"
26
25
  },
27
26
  "./remark-ts2js": {
28
- "import": "./dist/remark-ts2js.js",
29
- "types": "./dist/remark-ts2js.d.ts"
27
+ "types": "./dist/remark-ts2js.d.ts",
28
+ "import": "./dist/remark-ts2js.js"
30
29
  }
31
30
  },
31
+ "publishConfig": {
32
+ "access": "public"
33
+ },
32
34
  "dependencies": {
33
35
  "estree-util-to-js": "^2.0.0",
34
36
  "estree-util-value-to-estree": "^3.5.0",
35
37
  "npm-to-yarn": "^3.0.1",
36
- "oxc-transform": "^0.102.0",
37
- "unist-util-visit": "^5.0.0",
38
- "zod": "^4.1.13"
39
- },
40
- "peerDependencies": {
41
- "@hanzo/docs-core": "^15.7.2 || ^16.0.0"
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"
42
43
  },
43
44
  "devDependencies": {
44
45
  "@mdx-js/mdx": "^3.1.1",
45
46
  "@types/estree": "^1.0.8",
46
47
  "@types/hast": "^3.0.4",
47
48
  "@types/mdast": "^4.0.4",
48
- "@types/node": "24.10.2",
49
+ "@types/node": "25.2.1",
49
50
  "mdast-util-mdx-jsx": "^3.2.0",
50
51
  "remark": "^15.0.1",
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
- "@hanzo/docs-core": "16.2.6",
55
+ "@hanzo/docs-core": "16.5.3",
56
56
  "tsconfig": "0.0.0"
57
57
  },
58
- "publishConfig": {
59
- "access": "public"
58
+ "peerDependencies": {
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
- "build": "tsup",
80
+ "build": "tsdown",
63
81
  "clean": "rimraf dist",
64
- "dev": "tsup --watch",
82
+ "dev": "tsdown --watch",
65
83
  "lint": "eslint .",
66
84
  "types:check": "tsc --noEmit"
67
85
  }
@@ -1,24 +0,0 @@
1
- var __async = (__this, __arguments, generator) => {
2
- return new Promise((resolve, reject) => {
3
- var fulfilled = (value) => {
4
- try {
5
- step(generator.next(value));
6
- } catch (e) {
7
- reject(e);
8
- }
9
- };
10
- var rejected = (value) => {
11
- try {
12
- step(generator.throw(value));
13
- } catch (e) {
14
- reject(e);
15
- }
16
- };
17
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
18
- step((generator = generator.apply(__this, __arguments)).next());
19
- });
20
- };
21
-
22
- export {
23
- __async
24
- };