feat: typedoc

FellouAI · Jan 1, 2025 · 2e7f171 · 2e7f171
1 parent 5fe4031
commit 2e7f171
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@
 ### **Using npm**
 
 ```bash
-npm install fellou-eko
+npm install @eko-ai/eko
 ```
 
 ## Contributing

diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "lint:fix": "eslint src/**/*.ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",
     "prepublishOnly": "npm run build",
-    "docs": "typedoc src/index.ts"
+    "docs": "typedoc"
   },
   "author": "FellouAI",
   "license": "MIT",
@@ -83,6 +83,7 @@
     "rollup-plugin-copy": "^3.5.0",
     "ts-jest": "^29.1.2",
     "tslib": "^2.8.1",
+    "typedoc": "^0.27.6",
     "typescript": "^5.3.3"
   },
   "engines": {

diff --git a/test/unit/action.test.ts b/test/unit/action.test.ts
@@ -96,6 +96,7 @@ describe('ActionImpl', () => {
     mockTool = new MockTool('test_tool');
     mockLLMProvider = new MockLLMProvider();
     context = {
+      llmProvider: mockLLMProvider,
       variables: new Map<string, unknown>(),
       tools: new Map<string, Tool<any, any>>(),
     };

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,9 @@
+{
+  "name": "EKO API",
+  "entryPoints": ["src/index.ts", "src/types/index.ts", "src/extension/index.ts"],
+  "exclude": ["node_modules", "test/**/*", "src/extension/script", "src/extension/content"],
+  "out": "../eko-docs/public/api",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeExternals": true
+}