Merge pull request #21 from rabbitholegg/sam/typedoc

feat(sdk): set up docs tasks on main
boostxyz · Jul 11, 2024 · a7517f7 · a7517f7
2 parents f75e6a6 + fdfb7af
commit a7517f7
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ coverage
 .cache
 tsconfig.tsbuildinfo
 .DS_Store
+docs
diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
     "lefthook": "^1.6.15",
     "prettier": "^3.2.5",
     "turbo": "^2.0.0",
+    "typedoc": "^0.26.4",
     "typescript": "^5.3.3",
     "vite": "^5.2.13",
     "vitest": "^1.6.0"

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -34,7 +34,8 @@
     "bench:ci": "CI=true vitest bench",
     "clean": "rm -rf dist",
     "test": "vitest dev",
-    "test:ci": "CI=true vitest --coverage"
+    "test:ci": "CI=true vitest --coverage",
+    "typedoc": "npx typedoc"
   },
   "devDependencies": {
     "@boostxyz/evm": "workspace:*"

diff --git a/packages/sdk/typedoc.json b/packages/sdk/typedoc.json
@@ -0,0 +1,6 @@
+{
+  // Comments are supported, like tsconfig.json
+  "entryPoints": ["./src/index.ts"],
+  "exclude": ["./test", "./src/**/*.test.ts"],
+  "out": "docs"
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/turbo.json b/turbo.json
@@ -10,6 +10,10 @@
     "test:ci": {
       "outputs": ["coverage/**"]
     },
+    "typedoc": {
+      "inputs": ["src"],
+      "outputs": ["docs/**"]
+    },
     "dev": {
       "cache": false,
       "persistent": true