pulls.review 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,16 @@
+# pulls.review
+
+Review local git changes in the browser, grouped and summarized like a pull request on [pulls.review](https://pulls.review).
+
+```sh
+npx pulls.review               # the current branch against the default branch (or a ref picker on main)
+npx pulls.review main...feat   # what feat adds since it forked from main
+npx pulls.review v1..v2        # the tree diff between two revisions
+npx pulls.review feat          # a branch against the default branch
+npx pulls.review HEAD          # one commit against its parent
+npx pulls.review --worktree    # uncommitted changes against HEAD, untracked files included
+```
+
+Run it inside a git repository. It serves on `localhost` through [devframe](https://github.com/devframes/devframe) and opens the page for the argument; any other branch, range or commit can be picked from `/`. The tab is trusted with a one-time code printed in the terminal. Reviewed marks and AI results are cached in `.git/pulls-review`.
+
+To analyze a GitHub pull request in CI, use [`@pulls.review/actions`](../actions).

package/bin.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './dist/index.mjs'

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "pulls.review",
   "type": "module",
-  "version": "0.1.0",
-  "description": "Analyze a GitHub pull request with pulls.review and post the grouped summary as a PR comment.",
+  "version": "0.2.0",
+  "description": "Review local git changes - the working tree, a commit or any range - grouped and summarized in the browser.",
   "author": "Anthony Fu <hi@antfu.me>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/antfu",
@@ -16,30 +16,38 @@
   "keywords": [
     "pull-request",
     "code-review",
-    "github-actions",
-    "llm"
+    "git",
+    "devframe"
   ],
+  "exports": {
+    "./devframe": "./dist/devframe.mjs"
+  },
   "bin": {
-    "pulls.review": "./dist/index.mjs",
-    "pulls-review": "./dist/index.mjs"
+    "pulls.review": "./bin.mjs",
+    "pulls-review": "./bin.mjs"
   },
   "files": [
+    "bin.mjs",
     "dist"
   ],
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
-    "@pulls.review/core": "^0.1.0",
-    "nostics": "^1.3.0"
+    "@pulls.review/core": "^0.2.0",
+    "devframe": "^1.2.0",
+    "h3": "^2.0.1-rc.32",
+    "unstorage": "^1.17.5"
   },
   "devDependencies": {
     "@types/node": "^26.6.4",
+    "tsdown": "^0.23.0",
     "typescript": "^6.0.3",
     "vitest": "^5.0.3"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "tsdown && pnpm -F @pulls.review/app run build:local",
+    "dev": "node bin.mjs",
     "typecheck": "tsc --noEmit",
     "test": "vitest run"
   }

package/dist/index.mjs

@@ -1,149 +0,0 @@
-#!/usr/bin/env node
-import { readFileSync } from "node:fs";
-import process from "node:process";
-import { parseArgs } from "node:util";
-import { githubTokenFromEnv, llmSettingsFromEnv } from "@pulls.review/core/env";
-import { runLlmAnalysis } from "@pulls.review/core/llm";
-import { Diagnostic, formatDiagnostic } from "nostics";
-import { DEFAULT_LOCALE, isLocale } from "@pulls.review/core/locales";
-import { resolveModel } from "@pulls.review/core/analyze";
-import { diagnostics } from "@pulls.review/core/diagnostics";
-import { createGithubPullRequestSource } from "@pulls.review/core/github";
-import { staticCredentials } from "@pulls.review/core/types";
-//#region src/config.ts
-/** The first value that is set and not blank: an Action passes unset inputs as `''`. */
-function first(...values) {
-	return values.find((value) => value);
-}
-function resolveGithubToken(env) {
-	const token = githubTokenFromEnv(env);
-	if (!token) throw new Error("A GitHub token is required: set GITHUB_TOKEN (or PULLS_REVIEW_GITHUB_TOKEN).");
-	return token;
-}
-function resolveLocale(env, flags = {}) {
-	const requested = first(flags.locale, env.PULLS_REVIEW_LOCALE);
-	if (requested === void 0) return DEFAULT_LOCALE;
-	if (!isLocale(requested)) throw new Error(`Unsupported locale "${requested}".`);
-	return requested;
-}
-/**
-* `owner/repo#123` or a github.com PR URL; in a workflow run, the PR the event is about.
-*/
-function resolveTarget(arg, env, event) {
-	if (arg) {
-		const match = arg.match(/^(?:https:\/\/github\.com\/)?([^/\s]+)\/([^/#\s]+)(?:#|\/pull\/)(\d+)\/?$/);
-		if (!match) throw new Error(`Cannot read a pull request from "${arg}": expected owner/repo#123 or a github.com pull request URL.`);
-		return {
-			owner: match[1],
-			repo: match[2],
-			number: match[3]
-		};
-	}
-	const [owner, repo] = env.GITHUB_REPOSITORY?.split("/") ?? [];
-	const number = event?.pull_request?.number;
-	if (!owner || !repo || number === void 0) throw new Error("No pull request given. Pass owner/repo#123, or run on a pull_request event in GitHub Actions.");
-	return {
-		owner,
-		repo,
-		number: String(number)
-	};
-}
-//#endregion
-//#region src/run.ts
-/** The author GitHub shows for a workflow's `GITHUB_TOKEN`, which cannot look itself up at `/user`. */
-const ACTIONS_BOT_LOGIN = "github-actions[bot]";
-function describeProgress(progress) {
-	switch (progress.kind) {
-		case "thinking": return `[${progress.step}] thinking`;
-		case "reading": return `[${progress.step}] reading ${progress.paths.length} file${progress.paths.length === 1 ? "" : "s"}`;
-		case "organizing": return `[${progress.step}] organizing groups`;
-	}
-}
-/**
-* Fetches the PR, analyzes it and upserts the shared-analysis comment, exactly like the
-* site's "share as comment" - one comment per author, found by its marker. A comment
-* already carrying the PR's current head sha is left alone, so re-runs on an unchanged
-* PR cost no model call.
-*/
-async function run({ pr, githubToken, llm, locale, log }, analyze) {
-	const resolved = resolveModel(llm);
-	if (!resolved) throw diagnostics.llmNotConfigured();
-	const source = createGithubPullRequestSource(pr, staticCredentials(githubToken));
-	const [diff, login, comments] = await Promise.all([
-		source.fetch(),
-		source.viewer().then((viewer) => viewer?.login ?? ACTIONS_BOT_LOGIN, () => ACTIONS_BOT_LOGIN),
-		source.sharing.list()
-	]);
-	const headSha = diff.head?.sha ?? "";
-	const existing = comments.find((comment) => comment.login === login);
-	if (existing && existing.analysis.headSha === headSha) return {
-		status: "up-to-date",
-		url: existing.url
-	};
-	log(`Analyzing ${pr.owner}/${pr.repo}#${pr.number} (${diff.files.length} files) with ${resolved.model.provider}/${resolved.model.id}`);
-	const { result } = await analyze(diff, resolved, locale, { onProgress: (progress) => log(describeProgress(progress)) });
-	return {
-		status: "posted",
-		url: (await source.sharing.upsert(login, {
-			headSha,
-			result
-		}, existing)).url
-	};
-}
-//#endregion
-//#region src/index.ts
-const HELP = `Usage: pulls.review [owner/repo#123 | https://github.com/owner/repo/pull/123] [options]
-
-Analyzes the pull request with an LLM and posts (or updates) the grouped summary as
-a PR comment that pulls.review picks up. Without a target, reads the pull_request
-event of the running GitHub Actions job.
-
-Options:
-  --provider <name>  gateway | anthropic | openai-compatible  (PULLS_REVIEW_PROVIDER)
-  --model <id>       model id for the provider                 (PULLS_REVIEW_MODEL)
-  --locale <tag>     language of the summaries, default en     (PULLS_REVIEW_LOCALE)
-  -h, --help
-
-Environment:
-  GITHUB_TOKEN           token with pull-requests: write       (PULLS_REVIEW_GITHUB_TOKEN)
-  AI_GATEWAY_API_KEY     Vercel AI Gateway key                  (PULLS_REVIEW_API_KEY)
-  ANTHROPIC_API_KEY      Anthropic key                          (PULLS_REVIEW_API_KEY)
-  OPENAI_API_KEY         OpenAI-compatible key                  (PULLS_REVIEW_API_KEY)
-  OPENAI_BASE_URL        OpenAI-compatible endpoint             (PULLS_REVIEW_BASE_URL)
-`;
-function readEvent(path) {
-	return path ? JSON.parse(readFileSync(path, "utf-8")) : void 0;
-}
-async function main() {
-	const { values: flags, positionals } = parseArgs({
-		options: {
-			provider: { type: "string" },
-			model: { type: "string" },
-			locale: { type: "string" },
-			help: {
-				type: "boolean",
-				short: "h"
-			}
-		},
-		allowPositionals: true
-	});
-	if (flags.help) {
-		console.log(HELP);
-		return;
-	}
-	const env = process.env;
-	const outcome = await run({
-		pr: resolveTarget(positionals[0], env, readEvent(env.GITHUB_EVENT_PATH)),
-		githubToken: resolveGithubToken(env),
-		llm: llmSettingsFromEnv(env, flags),
-		locale: resolveLocale(env, flags),
-		log: (line) => console.log(line)
-	}, runLlmAnalysis);
-	console.log(outcome.status === "up-to-date" ? `Comment already covers the current head: ${outcome.url}` : `Posted ${outcome.url}`);
-}
-main().catch((error) => {
-	console.error(error instanceof Diagnostic ? formatDiagnostic(error) : error instanceof Error ? error.message : String(error));
-	process.exitCode = 1;
-});
-//#endregion
-export {};