Merge pull request #1675 from Ed-Marcavage/feature/full-plugin-docs

Agentic Eliza Plugin Documenter - Multilingual (e.g., English, Spanish, French)
elizaOS · Jan 4, 2025 · 3b36e79 · 3b36e79
2 parents cddc9ee + 8f7a395
commit 3b36e79
Show file tree

Hide file tree

Showing 16 changed files with 2,724 additions and 103 deletions.
diff --git a/.github/workflows/jsdoc-automation.yml b/.github/workflows/jsdoc-automation.yml
@@ -3,22 +3,32 @@ name: JSDoc Automation
 on:
   workflow_dispatch:
     inputs:
+      jsdoc:
+        description: 'Generate JSDoc comments (T/F)'
+        required: true
+        default: 'T'
+        type: string
+      readme:
+        description: 'Generate README documentation (T/F)'
+        required: true
+        default: 'T'
+        type: string
       pull_number:
-        description: 'Pull Request Number (if not provided, scans root_directory) - PR must be merged to develop branch'
+        description: 'Pull Request Number (if not provided, scans root_directory) - PR must be merged to develop branch. DONT provide if `README documentation` is T from above'
         required: false
         type: string
       root_directory:
         description: 'Only scans files in this directory (relative to repository root, e.g., packages/core/src)'
         required: true
-        default: 'packages/core/src/test_resources'
+        default: 'packages/plugin-near/'
         type: string
       excluded_directories:
         description: 'Directories to exclude from scanning (comma-separated, relative to root_directory)'
         required: true
         default: 'node_modules,dist,test'
         type: string
       reviewers:
-        description: 'Pull Request Reviewers (comma-separated GitHub usernames)'
+        description: 'Pull Request Reviewers (Must be collaborator on the repository) comma-separated GitHub usernames'
         required: true
         default: ''
         type: string
@@ -27,6 +37,11 @@ on:
         required: false
         default: 'develop'
         type: string
+      language:
+        description: 'Documentation language (e.g., English, Spanish, French)'
+        required: true
+        default: 'English'
+        type: string
 
 jobs:
   generate-docs:
@@ -45,7 +60,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '23'
+          node-version: '20'
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -71,17 +86,19 @@ jobs:
         working-directory: scripts/jsdoc-automation
         run: pnpm install --no-frozen-lockfile
 
+      - name: Build TypeScript
+        working-directory: scripts/jsdoc-automation
+        run: pnpm build
+
       - name: Run documentation generator
         working-directory: scripts/jsdoc-automation
-        run: |
-          echo "Node version: $(node --version)"
-          echo "NPM version: $(npm --version)"
-          echo "Directory contents:"
-          ls -la
-          NODE_OPTIONS='--experimental-vm-modules --no-warnings' pnpm start
+        run: pnpm start
         env:
           INPUT_ROOT_DIRECTORY: ${{ inputs.root_directory }}
           INPUT_PULL_NUMBER: ${{ inputs.pull_number }}
           INPUT_EXCLUDED_DIRECTORIES: ${{ inputs.excluded_directories }}
           INPUT_REVIEWERS: ${{ inputs.reviewers }}
-          INPUT_BRANCH: ${{ inputs.branch }}
+          INPUT_BRANCH: ${{ inputs.branch }}
+          INPUT_LANGUAGE: ${{ inputs.language }}
+          INPUT_JSDOC: ${{ inputs.jsdoc }}
+          INPUT_README: ${{ inputs.readme }}
diff --git a/scripts/jsdoc-automation/package.json b/scripts/jsdoc-automation/package.json
@@ -3,10 +3,13 @@
     "name": "plugin-audix",
     "version": "1.0.0",
     "description": "",
-    "main": "index.ts",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
     "scripts": {
-        "start": "NODE_OPTIONS='--loader ts-node/esm' node src/index.ts",
-        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "tsup",
+        "dev": "tsup --watch",
+        "start": "node dist/index.js",
         "clean": "rm -rf node_modules dist"
     },
     "keywords": [],
@@ -16,15 +19,16 @@
         "@langchain/openai": "^0.3.16",
         "@octokit/rest": "^21.0.2",
         "@types/node": "^20.11.0",
-        "dotenv": "^16.4.7",
-        "langchain": "^0.3.7",
         "@typescript-eslint/parser": "6.18.1",
         "@typescript-eslint/types": "6.18.1",
         "@typescript-eslint/typescript-estree": "6.18.1",
+        "dotenv": "^16.4.7",
+        "langchain": "^0.3.7",
         "yaml": "^2.3.4"
     },
     "devDependencies": {
         "ts-node": "^10.9.2",
+        "tsup": "^8.3.5",
         "typescript": "5.3.3"
     }
 }