@airscript/ghitgud 2.0.0 → 2.1.0

package/README.md

@@ -54,6 +54,15 @@ ghitgud config get repo
 ## Commands
 
 ```
+ghitgud gh <args>              Pass through to the gh CLI
+ghitgud notifications list       List notifications
+ghitgud notifications list -a    Include read notifications
+ghitgud notifications list -p    Only participating
+ghitgud notifications list -r owner/repo  Filter by repository
+ghitgud notifications read <id>   Mark a notification as read
+ghitgud notifications done <id>   Mark a notification as done
+ghitgud activity                 Assigned issues, review requests, mentions
+ghitgud mentions                 Recent @mentions of you
 ghitgud ping                     Check if the CLI is working
 ghitgud labels list              List all labels for a repository
 ghitgud labels pull              Pull labels from a repository to local config

package/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

package/dist/index.js

@@ -39,6 +39,7 @@ let commander = require("commander");
 let figlet = require("figlet");
 figlet = __toESM(figlet);
 let consola = require("consola");
+let child_process = require("child_process");
 let path = require("path");
 path = __toESM(path);
 let fs = require("fs");
@@ -57,6 +58,29 @@ var ascii = figlet.default.textSync("Ghitgud", {
 //#region src/core/logger.ts
 var logger = (0, consola.createConsola)({ defaults: { tag: "ghitgud" } });
 //#endregion
+//#region src/commands/gh.ts
+var register$6 = (program) => {
+	program.command("gh").description("Pass through to the gh CLI. Usage: ghitgud gh <args>").allowUnknownOption().action((_opts, command) => {
+		const args = command.args;
+		const child = (0, child_process.spawn)("gh", args, {
+			stdio: "inherit",
+			shell: false
+		});
+		child.on("error", (error) => {
+			if (error.code === "ENOENT") {
+				logger.error("gh CLI is not installed. Install it from https://cli.github.com.");
+				process$1.default.exit(1);
+			}
+			logger.error(String(error));
+			process$1.default.exit(1);
+		});
+		child.on("exit", (code) => {
+			process$1.default.exitCode = code ?? 0;
+		});
+	});
+};
+var gh_default = { register: register$6 };
+//#endregion
 //#region src/core/constants.ts
 var GHITGUD_FOLDER = path.default.join(os.default.homedir(), ".config", "ghitgud");
 var CREDENTIALS_FILE = "credentials.json";
@@ -76,6 +100,7 @@ var ERROR_NO_REPO = "Repository not configured. Set it with: ghitgud config set
 var ERROR_NO_TOKEN = "Token not configured. Set it with: ghitgud config set token <your-token>.";
 var ERROR_UNSUPPORTED_KEY = "Trying to set unsupported key.";
 var ERROR_NO_METADATA = "No metadata file found.";
+var INFO_NO_NOTIFICATIONS = "No notifications found.";
 var PING_RESPONSE = "pong";
 var SUPPORTED_CONFIG_KEYS = ["token", "repo"];
 //#endregion
@@ -562,6 +587,10 @@ var client = {
 		method: "PATCH",
 		body
 	}),
+	put: (endpoint, body) => request(endpoint, {
+		method: "PUT",
+		body
+	}),
 	getRepo: () => config.getRepo(),
 	isOk: (status) => isSuccessful(status),
 	isNotFound: (status) => status === 404,
@@ -624,7 +653,7 @@ var ping = () => {
 		message: PING_RESPONSE
 	};
 };
-var list = async () => {
+var list$1 = async () => {
 	logger.info("Fetching labels from repository.");
 	const labels$1 = (await (await labels.fetch()).json()).map((label) => normalizeLabel(label));
 	formatLabels(labels$1);
@@ -697,7 +726,7 @@ var prune = async () => {
 };
 var labels_default$1 = {
 	ping,
-	list,
+	list: list$1,
 	pull,
 	pullTemplate,
 	push,
@@ -706,13 +735,13 @@ var labels_default$1 = {
 };
 //#endregion
 //#region src/commands/ping.ts
-var register$2 = (program) => {
+var register$5 = (program) => {
 	program.command("ping").description("Check if the CLI is working.").action(() => void labels_default$1.ping());
 };
-var ping_default = { register: register$2 };
+var ping_default = { register: register$5 };
 //#endregion
 //#region src/commands/labels.ts
-var register$1 = (program) => {
+var register$4 = (program) => {
 	const labels = program.command("labels").description("Manage labels for a repository.");
 	labels.command("list").description("List all labels for a repository.").action(() => void labels_default$1.list());
 	labels.command("pull").description("Pull all related labels for a repository.").option("-t, --template <name>", "Pull from a built-in template instead of the remote repository").action(async (options) => {
@@ -725,7 +754,7 @@ var register$1 = (program) => {
 	});
 	labels.command("prune").description("Prune all related labels for a repository.").action(() => void labels_default$1.prune());
 };
-var labels_default = { register: register$1 };
+var labels_default = { register: register$4 };
 //#endregion
 //#region src/services/config.ts
 var validateKey = (key) => {
@@ -755,7 +784,7 @@ var config_default$1 = {
 };
 //#endregion
 //#region src/commands/config.ts
-var register = (program) => {
+var register$3 = (program) => {
 	const config = program.command("config").description("Set CLI configurations.");
 	config.command("set").description("Set configuration.").arguments("<key> <value>").action((key, value) => {
 		config_default$1.set(key, value);
@@ -764,10 +793,198 @@ var register = (program) => {
 		config_default$1.get(key);
 	});
 };
-var config_default = { register };
+var config_default = { register: register$3 };
+//#endregion
+//#region src/api/notifications.ts
+var BASE_PATH = "/notifications";
+var notifications = {
+	fetch: (params) => {
+		const query = new URLSearchParams();
+		if (params?.all) query.set("all", "true");
+		if (params?.participating) query.set("participating", "true");
+		if (params?.perPage) query.set("per_page", String(params.perPage));
+		const qs = query.toString();
+		const endpoint = qs ? `${BASE_PATH}?${qs}` : BASE_PATH;
+		return client.get(endpoint);
+	},
+	markRead: (id) => {
+		return client.patch(`/notifications/threads/${id}`, {});
+	},
+	markDone: (id) => {
+		return client.put(`/notifications/threads/${id}/subscription`, { ignored: true });
+	},
+	assignedIssues: () => {
+		return client.get("/issues?filter=assigned&state=open");
+	},
+	reviewRequests: () => {
+		return client.get("/search/issues?q=is:pr+is:open+review-requested:@me");
+	},
+	mentions: (username) => {
+		const since = (/* @__PURE__ */ new Date(Date.now() - 10080 * 60 * 1e3)).toISOString().split("T")[0];
+		return client.get(`/search/issues?q=mentions:${username}+updated:>${since}`);
+	}
+};
+//#endregion
+//#region src/types/notifications.ts
+var normalizeThread = (item) => {
+	const data = item;
+	const repo = data.repository ?? {};
+	const subject = data.subject ?? {};
+	return {
+		id: String(data.id),
+		repository: String(repo.full_name ?? ""),
+		subjectTitle: String(subject.title ?? ""),
+		subjectType: String(subject.type ?? ""),
+		reason: String(data.reason ?? ""),
+		unread: Boolean(data.unread),
+		updatedAt: String(data.updated_at ?? "")
+	};
+};
+var normalizeIssue = (item) => {
+	const data = item;
+	const repo = data.repository ?? {};
+	return {
+		id: String(data.id),
+		repository: String(repo.full_name ?? ""),
+		subjectTitle: String(data.title ?? ""),
+		subjectType: String(data.pull_request ? "PullRequest" : "Issue"),
+		reason: "assigned",
+		unread: false,
+		updatedAt: String(data.updated_at ?? "")
+	};
+};
+var normalizeSearchItem = (item) => {
+	const data = item;
+	return {
+		id: String(data.id),
+		repository: String(data.repository_url ?? "").replace("https://api.github.com/repos/", ""),
+		subjectTitle: String(data.title ?? ""),
+		subjectType: String(data.pull_request ? "PullRequest" : "Issue"),
+		reason: "mention",
+		unread: false,
+		updatedAt: String(data.updated_at ?? "")
+	};
+};
+//#endregion
+//#region src/services/notifications.ts
+var formatTable = (notifications) => {
+	if (notifications.length === 0) {
+		logger.info(INFO_NO_NOTIFICATIONS);
+		return;
+	}
+	console.log();
+	console.table(notifications.map((n) => ({
+		repository: n.repository,
+		subject: n.subjectTitle,
+		type: n.subjectType,
+		reason: n.reason
+	})));
+};
+var list = async (options = {}) => {
+	logger.info("Fetching notifications.");
+	let notifications$1 = (await (await notifications.fetch({
+		all: options.all,
+		participating: options.participating,
+		perPage: options.limit
+	})).json()).map(normalizeThread);
+	if (options.repo) notifications$1 = notifications$1.filter((n) => n.repository === options.repo);
+	formatTable(notifications$1);
+	return {
+		success: true,
+		metadata: notifications$1
+	};
+};
+var markRead = async (id) => {
+	logger.info(`Marking notification ${id} as read.`);
+	await notifications.markRead(id);
+	logger.success("Notification marked as read.");
+	return { success: true };
+};
+var markDone = async (id) => {
+	logger.info(`Marking notification ${id} as done.`);
+	await notifications.markDone(id);
+	logger.success("Notification marked as done.");
+	return { success: true };
+};
+var activity = async () => {
+	logger.info("Fetching activity.");
+	const [issuesRes, reviewsRes, mentionsRes] = await Promise.all([
+		notifications.assignedIssues(),
+		notifications.reviewRequests(),
+		notifications.mentions("@me")
+	]);
+	const assignedIssues = await issuesRes.json();
+	const reviewData = await reviewsRes.json();
+	const mentionData = await mentionsRes.json();
+	const result = {
+		assignedIssues: assignedIssues.map(normalizeIssue),
+		reviewRequests: (reviewData.items ?? []).map(normalizeSearchItem),
+		recentMentions: (mentionData.items ?? []).map(normalizeSearchItem)
+	};
+	console.log();
+	console.log("Assigned Issues:", result.assignedIssues.length);
+	console.log("Review Requests:", result.reviewRequests.length);
+	console.log("Recent Mentions:", result.recentMentions.length);
+	return {
+		success: true,
+		metadata: result
+	};
+};
+var mentions = async () => {
+	logger.info("Fetching mentions.");
+	const notifications$2 = ((await (await notifications.mentions("@me")).json()).items ?? []).map(normalizeSearchItem);
+	formatTable(notifications$2);
+	return {
+		success: true,
+		metadata: notifications$2
+	};
+};
+var notifications_default$1 = {
+	list,
+	markRead,
+	markDone,
+	activity,
+	mentions
+};
+//#endregion
+//#region src/commands/mentions.ts
+var register$2 = (program) => {
+	program.command("mentions").description("Find recent @mentions of you.").action(() => void notifications_default$1.mentions());
+};
+var mentions_default = { register: register$2 };
+//#endregion
+//#region src/commands/activity.ts
+var register$1 = (program) => {
+	program.command("activity").description("Show assigned issues, review requests, and mentions.").action(() => void notifications_default$1.activity());
+};
+var activity_default = { register: register$1 };
+//#endregion
+//#region src/commands/notifications.ts
+var register = (program) => {
+	const notifications = program.command("notifications").description("Manage GitHub notifications.");
+	notifications.command("list").description("List notifications.").option("-a, --all", "Include read notifications").option("-p, --participating", "Only participating notifications").option("-r, --repo <owner/repo>", "Filter by repository").option("-l, --limit <n>", "Max results").action((options) => {
+		notifications_default$1.list({
+			all: options.all,
+			participating: options.participating,
+			repo: options.repo,
+			limit: options.limit ? parseInt(options.limit, 10) : void 0
+		});
+	});
+	notifications.command("read <id>").description("Mark a notification as read.").action((id) => {
+		notifications_default$1.markRead(id);
+	});
+	notifications.command("done <id>").description("Mark a notification as done.").action((id) => {
+		notifications_default$1.markDone(id);
+	});
+};
+var notifications_default = { register };
 //#endregion
 //#region src/cli/index.ts
-commander.program.name("ghitgud").description("A simple CLI to give superpowers to GitHub.").version("2.0.0");
+commander.program.name("ghitgud").description("A simple CLI to give superpowers to GitHub.").version("2.1.0");
+gh_default.register(commander.program);
+notifications_default.register(commander.program);
+activity_default.register(commander.program);
+mentions_default.register(commander.program);
 ping_default.register(commander.program);
 labels_default.register(commander.program);
 config_default.register(commander.program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@airscript/ghitgud",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A simple CLI to give superpowers to GitHub.",
   "main": "dist/index.js",
   "files": [
@@ -30,7 +30,8 @@
     "lint": "eslint src/ tests/",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "clean": "rm -rf dist coverage"
+    "clean": "rm -rf dist coverage",
+    "prepare": "husky && pnpm build"
   },
   "repository": {
     "type": "git",
@@ -49,6 +50,7 @@
     "@vitest/coverage-v8": "^3.2.4",
     "eslint": "10.3.0",
     "eslint-config-prettier": "10.1.8",
+    "husky": "9.1.7",
     "prettier": "3.8.3",
     "typescript": "^5.8.3",
     "typescript-eslint": "8.59.2",