Merge pull request #12 from open-rpc/feat/workspace

Feat/workspace

Author: zcstarr

.gitignore

@@ -142,4 +142,5 @@ vite.config.ts.timestamp-*
 
 # LLMLOG.MD
 LLMLOG.MD
-coverage
+coverage
+**/*/docs/api-reference

bun.lock

@@ -28,15 +28,19 @@ export default [
       "vitest.config.ts", 
       "vite.config.ts",
       "build.ts",
-      "bun.lockb"
+      "**/build.ts",
+      "bun.lockb",
+      "packages/example-site/",
     ]
   },
+
   {
     files: ['**/*.{ts,tsx}'],
     languageOptions: {
       parser: tsParser,
       parserOptions: {
-        project: ['./tsconfig.json'],
+        project: ['./packages/markdown-generator/tsconfig.json', './packages/docusaurus-plugin/tsconfig.json'],
+
         tsconfigRootDir: __dirname,
         ecmaVersion: 2022,
         sourceType: 'module',

eslint.config.mjs

@@ -14,22 +14,31 @@
   "files": [
     "dist"
   ],
-  "private": false,
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
   "version": "0.0.0-development",
   "scripts": {
-    "types": "tsc -p tsconfig.json",
+    "types": "bun run types:md-gen && bun run types:plugin",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "build": "bun build.ts"
+    "build:md-gen": "bun run --cwd packages/markdown-generator build.ts",
+    "build:plugin": "bun run --cwd packages/docusaurus-plugin build.ts",
+    "types:md-gen": "bun run --cwd packages/markdown-generator tsc -p tsconfig.json",
+    "types:plugin": "bun run --cwd packages/docusaurus-plugin tsc -p tsconfig.json"
   },
   "devDependencies": {
+    "@eslint/js": "^9.39.1",
     "@types/bun": "^1.3.1",
     "@types/node": "22.13.5",
-    "typescript": "5.9",
     "@typescript-eslint/eslint-plugin": "^8.46.2",
+    "@typescript-eslint/parser": "^8.46.4",
     "eslint": "^9.38.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.4"
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.5.0",
+    "typescript": "5.9"
   },
   "dependencies": {}
 }

package.json

@@ -0,0 +1,13 @@
+#!/usr/bin/env bun
+import { $ } from "bun";
+
+// Build plugin entry only
+// Components are exported directly from src/ and transpiled by Docusaurus
+await Bun.build({
+  entrypoints: ["./src/index.ts"],
+  outdir: "./dist",
+  target: "node",
+  format: "esm",
+  sourcemap: "external",
+  external: ["@docusaurus/*", "react", "react-dom"],
+});

packages/docusaurus-plugin/build.ts

@@ -0,0 +1,34 @@
+{
+  "name": "@open-rpc/docusaurus-plugin",
+  "version": "0.0.0-development",
+  "private": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./components": "./src/components.ts"
+  },
+  "files": [
+    "dist",
+    "src/components",
+    "src/components.ts"
+  ],
+  "dependencies": {
+    "@docusaurus/core": "3.9.2",
+    "@docusaurus/logger": "3.9.2",
+    "@docusaurus/utils": "3.9.2",
+    "@docusaurus/utils-common": "3.9.2",
+    "@docusaurus/utils-validation": "3.9.2",
+    "@open-rpc/meta-schema": "^1.14.9",
+    "@open-rpc/schema-utils-js": "^2.1.2"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "3.9.2",
+    "@types/react": "^19.2.4",
+    "@types/react-dom": "^19.2.3"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  }
+}

packages/docusaurus-plugin/package.json

@@ -0,0 +1,6 @@
+// Separate entry point for components to avoid loading them during plugin initialization
+export {
+  TwoColumnLayout,
+  RequestExample,
+  ResponseExample,
+} from "./components/ApiExamples";

packages/docusaurus-plugin/src/components.ts

@@ -0,0 +1,27 @@
+import React, { type ReactNode } from "react";
+import styles from "./styles.module.css";
+
+interface RequestExampleProps {
+  code: string;
+  language?: string;
+  title?: string;
+}
+
+export function RequestExample({
+  code,
+  language = "json",
+  title = "Request",
+}: RequestExampleProps): ReactNode {
+  return (
+    <div className={styles.exampleBlock}>
+      <div className={`${styles.exampleHeader} ${styles.requestHeader}`}>
+        {title}
+      </div>
+      <div className={styles.exampleContent}>
+        <pre>
+          <code className={`language-${language}`}>{code}</code>
+        </pre>
+      </div>
+    </div>
+  );
+}

packages/docusaurus-plugin/src/components/ApiExamples/RequestExample.tsx

@@ -0,0 +1,27 @@
+import React, { type ReactNode } from "react";
+import styles from "./styles.module.css";
+
+interface ResponseExampleProps {
+  code: string;
+  language?: string;
+  title?: string;
+}
+
+export function ResponseExample({
+  code,
+  language = "json",
+  title = "Response",
+}: ResponseExampleProps): ReactNode {
+  return (
+    <div className={styles.exampleBlock}>
+      <div className={`${styles.exampleHeader} ${styles.responseHeader}`}>
+        {title}
+      </div>
+      <div className={styles.exampleContent}>
+        <pre>
+          <code className={`language-${language}`}>{code}</code>
+        </pre>
+      </div>
+    </div>
+  );
+}

packages/docusaurus-plugin/src/components/ApiExamples/ResponseExample.tsx

@@ -0,0 +1,19 @@
+import React, { type ReactNode } from "react";
+import styles from "./styles.module.css";
+
+interface TwoColumnLayoutProps {
+  children: ReactNode;
+  sidebar: ReactNode;
+}
+
+export function TwoColumnLayout({
+  children,
+  sidebar,
+}: TwoColumnLayoutProps): ReactNode {
+  return (
+    <div className={styles.twoColumnLayout}>
+      <div className={styles.mainContent}>{children}</div>
+      <div className={styles.sidebar}>{sidebar}</div>
+    </div>
+  );
+}