WIP

package.json

@@ -35,6 +35,7 @@
 		"@parcel/watcher": "^2.4.1",
 		"@portone-io/lint-local-links-valid": "workspace:^",
 		"@portone-io/lint-no-jamo": "workspace:^",
+		"@portone-io/remark-param-tree": "workspace:^",
 		"@portone/browser-sdk": "^0.0.10",
 		"@rollup/plugin-yaml": "^4.1.2",
 		"@shikijs/rehype": "^1.11.0",

packages/remark-param-tree/README.md

@@ -0,0 +1 @@
+## @portone-io/remark-param-tree

packages/remark-param-tree/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@portone-io/remark-param-tree",
+  "version": "0.0.1",
+  "repository": "https://github.com/portone-io/developers.portone.io",
+  "type": "module",
+  "private": true,
+  "main": "src/index.ts",
+  "scripts": {
+    "test": "vitest"
+  },
+  "dependencies": {
+    "mdast-util-from-markdown": "^2.0.1",
+    "mdast-util-to-string": "^4.0.0",
+    "remark": "^15.0.1",
+    "remark-stringify": "^11.0.0",
+    "ts-pattern": "^5.1.1",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0",
+    "unist-util-visit-parents": "^6.0.1"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^20.12.7",
+    "@types/unist": "^3.0.3",
+    "@vitest/ui": "^1.5.3",
+    "mdast-util-mdx-jsx": "^3.1.3",
+    "vfile": "^6.0.3",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.5.3"
+  }
+}

packages/remark-param-tree/scripts/migration.ts

@@ -0,0 +1,115 @@
+import "mdast-util-mdx-jsx";
+
+import path from "node:path";
+
+import type { BlockContent, DefinitionContent, Paragraph, Root } from "mdast";
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { toString } from "mdast-util-to-string";
+import { match, P } from "ts-pattern";
+import { SKIP, visit } from "unist-util-visit";
+import type { VFile } from "vfile";
+
+const isParameter = (node: BlockContent | DefinitionContent) => {};
+
+type TypeDefinition = {
+  name: string;
+  type: string;
+  optional: boolean;
+};
+
+export default function remarkParamTreePlugin() {
+  return function (tree: Root, file: VFile) {
+    const workingFile = path.resolve(
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
+      file.cwd,
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+      file.history[0] ?? "",
+    );
+    visit(tree, "mdxJsxFlowElement", (node) => {
+      if (node.name === "ParamTree") {
+        visit(node, "listItem", (listItem) => {
+          if (listItem.children[0]?.type !== "paragraph") {
+            return;
+          }
+          listItem.children[0].children = listItem.children[0].children.filter(
+            (child) =>
+              match(child)
+                .with(
+                  {
+                    type: "text",
+                    value: P.when((value) => value.trim() === ""),
+                  },
+                  () => false,
+                )
+                .otherwise(() => true),
+          );
+          const typeDefinition: TypeDefinition | null = match(
+            listItem.children[0],
+          )
+            .with(
+              {
+                children: [
+                  { type: P.not(P.union("inlineCode", "strong")) },
+                  ...P.array(),
+                ],
+              },
+              () => null,
+            )
+            .with(
+              {
+                children: [
+                  { type: P.union("inlineCode", "strong") },
+                  {
+                    type: "mdxJsxTextElement",
+                    name: "mark",
+                  },
+                ],
+              },
+              (typeDefinition) => {
+                return {
+                  name: toString(typeDefinition.children[0]),
+                  type: toString(typeDefinition.children[1]),
+                  optional: true,
+                } satisfies TypeDefinition;
+              },
+            )
+            .with(
+              {
+                children: [
+                  { type: P.union("inlineCode", "strong") },
+                  {
+                    type: "mdxJsxTextElement",
+                    name: "mark",
+                  },
+                  {
+                    type: "mdxJsxTextElement",
+                    name: "mark",
+                  },
+                ],
+              },
+              (typeDefinition) => {
+                return {
+                  name: toString(typeDefinition.children[0]),
+                  type: toString(typeDefinition.children[2]),
+                  optional: false,
+                } satisfies TypeDefinition;
+              },
+            )
+            .otherwise(() => {
+              // console.log(workingFile, toString(listItem.children[0]));
+              return null;
+            });
+
+          if (typeDefinition) {
+            listItem.children[0] = fromMarkdown(
+              `${typeDefinition.name}${typeDefinition.optional ? "" : "*"}: ${typeDefinition.type}`,
+              "utf-8",
+            ).children[0] as Paragraph;
+            console.log(workingFile, listItem.children[0]);
+          }
+        });
+      }
+      return SKIP;
+    });
+  };
+}

packages/remark-param-tree/src/index.ts

@@ -0,0 +1,22 @@
+import "mdast-util-mdx-jsx";
+
+import path from "node:path";
+
+import type { BlockContent, DefinitionContent, Paragraph, Root } from "mdast";
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { toString } from "mdast-util-to-string";
+import { match, P } from "ts-pattern";
+import { SKIP, visit } from "unist-util-visit";
+import type { VFile } from "vfile";
+
+const isParameter = (node: BlockContent | DefinitionContent) => {};
+
+type TypeDefinition = {
+  name: string;
+  type: string;
+  optional: boolean;
+};
+
+export default function remarkParamTreePlugin() {
+  return function (tree: Root, file: VFile) {};
+}

packages/remark-param-tree/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "types": ["vitest/globals"],
+    "baseUrl": "./"
+  }
+}