@hanzo/docs-docgen 3.0.4 → 3.1.0

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.
@@ -0,0 +1,28 @@
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 };
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"],"sourcesContent":[],"mappings":";;;;;;;;KAKK,eAAe,IAAI,QAAQ;UAEf,YAAA;;;;AAJkB;EAEf,GAAA,EAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAAA,EAQa,OARb,EAAA,GAQyB,SARzB,CAAA,MAAA,GAAA,MAAA,EAAA,GAAA,SAAA,CAAA;EAAY,MAAA,CAAA,EAAA,CAAA,IAAA,EAUd,IAVc,EAAA,IAAA,EAUF,KAVE,EAAA,GAAA,IAAA;;UAatB,OAAA,CAbqB;EAEd,IAAA,EAYT,IAZS;EAMgB,IAAA,EAAA,MAAA;EAAY,GAAA,EAAA,MAAA;;AAEf,UASb,mBAAA,CATa;EAAK,UAAA,CAAA,EAUpB,YAVoB,EAAA;AAClC;AAQgB,iBAMD,YAAA,CALD;EAAA;AAAY,CAAA,EAKuB,mBALvB,CAAA,EAK6C,WAL7C,CAKyD,IALzD,EAK+D,IAL/D,CAAA;;;iBCtBX,aAAA;iBAYA,qBAAA,qBAA0C,aAAa;;;UCTtD,oBAAA;;;;;;AFHkB;;EAEH,QAAA,CAAA,EAAA,OAAA;;AAAD,KEanB,kBAAA,GAAqB,CAAA,CAAE,MFbJ,CAAA,OEakB,mBFblB,CAAA;AAEd,cEaJ,mBFbgB,EEaG,CAAA,CAAA,SFbH,CAAA;EAMI,IAAA,aAAA;EAAY,SAAA,cAAA,WAAA,CAAA,SAAA,YAAA,CAAA;IAE3B,IAAA,eAAA,YAAA,CAAA;IAAY,IAAA,eAAA,YAAA,CAAA;EAAK,CAAA,eAAA,CAAA,cAAA,CAAA,CAAA,CAAA;AAClC,CAAA,eAEgB,CAAA;AAMA,iBEeD,aAAA,CFdD;EAAA,QAAA;EAAY;AAAA,CAAA,CAAA,EEiBxB,oBFjBwB,CAAA,EEiBI,YFjBJ;;;UGnBjB,cAAA;;;;;;AHHyB;AAEf,KGUR,oBAAA,GHVQ;EAAY,IAAA,CAAA,EAAA,MAAA;EAAR,GAAA,CAAA,EAAA,MAAA;EAAO;AAE/B;;;;EAQ8B,OAAA,CAAA,EAAA;IAAK,EAAA,EAAA,MAAA;EAGzB,CAAA,GAAA,KAAA;EAMO,eAAA,CAAA,EGMG,cHNgB,EACrB;AAKf,CAAA;;;;;;;;;;AC3BA;AAYA;;;iBE+BgB,aAAA;;;;;IAUb,uBAA4B,YAAY,MAAM;;;iBCnDjC,UAAA;cACF;IACV,YAAY,MAAM"}
package/dist/index.js CHANGED
@@ -1,228 +1,228 @@
1
- import {
2
- __async
3
- } from "./chunk-4AFQP74Z.js";
4
-
5
- // src/remark-docgen.ts
1
+ import { t as _asyncToGenerator } from "./asyncToGenerator-Ux3KppAy.js";
6
2
  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
- });
3
+ import * as fs from "node:fs/promises";
4
+ import * as path from "node:path";
5
+ import { z } from "zod";
6
+ import convert from "npm-to-yarn";
7
+
8
+ //#region src/remark-docgen.ts
9
+ const metaRegex = new RegExp("doc-gen:(?<name>.+)", "");
10
+ function remarkDocGen({ generators = [] }) {
11
+ return function() {
12
+ var _ref2 = _asyncToGenerator(function* (tree, file) {
13
+ generators.forEach((gen) => {
14
+ var _gen$onFile;
15
+ return (_gen$onFile = gen.onFile) === null || _gen$onFile === void 0 ? void 0 : _gen$onFile.call(gen, tree, file);
16
+ });
17
+ const queue = [];
18
+ visit(tree, "code", (code, _, parent) => {
19
+ if (code.lang !== "json" || !code.meta || !parent) return;
20
+ const matches = metaRegex.exec(code.meta);
21
+ if (!matches) return;
22
+ const name = matches[1];
23
+ const gen = generators.find((g) => g.name === name);
24
+ const run = function() {
25
+ var _ref = _asyncToGenerator(function* () {
26
+ const result = yield gen === null || gen === void 0 ? void 0 : gen.run(JSON.parse(code.value), {
27
+ cwd: file.cwd,
28
+ path: file.path,
29
+ node: code
30
+ });
31
+ const index = parent.children.findIndex((c) => c === code);
32
+ if (result && index !== -1) {
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);
44
+ });
45
+ return function(_x, _x2) {
46
+ return _ref2.apply(this, arguments);
47
+ };
48
+ }();
39
49
  }
40
50
 
41
- // src/utils.ts
51
+ //#endregion
52
+ //#region src/utils.ts
42
53
  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;
54
+ const element = {
55
+ type: "mdxJsxFlowElement",
56
+ name,
57
+ attributes
58
+ };
59
+ if (children) element.children = children;
60
+ return element;
50
61
  }
51
62
  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
- };
63
+ return {
64
+ type: "mdxJsxAttribute",
65
+ name: key,
66
+ value: {
67
+ type: "mdxJsxAttributeValueExpression",
68
+ value: "",
69
+ data: { estree: {
70
+ type: "Program",
71
+ body: [{
72
+ type: "ExpressionStatement",
73
+ expression: value
74
+ }]
75
+ } }
76
+ }
77
+ };
71
78
  }
72
79
 
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)
80
+ //#endregion
81
+ //#region src/file-generator.ts
82
+ const fileGeneratorSchema = z.object({
83
+ file: z.string(),
84
+ codeblock: z.union([z.object({
85
+ lang: z.string().optional(),
86
+ meta: z.string().optional()
87
+ }), z.boolean()]).default(false)
91
88
  });
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
- };
89
+ function fileGenerator({ relative = false, trim = true } = {}) {
90
+ return {
91
+ name: "file",
92
+ run(input, ctx) {
93
+ return _asyncToGenerator(function* () {
94
+ var _codeOptions$lang;
95
+ const { file, codeblock = false } = fileGeneratorSchema.parse(input);
96
+ const dest = relative ? path.resolve(ctx.cwd, path.dirname(ctx.path), file) : path.resolve(ctx.cwd, file);
97
+ let value = yield fs.readFile(dest).then((res) => res.toString());
98
+ if (trim) value = value.trim();
99
+ if (codeblock === false) return {
100
+ type: "paragraph",
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,
111
+ value
112
+ };
113
+ })();
114
+ }
115
+ };
121
116
  }
122
117
 
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
- };
118
+ //#endregion
119
+ //#region src/remark-install.ts
120
+ /**
121
+ * It generates the following structure from a code block with `package-install` as language
122
+ *
123
+ * @example
124
+ * ```tsx
125
+ * <Tabs items={["npm", "pnpm", "yarn", "bun"]}>
126
+ * <Tab value="pnpm">...</Tab>
127
+ * ...
128
+ * </Tabs>
129
+ * ```
130
+ *
131
+ * @deprecated Use `remarkNpm` from `@hanzo/docs-core/mdx-plugins` instead, it's a drop-in replacement.
132
+ */
133
+ function remarkInstall({ Tab = "Tab", Tabs = "Tabs", persist = false, packageManagers = [
134
+ {
135
+ command: (cmd) => convert(cmd, "npm"),
136
+ name: "npm"
137
+ },
138
+ {
139
+ command: (cmd) => convert(cmd, "pnpm"),
140
+ name: "pnpm"
141
+ },
142
+ {
143
+ command: (cmd) => convert(cmd, "yarn"),
144
+ name: "yarn"
145
+ },
146
+ {
147
+ command: (cmd) => convert(cmd, "bun"),
148
+ name: "bun"
149
+ }
150
+ ] } = {}) {
151
+ return (tree) => {
152
+ visit(tree, "code", (node) => {
153
+ if (node.lang !== "package-install") return "skip";
154
+ const value = node.value.startsWith("npm") || node.value.startsWith("npx") ? node.value : `npm install ${node.value}`;
155
+ const insert = createElement(Tabs, [...typeof persist === "object" ? [{
156
+ type: "mdxJsxAttribute",
157
+ name: "groupId",
158
+ value: persist.id
159
+ }, {
160
+ type: "mdxJsxAttribute",
161
+ name: "persist",
162
+ value: null
163
+ }] : [], expressionToAttribute("items", {
164
+ type: "ArrayExpression",
165
+ elements: packageManagers.map(({ name }) => ({
166
+ type: "Literal",
167
+ value: name
168
+ }))
169
+ })], packageManagers.map(({ command, name }) => ({
170
+ type: "mdxJsxFlowElement",
171
+ name: Tab,
172
+ attributes: [{
173
+ type: "mdxJsxAttribute",
174
+ name: "value",
175
+ value: name
176
+ }],
177
+ children: [{
178
+ type: "code",
179
+ lang: "bash",
180
+ meta: node.meta,
181
+ value: command(value)
182
+ }]
183
+ })));
184
+ Object.assign(node, insert);
185
+ });
186
+ };
181
187
  }
182
188
 
183
- // src/remark-show.ts
184
- import { visit as visit3 } from "unist-util-visit";
189
+ //#endregion
190
+ //#region src/remark-show.ts
185
191
  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
- });
192
+ var _options$variables;
193
+ const variables = (_options$variables = options === null || options === void 0 ? void 0 : options.variables) !== null && _options$variables !== void 0 ? _options$variables : {};
194
+ return function() {
195
+ var _ref = _asyncToGenerator(function* (tree, file) {
196
+ const { toJs } = yield import("estree-util-to-js");
197
+ const tasks = [];
198
+ visit(tree, "mdxJsxFlowElement", (node) => {
199
+ if (node.name !== "show") return;
200
+ for (const attr of node.attributes) {
201
+ var _attr$value$data;
202
+ if (attr.type !== "mdxJsxAttribute" || attr.name !== "on") continue;
203
+ if (!attr.value || typeof attr.value !== "object" || !((_attr$value$data = attr.value.data) === null || _attr$value$data === void 0 ? void 0 : _attr$value$data.estree)) return "skip";
204
+ const js = toJs(attr.value.data.estree);
205
+ const callback = new Function(...Object.keys(variables), `return ${js.value}`)(...Object.values(variables));
206
+ tasks.push(_asyncToGenerator(function* () {
207
+ const value = typeof callback === "function" ? yield callback(file) : callback;
208
+ Object.assign(node, {
209
+ type: "mdxJsxFlowElement",
210
+ name: null,
211
+ attributes: [],
212
+ children: value === true ? node.children : []
213
+ });
214
+ })());
215
+ return "skip";
216
+ }
217
+ });
218
+ yield Promise.all(tasks);
219
+ });
220
+ return function(_x, _x2) {
221
+ return _ref.apply(this, arguments);
222
+ };
223
+ }();
219
224
  }
220
- export {
221
- createElement,
222
- expressionToAttribute,
223
- fileGenerator,
224
- fileGeneratorSchema,
225
- remarkDocGen,
226
- remarkInstall,
227
- remarkShow
228
- };
225
+
226
+ //#endregion
227
+ export { createElement, expressionToAttribute, fileGenerator, fileGeneratorSchema, remarkDocGen, remarkInstall, remarkShow };
228
+ //# sourceMappingURL=index.js.map
@@ -0,0 +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 (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,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,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"],"sourcesContent":[],"mappings":";;;;UAQiB,6BAAA;;AAAjB;AAkCA;;;EAGE,OAAA,CAAA,EAAA;IACC,EAAA,EAAA,MAAA;EAAiD,CAAA,GAAA,KAAA;EAAZ,YAAA,CAAA,EAAA,IAAA,GAAA,IAAA;EAAW;;;;;;;;;;;;;;;;;;;iBAJnC,4BAAA;;;;IAIb,gCAAqC,YAAY"}
@@ -1,84 +1,85 @@
1
- import {
2
- __async
3
- } from "./chunk-4AFQP74Z.js";
4
-
5
- // src/remark-ts2js.ts
1
+ import { t as _asyncToGenerator } from "./asyncToGenerator-Ux3KppAy.js";
6
2
  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
- });
3
+ import { generateCodeBlockTabs, parseCodeBlockAttributes } from "@hanzo/docs-core/mdx-plugins/codeblock-utils";
4
+
5
+ //#region src/remark-ts2js.ts
6
+ /**
7
+ * A remark plugin to transform TypeScript codeblocks into two tabs of codeblocks with its JS variant.
8
+ *
9
+ * Add `ts2js` to enable transformation:
10
+ * ````md
11
+ * ```tsx ts2js
12
+ * import { ReactNode } from "react";
13
+ *
14
+ * export default function Layout({ children }: { children: ReactNode }) {
15
+ * return <div>{children}</div>
16
+ * }
17
+ * ```
18
+ * ````
19
+ */
20
+ function remarkTypeScriptToJavaScript({ persist = false, defaultValue = "ts", disableTrigger = false } = {}) {
21
+ return function() {
22
+ var _ref = _asyncToGenerator(function* (tree, file) {
23
+ const oxc = yield import("oxc-transform");
24
+ const tasks = [];
25
+ visit(tree, "code", (node) => {
26
+ var _node$meta;
27
+ const lang = node.lang;
28
+ if (lang !== "ts" && lang !== "tsx") return;
29
+ const meta = parseCodeBlockAttributes((_node$meta = node.meta) !== null && _node$meta !== void 0 ? _node$meta : "", ["ts2js"]);
30
+ if (!disableTrigger && !("ts2js" in meta.attributes)) return;
31
+ tasks.push(_asyncToGenerator(function* () {
32
+ var _file$path, _meta$attributes$ts2j;
33
+ const result = yield oxc.transform(`${(_file$path = file.path) !== null && _file$path !== void 0 ? _file$path : "test"}.${lang}`, node.value, {
34
+ sourcemap: false,
35
+ jsx: "preserve"
36
+ });
37
+ const replacement = generateCodeBlockTabs({
38
+ persist,
39
+ defaultValue,
40
+ triggers: [{
41
+ value: "ts",
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
+ }]
69
+ }]
70
+ });
71
+ Object.assign(node, replacement);
72
+ })());
73
+ return "skip";
74
+ });
75
+ yield Promise.all(tasks);
76
+ });
77
+ return function(_x, _x2) {
78
+ return _ref.apply(this, arguments);
79
+ };
80
+ }();
81
81
  }
82
- export {
83
- remarkTypeScriptToJavaScript
84
- };
82
+
83
+ //#endregion
84
+ export { remarkTypeScriptToJavaScript };
85
+ //# sourceMappingURL=remark-ts2js.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"remark-ts2js.js","names":["tasks: Promise<void>[]"],"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;0CAAc,MAAM,MAAS;GAC3B,MAAM,YAAY,OAAO;GACzB,MAAMA,QAAyB,EAAE;AAEjC,SAAM,MAAM,SAAS,SAAS;;IAC5B,MAAM,OAAO,KAAK;AAClB,QAAI,SAAS,QAAQ,SAAS,MAAO;IAErC,MAAM,OAAO,uCAAyB,KAAK,uDAAQ,IAAI,CAAC,QAAQ,CAAC;AACjE,QAAI,CAAC,kBAAkB,EAAE,WAAW,KAAK,YAAa;AAEtD,UAAM,oCACS;;KACX,MAAM,eAAe,IAAI,UAAU,iBAAG,KAAK,uDAAQ,OAAO,GAAG,QAAQ,KAAK,OAAO;MAC/E,WAAW;MACX,KAAK;MACN,CAAC;KAEF,MAAM,cAAc,sBAAsB;MACxC;MACA;MACA,UAAU,CACR;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,EACD;OACE,OAAO;OACP,UAAU,CAAC;QAAE,MAAM;QAAQ,OAAO;QAAc,CAAC;OAClD,CACF;MACD,MAAM,CACJ;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,KAAK;QACX,MAAM,KAAK;QACX,OAAO,KAAK;QACb,CACF;OACF,EACD;OACE,OAAO;OACP,UAAU,CACR;QACE,MAAM;QACN,MAAM,SAAS,QAAQ,QAAQ;QAC/B,+BAAM,KAAK,WAAW,8EAAS,KAAK;QACpC,OAAO,OAAO;QACf,CACF;OACF,CACF;MACF,CAAC;AAEF,YAAO,OAAO,MAAM,YAAY;QAC9B,CACL;AAED,WAAO;KACP;AAEF,SAAM,QAAQ,IAAI,MAAM;;kBAhEZ,IAAM"}
package/package.json CHANGED
@@ -1,44 +1,50 @@
1
1
  {
2
2
  "name": "@hanzo/docs-docgen",
3
- "version": "3.0.4",
3
+ "version": "3.1.0",
4
4
  "description": "Useful remark utilities and plugins for Hanzo Docs",
5
5
  "keywords": [
6
- "Hanzo",
7
6
  "Docs",
8
- "remark",
7
+ "hanzo-docs",
9
8
  "mdx",
10
- "Docgen"
9
+ "remark"
11
10
  ],
12
11
  "homepage": "https://hanzo.ai/docs",
13
- "repository": "github:hanzoai/docs",
14
12
  "license": "MIT",
15
13
  "author": "Fuma Nama",
16
- "type": "module",
17
- "main": "./dist/index.js",
18
- "types": "./dist/index.d.ts",
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
+ },
34
+ "scripts": {
35
+ "build": "tsdown",
36
+ "clean": "rimraf dist",
37
+ "dev": "tsdown --watch",
38
+ "lint": "eslint .",
39
+ "types:check": "tsc --noEmit"
40
+ },
32
41
  "dependencies": {
33
42
  "estree-util-to-js": "^2.0.0",
34
43
  "estree-util-value-to-estree": "^3.5.0",
35
44
  "npm-to-yarn": "^3.0.1",
36
- "oxc-transform": "^0.102.0",
45
+ "oxc-transform": "^0.105.0",
37
46
  "unist-util-visit": "^5.0.0",
38
- "zod": "^4.1.13"
39
- },
40
- "peerDependencies": {
41
- "@hanzo/docs-core": "^15.7.2 || ^16.0.0"
47
+ "zod": "^4.2.1"
42
48
  },
43
49
  "devDependencies": {
44
50
  "@mdx-js/mdx": "^3.1.1",
@@ -46,23 +52,17 @@
46
52
  "@types/hast": "^3.0.4",
47
53
  "@types/mdast": "^4.0.4",
48
54
  "@types/node": "24.10.2",
55
+ "eslint-config-custom": "workspace:*",
56
+ "@hanzo/docs-core": "workspace:*",
49
57
  "mdast-util-mdx-jsx": "^3.2.0",
50
58
  "remark": "^15.0.1",
59
+ "tsconfig": "workspace:*",
60
+ "tsdown": "^0.18.3",
51
61
  "typescript": "^5.9.3",
52
62
  "unified": "^11.0.5",
53
- "vfile": "^6.0.3",
54
- "eslint-config-custom": "0.0.0",
55
- "@hanzo/docs-core": "16.2.6",
56
- "tsconfig": "0.0.0"
57
- },
58
- "publishConfig": {
59
- "access": "public"
63
+ "vfile": "^6.0.3"
60
64
  },
61
- "scripts": {
62
- "build": "tsup",
63
- "clean": "rimraf dist",
64
- "dev": "tsup --watch",
65
- "lint": "eslint .",
66
- "types:check": "tsc --noEmit"
65
+ "peerDependencies": {
66
+ "@hanzo/docs-core": "^15.7.2 || ^16.0.0"
67
67
  }
68
- }
68
+ }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2023 Fuma
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -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
- };