Merge pull request #1 from lafkpages/typedoc

TypeDoc

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+on: [push, pull_request]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.6.7
+
+      - name: Retrieve the cached "node_modules" directory (if present)
+        uses: actions/cache@v2
+        id: node-cache
+        with:
+          path: node_modules
+          key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies (if the cached directory was not found)
+        if: steps.node-cache.outputs.cache-hit != 'true'
+        run: pnpm i
+
+      - name: Create the docs directory locally in CI
+        run: pnpm build:docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,6 @@
+# TypeDoc generated documentation
+/docs
+
 # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
 
 # Logs

package.json

@@ -4,12 +4,19 @@
   "type": "module",
   "devDependencies": {
     "@electron/asar": "^3.2.7",
-    "bun-types": "latest"
+    "bun-types": "latest",
+    "typedoc": "^0.25.2"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
   "dependencies": {
     "@tybys/chromium-pickle-js": "^1.0.0"
+  },
+  "scripts": {
+    "build": "bun scripts/build.ts",
+    "build:docs": "typedoc src/index.ts",
+    "pretest": "bun scripts/cleanup-test-data.ts",
+    "test": "bun test"
   }
-}
+}

scripts/build.ts

@@ -0,0 +1,14 @@
+import { rm } from "fs/promises";
+
+const outdir = "dist";
+
+await rm(outdir, { recursive: true, force: true });
+
+await Bun.build({
+  entrypoints: ["src/index.ts"],
+  target: "node",
+  minify: true,
+  sourcemap: "external",
+  outdir,
+  splitting: true,
+});

scripts/cleanup-test-data.ts

@@ -0,0 +1,13 @@
+import { rm, readdir } from "fs/promises";
+import { join as joinPaths } from "path";
+
+// rm -f test/ignore/*.{js,json,txt}
+// rm -f test/ignore/app-*.asar
+
+const ignoreDir = "test/ignore";
+
+for (const file of await readdir(ignoreDir)) {
+  if (/\.(js|json|txt)$|^app-.+\.asar/.test(file)) {
+    await rm(joinPaths(ignoreDir, file));
+  }
+}

typedoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "basePath": "src"
+}