docs: clarify GitHub App description and fix package.json

ubiquity-os-marketplace · Feb 8, 2025 · dcca1f2 · dcca1f2
1 parent 42ea1a6
commit dcca1f2
Show file tree

Hide file tree

Showing 6 changed files with 2,304 additions and 7,113 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This plugin allows a hunter to begin a task as well as gracefully stop a task wi
 
 ### Overview
 
-- Built as a GitHub App using TypeScript
+- Implemented as a GitHub App (a server-side application that extends GitHub's functionality) using TypeScript
 - Uses Supabase for data persistence
 - Implements a webhook-based event system for GitHub interactions
 - Runs as a Cloudflare Worker using Hono for HTTP handling
@@ -127,7 +127,7 @@ bun run worker
 Run the full test suite:
 
 ```bash
-bun test
+bun run test
 ```
 
 ### Code Quality

diff --git a/bun.lock b/bun.lock
diff --git a/jest.config.ts b/jest.config.ts
@@ -22,6 +22,7 @@ const cfg: Config = {
     "^(\\.{1,2}/.*)\\.js$": "$1",
   },
   setupFilesAfterEnv: ["dotenv/config"],
+  transformIgnorePatterns: ["/node_modules/(?!(@octokit|@ubiquity-os)/).*"],
 };
 
 export default cfg;
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "knip": "knip --config .github/knip.ts",
     "knip-ci": "knip --no-exit-code --reporter json --config .github/knip.ts",
     "prepare": "husky install",
-    "test": "jest",
+    "test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --setupFiles dotenv/config --coverage",
     "worker": "wrangler dev --env dev --port 4000"
   },
   "trustedDependencies": [
@@ -55,6 +55,7 @@
     "@types/jest": "29.5.12",
     "@types/ms": "^0.7.34",
     "@types/node": "20.14.5",
+    "cross-env": "^7.0.3",
     "cspell": "8.9.0",
     "eslint": "9.14.0",
     "eslint-config-prettier": "9.1.0",

diff --git a/tests/main.test.ts b/tests/main.test.ts
@@ -18,7 +18,7 @@ dotenv.config();
 type Issue = Context<"issue_comment.created">["payload"]["issue"];
 type PayloadSender = Context["payload"]["sender"];
 
-const octokit = await import("@octokit/rest");
+import { Octokit } from "@octokit/rest";
 const TEST_REPO = "ubiquity/test-repo";
 const PRIORITY_ONE = { name: "Priority: 1 (Normal)", allowedRoles: ["collaborator", "contributor"] };
 const priority3LabelName = "Priority: 3 (High)";
@@ -741,7 +741,7 @@ export function createContext(
       rolesWithReviewAuthority: [Role.ADMIN, Role.OWNER, Role.MEMBER],
       requiredLabelsToStart,
     },
-    octokit: new octokit.Octokit(),
+    octokit: new Octokit(),
     eventName: "issue_comment.created" as SupportedEvents,
     organizations: ["ubiquity"],
     env: {