feat: add TSDoc

withcatai · Aug 16, 2023 · e4b5a48 · e4b5a48
1 parent 98bdfff
commit e4b5a48
Show file tree

Hide file tree

Showing 8 changed files with 212 additions and 8 deletions.
diff --git a/.config/typedoc.css b/.config/typedoc.css
@@ -0,0 +1,7 @@
+.tsd-typography h4,
+.tsd-typography .tsd-index-panel h3,
+.tsd-index-panel .tsd-typography h3,
+.tsd-typography h5,
+.tsd-typography h6 {
+    margin: 1.2em 0 0.4em 0;
+}
diff --git a/.config/typedoc.json b/.config/typedoc.json
@@ -0,0 +1,14 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "entryPoints": ["../src/index.ts"],
+    "out": "../docs",
+    "tsconfig": "../tsconfig.json",
+    "customCss": "./typedoc.css",
+    "readme": "../README.md",
+    "excludeExternals": true,
+    "excludeInternal": true,
+    "excludePrivate": true,
+    "githubPages": true,
+    "hideGenerator": true,
+    "jsDocCompatibility": true
+}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -17,13 +17,20 @@ jobs:
         run: npm ci --ignore-scripts
       - name: Build
         run: npm run build
+      - name: Generate docs
+        run: npm run generate-docs
       - name: Download latest llama.cpp release
         run: node ./dist/cli/cli.js download --release latest --skipBuild
       - name: Upload build artifact
         uses: actions/upload-artifact@v3
         with:
           name: "build"
           path: "dist"
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: "docs"
+          path: "docs"
       - name: Upload llama.cpp artifact
         uses: actions/upload-artifact@v3
         with:
@@ -191,7 +198,12 @@ jobs:
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     concurrency: release-${{ github.ref }}
+    environment:
+      name: npm
+      url: ${{ steps.set-npm-url.outputs.npm-url }}
     permissions:
+      pages: write
+      id-token: write
       contents: write
       issues: write
       pull-requests: write
@@ -213,6 +225,7 @@ jobs:
           mkdir -p llamaBins
           mv artifacts/bins-*/* llamaBins/
           mv artifacts/build dist/
+          mv artifacts/docs docs/
           
           echo "Built binaries:"
           ls llamaBins
@@ -221,4 +234,15 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release
-
+      - name: Set npm package url to GITHUB_OUTPUT
+        id: set-npm-url
+        run: echo "npm-url=https://www.npmjs.com/package/node-llama-cpp/v/$(cat .npmPackage.version.txt)" >> $GITHUB_OUTPUT
+      - name: Upload docs to GitHub Pages
+        uses: actions/upload-pages-artifact@v2
+        with:
+          name: pages-docs
+          path: docs
+      - name: Deploy docs to GitHub Pages
+        uses: actions/deploy-pages@v2
+        with:
+          artifact_name: pages-docs
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ node_modules
 .DS_Store
 
 /dist
+/docs
 
 /.env
 /.eslintcache

diff --git a/.releaserc.json b/.releaserc.json
@@ -12,6 +12,9 @@
         }],
         "@semantic-release/release-notes-generator",
         "@semantic-release/npm",
-        "@semantic-release/github"
+        "@semantic-release/github",
+        ["@semantic-release/exec", {
+            "publishCmd": "echo \"${nextRelease.version}\" > .npmPackage.version.txt"
+        }]
     ]
 }
diff --git a/README.md b/README.md
@@ -129,7 +129,7 @@ console.log("AI: " + a1);
 ```
 
 ### CLI
-```txt
+```
 Usage: node-llama-cpp <command> [options]
 
 Commands:
@@ -140,11 +140,11 @@ Commands:
 
 Options:
   -h, --help     Show help                                                                 [boolean]
-  -v, --version  Show version number                                                       [boolean]                                                [boolean]
+  -v, --version  Show version number                                                       [boolean]
 ```
 
 #### `download` command
-```txt
+```
 node-llama-cpp download
 
 Download a release of llama.cpp and compile it
@@ -162,7 +162,7 @@ Options:
 ```
 
 #### `build` command
-```txt
+```
 node-llama-cpp build
 
 Compile the currently downloaded llama.cpp
@@ -175,7 +175,7 @@ Options:
 ```
 
 #### `clear` command
-```txt
+```
 node-llama-cpp clear [type]
 
 Clear files created by llama-cli
@@ -187,7 +187,7 @@ Options:
 ```
 
 #### `chat` command
-```txt
+```
 node-llama-cpp chat
 
 Chat with a LLama model

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
     "prepare": "[ $CI = true ] || [ -d '.husky/_' ] || husky install",
     "prebuild": "rm -rf ./dist ./tsconfig.tsbuildinfo",
     "build": "tsc --build tsconfig.json --force",
+    "generate-docs": "typedoc",
     "prewatch": "rm -rf ./dist ./tsconfig.tsbuildinfo",
     "watch": "tsc --build tsconfig.json --watch --force",
     "node-gyp-llama": "cd llama && node-gyp",
@@ -83,6 +84,7 @@
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
+    "@semantic-release/exec": "^6.0.3",
     "@types/bytes": "^3.1.1",
     "@types/cli-progress": "^3.11.0",
     "@types/cross-spawn": "^6.0.2",
@@ -99,6 +101,7 @@
     "semantic-release": "^21.0.7",
     "ts-node": "^10.9.1",
     "tslib": "^2.6.1",
+    "typedoc": "^0.24.8",
     "typescript": "^5.1.6",
     "zx": "^7.2.3"
   },