@ghfs/cli 0.0.1 → 0.0.2

package/dist/factory-CNz1r4PQ.mjs

@@ -0,0 +1,428 @@
+import { retry } from "@octokit/plugin-retry";
+import { throttling } from "@octokit/plugin-throttling";
+import { Octokit } from "octokit";
+
+//#region src/utils/repo.ts
+function splitRepo(repo) {
+	const [owner, name] = repo.split("/");
+	if (!owner || !name) throw new Error(`Invalid repo slug: ${repo}`);
+	return {
+		owner,
+		repo: name
+	};
+}
+
+//#endregion
+//#region src/providers/helpers.ts
+async function collectPages(pages) {
+	const items = [];
+	for await (const page of pages) items.push(...page);
+	return items;
+}
+async function* iteratePages(pages) {
+	for await (const page of pages) for (const item of page) yield item;
+}
+
+//#endregion
+//#region src/providers/github/client.ts
+const BaseOctokit = Octokit.plugin(retry, throttling);
+function createGitHubClient(token) {
+	return new BaseOctokit({
+		auth: token,
+		throttle: {
+			onRateLimit: (retryAfter, options) => {
+				if ((options.request.retryCount ?? 0) < 2) return true;
+				return false;
+			},
+			onSecondaryRateLimit: () => {
+				return false;
+			}
+		},
+		retry: {
+			doNotRetry: [401, 403],
+			retries: 2
+		}
+	});
+}
+
+//#endregion
+//#region src/providers/github/provider.ts
+function createGitHubProvider(options) {
+	const octokit = createGitHubClient(options.token);
+	const { owner, repo } = options;
+	let requestCount = 0;
+	const bumpRequestCount = () => {
+		requestCount += 1;
+	};
+	return {
+		paginateItems: (paginateOptions) => paginateItems(octokit, owner, repo, paginateOptions, bumpRequestCount),
+		fetchItems: (paginateOptions) => fetchItems(octokit, owner, repo, paginateOptions, bumpRequestCount),
+		eachItem: (paginateOptions) => eachItem(octokit, owner, repo, paginateOptions, bumpRequestCount),
+		fetchItemsByNumbers: (numbers) => fetchItemsByNumbers(octokit, owner, repo, numbers, bumpRequestCount),
+		fetchComments: (number) => fetchComments(octokit, owner, repo, number, bumpRequestCount),
+		fetchPullMetadata: (number) => fetchPullMetadata(octokit, owner, repo, number, bumpRequestCount),
+		fetchPullPatch: (number) => fetchPullPatch(octokit, owner, repo, number, bumpRequestCount),
+		fetchItemSnapshot: (number) => fetchItemSnapshot(octokit, owner, repo, number, bumpRequestCount),
+		fetchRepository: () => fetchRepository(octokit, owner, repo, bumpRequestCount),
+		fetchRepositoryLabels: () => fetchRepositoryLabels(octokit, owner, repo, bumpRequestCount),
+		fetchRepositoryMilestones: () => fetchRepositoryMilestones(octokit, owner, repo, bumpRequestCount),
+		getRequestCount: () => requestCount,
+		actionClose: (number) => actionClose(octokit, owner, repo, number, bumpRequestCount),
+		actionReopen: (number) => actionReopen(octokit, owner, repo, number, bumpRequestCount),
+		actionSetTitle: (number, title) => actionSetTitle(octokit, owner, repo, number, title, bumpRequestCount),
+		actionSetBody: (number, body) => actionSetBody(octokit, owner, repo, number, body, bumpRequestCount),
+		actionAddComment: (number, body) => actionAddComment(octokit, owner, repo, number, body, bumpRequestCount),
+		actionAddLabels: (number, labels) => actionAddLabels(octokit, owner, repo, number, labels, bumpRequestCount),
+		actionRemoveLabels: (number, labels) => actionRemoveLabels(octokit, owner, repo, number, labels, bumpRequestCount),
+		actionSetLabels: (number, labels) => actionSetLabels(octokit, owner, repo, number, labels, bumpRequestCount),
+		actionAddAssignees: (number, assignees) => actionAddAssignees(octokit, owner, repo, number, assignees, bumpRequestCount),
+		actionRemoveAssignees: (number, assignees) => actionRemoveAssignees(octokit, owner, repo, number, assignees, bumpRequestCount),
+		actionSetAssignees: (number, assignees) => actionSetAssignees(octokit, owner, repo, number, assignees, bumpRequestCount),
+		actionSetMilestone: (number, milestone) => actionSetMilestone(octokit, owner, repo, number, milestone, bumpRequestCount),
+		actionClearMilestone: (number) => actionClearMilestone(octokit, owner, repo, number, bumpRequestCount),
+		actionLock: (number, reason) => actionLock(octokit, owner, repo, number, reason, bumpRequestCount),
+		actionUnlock: (number) => actionUnlock(octokit, owner, repo, number, bumpRequestCount),
+		actionRequestReviewers: (number, reviewers) => actionRequestReviewers(octokit, owner, repo, number, reviewers, bumpRequestCount),
+		actionRemoveReviewers: (number, reviewers) => actionRemoveReviewers(octokit, owner, repo, number, reviewers, bumpRequestCount),
+		actionMarkReadyForReview: (number) => actionMarkReadyForReview(octokit, owner, repo, number, bumpRequestCount),
+		actionConvertToDraft: (number) => actionConvertToDraft(octokit, owner, repo, number, bumpRequestCount)
+	};
+}
+async function* paginateItems(octokit, owner, repo, options, bumpRequestCount) {
+	const iterator = octokit.paginate.iterator(octokit.rest.issues.listForRepo, {
+		owner,
+		repo,
+		state: options.state,
+		sort: "updated",
+		direction: "asc",
+		per_page: 100,
+		since: options.since
+	});
+	for await (const page of iterator) {
+		bumpRequestCount();
+		yield page.data.map(mapIssue);
+	}
+}
+async function fetchItems(octokit, owner, repo, options, bumpRequestCount) {
+	return await collectPages(paginateItems(octokit, owner, repo, options, bumpRequestCount));
+}
+async function* eachItem(octokit, owner, repo, options, bumpRequestCount) {
+	yield* iteratePages(paginateItems(octokit, owner, repo, options, bumpRequestCount));
+}
+async function fetchItemsByNumbers(octokit, owner, repo, numbers, bumpRequestCount) {
+	return (await Promise.all(numbers.map(async (number) => {
+		bumpRequestCount();
+		return mapIssue((await octokit.rest.issues.get({
+			owner,
+			repo,
+			issue_number: number
+		})).data);
+	}))).sort((a, b) => a.number - b.number);
+}
+async function fetchComments(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	return (await octokit.paginate(octokit.rest.issues.listComments, {
+		owner,
+		repo,
+		issue_number: number,
+		per_page: 100
+	})).map(mapComment);
+}
+async function fetchPullMetadata(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	const pull = (await octokit.rest.pulls.get({
+		owner,
+		repo,
+		pull_number: number
+	})).data;
+	return {
+		isDraft: pull.draft,
+		merged: pull.merged,
+		mergedAt: pull.merged_at,
+		baseRef: pull.base.ref,
+		headRef: pull.head.ref,
+		requestedReviewers: pull.requested_reviewers.map((reviewer) => reviewer.login)
+	};
+}
+async function fetchPullPatch(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	const result = await octokit.request("GET /repos/{owner}/{repo}/pulls/{pull_number}", {
+		owner,
+		repo,
+		pull_number: number,
+		mediaType: { format: "patch" }
+	});
+	if (typeof result.data === "string") return result.data;
+	throw new Error(`Unexpected patch response for pull #${number}`);
+}
+async function fetchItemSnapshot(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	const issue = (await octokit.rest.issues.get({
+		owner,
+		repo,
+		issue_number: number
+	})).data;
+	return {
+		number,
+		kind: issue.pull_request ? "pull" : "issue",
+		updatedAt: issue.updated_at ?? null
+	};
+}
+async function fetchRepository(octokit, owner, repo, bumpRequestCount) {
+	bumpRequestCount();
+	return (await octokit.rest.repos.get({
+		owner,
+		repo
+	})).data;
+}
+async function fetchRepositoryLabels(octokit, owner, repo, bumpRequestCount) {
+	bumpRequestCount();
+	return await octokit.paginate(octokit.rest.issues.listLabelsForRepo, {
+		owner,
+		repo,
+		per_page: 100
+	});
+}
+async function fetchRepositoryMilestones(octokit, owner, repo, bumpRequestCount) {
+	bumpRequestCount();
+	return await octokit.paginate(octokit.rest.issues.listMilestones, {
+		owner,
+		repo,
+		state: "all",
+		per_page: 100
+	});
+}
+async function actionClose(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		state: "closed"
+	});
+}
+async function actionReopen(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		state: "open"
+	});
+}
+async function actionSetTitle(octokit, owner, repo, number, title, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		title
+	});
+}
+async function actionSetBody(octokit, owner, repo, number, body, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		body
+	});
+}
+async function actionAddComment(octokit, owner, repo, number, body, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.createComment({
+		owner,
+		repo,
+		issue_number: number,
+		body
+	});
+}
+async function actionAddLabels(octokit, owner, repo, number, labels, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.addLabels({
+		owner,
+		repo,
+		issue_number: number,
+		labels
+	});
+}
+async function actionRemoveLabels(octokit, owner, repo, number, labels, bumpRequestCount) {
+	for (const label of labels) try {
+		bumpRequestCount();
+		await octokit.rest.issues.removeLabel({
+			owner,
+			repo,
+			issue_number: number,
+			name: label
+		});
+	} catch (error) {
+		if (error.status !== 404) throw error;
+	}
+}
+async function actionSetLabels(octokit, owner, repo, number, labels, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.setLabels({
+		owner,
+		repo,
+		issue_number: number,
+		labels
+	});
+}
+async function actionAddAssignees(octokit, owner, repo, number, assignees, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.addAssignees({
+		owner,
+		repo,
+		issue_number: number,
+		assignees
+	});
+}
+async function actionRemoveAssignees(octokit, owner, repo, number, assignees, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.removeAssignees({
+		owner,
+		repo,
+		issue_number: number,
+		assignees
+	});
+}
+async function actionSetAssignees(octokit, owner, repo, number, assignees, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		assignees
+	});
+}
+async function actionSetMilestone(octokit, owner, repo, number, milestone, bumpRequestCount) {
+	const resolvedMilestone = await resolveMilestone(octokit, owner, repo, milestone, bumpRequestCount);
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		milestone: resolvedMilestone
+	});
+}
+async function actionClearMilestone(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.update({
+		owner,
+		repo,
+		issue_number: number,
+		milestone: null
+	});
+}
+async function actionLock(octokit, owner, repo, number, reason, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.lock({
+		owner,
+		repo,
+		issue_number: number,
+		lock_reason: normalizeLockReason(reason)
+	});
+}
+async function actionUnlock(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.issues.unlock({
+		owner,
+		repo,
+		issue_number: number
+	});
+}
+async function actionRequestReviewers(octokit, owner, repo, number, reviewers, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.pulls.requestReviewers({
+		owner,
+		repo,
+		pull_number: number,
+		reviewers
+	});
+}
+async function actionRemoveReviewers(octokit, owner, repo, number, reviewers, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.rest.pulls.removeRequestedReviewers({
+		owner,
+		repo,
+		pull_number: number,
+		reviewers
+	});
+}
+async function actionMarkReadyForReview(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.request("POST /repos/{owner}/{repo}/pulls/{pull_number}/ready_for_review", {
+		owner,
+		repo,
+		pull_number: number
+	});
+}
+async function actionConvertToDraft(octokit, owner, repo, number, bumpRequestCount) {
+	bumpRequestCount();
+	await octokit.request("POST /repos/{owner}/{repo}/pulls/{pull_number}/convert-to-draft", {
+		owner,
+		repo,
+		pull_number: number
+	});
+}
+async function resolveMilestone(octokit, owner, repo, value, bumpRequestCount) {
+	if (typeof value === "number") return value;
+	if (/^\d+$/.test(value)) return Number(value);
+	bumpRequestCount();
+	const matched = (await octokit.paginate(octokit.rest.issues.listMilestones, {
+		owner,
+		repo,
+		state: "all",
+		per_page: 100
+	})).find((item) => item.title === value);
+	if (!matched) throw new Error(`Milestone not found: ${value}`);
+	return matched.number;
+}
+function normalizeLockReason(reason) {
+	if (!reason) return void 0;
+	if (reason === "too-heated") return "too heated";
+	return reason;
+}
+function mapIssue(issue) {
+	return {
+		number: issue.number,
+		kind: issue.pull_request ? "pull" : "issue",
+		...issue.html_url ? { url: issue.html_url } : {},
+		state: issue.state === "closed" ? "closed" : "open",
+		updatedAt: issue.updated_at,
+		createdAt: issue.created_at,
+		closedAt: issue.closed_at,
+		title: issue.title,
+		body: issue.body,
+		author: issue.user?.login ?? null,
+		labels: issue.labels.map((label) => {
+			if (typeof label === "string") return label;
+			return label.name ?? void 0;
+		}).filter((label) => Boolean(label)),
+		assignees: (issue.assignees ?? []).map((assignee) => assignee.login),
+		milestone: issue.milestone?.title ?? null
+	};
+}
+function mapComment(comment) {
+	return {
+		id: comment.id,
+		body: comment.body,
+		createdAt: comment.created_at,
+		updatedAt: comment.updated_at,
+		author: comment.user?.login ?? null
+	};
+}
+
+//#endregion
+//#region src/providers/factory.ts
+function createRepositoryProvider(options) {
+	const { owner, repo } = splitRepo(options.repo);
+	return createGitHubProvider({
+		token: options.token,
+		owner,
+		repo
+	});
+}
+
+//#endregion
+export { createRepositoryProvider as t };

package/dist/index.d.mts

@@ -0,0 +1,194 @@
+//#region src/types/config.d.ts
+interface GhfsUserConfig {
+  /**
+   * The repository to sync.
+   *
+   * Will try to detect the repository from the current working directory or the `package.json` file.
+   */
+  repo?: string;
+  /**
+   * The directory to store the synced issues and pull requests.
+   *
+   * @default '.ghfs'
+   */
+  directory?: string;
+  /**
+   * The authentication configuration.
+   */
+  auth?: {
+    /**
+     * The GitHub personal access token to use for authentication.
+     *
+     * When not provided, will try to get the token from `gh auth token` or the environment variables `GH_TOKEN` or `GITHUB_TOKEN`.
+     */
+    token?: string;
+  };
+  sync?: {
+    /**
+     * Whether to sync issues.
+     *
+     * @default true
+     */
+    issues?: boolean;
+    /**
+     * Whether to sync pull requests.
+     *
+     * @default true
+     */
+    pulls?: boolean;
+    /**
+     * When to sync closed issues and pull requests.
+     *
+     * - `'existing'`: only sync closed issues and pull requests that already exist in the local filesystem.
+     * - `'all'`: sync all closed issues and pull requests.
+     * - `false`: don't sync any closed issues and pull requests. And delete any existing closed issues and pull requests from the local filesystem.
+     *
+     * @default 'existing'
+     */
+    closed?: 'existing' | 'all' | false;
+    /**
+     * When to download the pull request patch files.
+     *
+     * - `'open'`: only download open pull request patch files.
+     * - `'all'`: download all pull request patch files.
+     * - `false`: don't download any pull request patch files.
+     *
+     * @default 'open'
+     */
+    patches?: 'open' | 'all' | false;
+  };
+}
+type GhfsResolvedConfig = Required<GhfsUserConfig> & {
+  cwd: string;
+  auth: Required<GhfsUserConfig['auth']>;
+  sync: Required<GhfsUserConfig['sync']>;
+};
+//#endregion
+//#region src/types/issue.d.ts
+type IssueKind = 'issue' | 'pull';
+type IssueState = 'open' | 'closed';
+//#endregion
+//#region src/types/provider.d.ts
+interface ProviderItem {
+  number: number;
+  kind: IssueKind;
+  url?: string;
+  state: IssueState;
+  updatedAt: string;
+  createdAt: string;
+  closedAt: string | null;
+  title: string;
+  body: string | null;
+  author: string | null;
+  labels: string[];
+  assignees: string[];
+  milestone: string | null;
+}
+interface ProviderComment {
+  id: number;
+  body: string | null;
+  createdAt: string;
+  updatedAt: string;
+  author: string | null;
+}
+interface ProviderPullMetadata {
+  isDraft: boolean;
+  merged: boolean;
+  mergedAt: string | null;
+  baseRef: string;
+  headRef: string;
+  requestedReviewers: string[];
+}
+interface ProviderRepository {
+  name: string;
+  full_name: string;
+  description: string | null;
+  private: boolean;
+  archived: boolean;
+  default_branch: string;
+  html_url: string;
+  fork: boolean;
+  open_issues_count: number;
+  has_issues: boolean;
+  has_projects: boolean;
+  has_wiki: boolean;
+  created_at: string;
+  updated_at: string;
+  pushed_at: string | null;
+  owner: {
+    login: string;
+  };
+}
+interface ProviderLabel {
+  name: string;
+  color: string;
+  description: string | null;
+  default: boolean;
+}
+interface ProviderMilestone {
+  number: number;
+  title: string;
+  state: 'open' | 'closed';
+  description: string | null;
+  due_on: string | null;
+  open_issues: number;
+  closed_issues: number;
+  created_at: string;
+  updated_at: string;
+  closed_at: string | null;
+}
+interface ProviderItemSnapshot {
+  number: number;
+  kind: IssueKind;
+  updatedAt: string | null;
+}
+type ProviderLockReason = 'resolved' | 'off-topic' | 'too heated' | 'too-heated' | 'spam';
+interface PaginateItemsOptions {
+  state: IssueState | 'all';
+  since?: string;
+}
+interface RepositoryProvider {
+  paginateItems: (options: PaginateItemsOptions) => AsyncIterable<ProviderItem[]>;
+  fetchItems: (options: PaginateItemsOptions) => Promise<ProviderItem[]>;
+  eachItem: (options: PaginateItemsOptions) => AsyncIterable<ProviderItem>;
+  fetchItemsByNumbers: (numbers: number[]) => Promise<ProviderItem[]>;
+  fetchComments: (number: number) => Promise<ProviderComment[]>;
+  fetchPullMetadata: (number: number) => Promise<ProviderPullMetadata>;
+  fetchPullPatch: (number: number) => Promise<string>;
+  fetchItemSnapshot: (number: number) => Promise<ProviderItemSnapshot>;
+  fetchRepository: () => Promise<ProviderRepository>;
+  fetchRepositoryLabels: () => Promise<ProviderLabel[]>;
+  fetchRepositoryMilestones: () => Promise<ProviderMilestone[]>;
+  getRequestCount: () => number;
+  actionClose: (number: number) => Promise<void>;
+  actionReopen: (number: number) => Promise<void>;
+  actionSetTitle: (number: number, title: string) => Promise<void>;
+  actionSetBody: (number: number, body: string) => Promise<void>;
+  actionAddComment: (number: number, body: string) => Promise<void>;
+  actionAddLabels: (number: number, labels: string[]) => Promise<void>;
+  actionRemoveLabels: (number: number, labels: string[]) => Promise<void>;
+  actionSetLabels: (number: number, labels: string[]) => Promise<void>;
+  actionAddAssignees: (number: number, assignees: string[]) => Promise<void>;
+  actionRemoveAssignees: (number: number, assignees: string[]) => Promise<void>;
+  actionSetAssignees: (number: number, assignees: string[]) => Promise<void>;
+  actionSetMilestone: (number: number, milestone: string | number) => Promise<void>;
+  actionClearMilestone: (number: number) => Promise<void>;
+  actionLock: (number: number, reason?: ProviderLockReason) => Promise<void>;
+  actionUnlock: (number: number) => Promise<void>;
+  actionRequestReviewers: (number: number, reviewers: string[]) => Promise<void>;
+  actionRemoveReviewers: (number: number, reviewers: string[]) => Promise<void>;
+  actionMarkReadyForReview: (number: number) => Promise<void>;
+  actionConvertToDraft: (number: number) => Promise<void>;
+}
+//#endregion
+//#region src/providers/factory.d.ts
+interface CreateRepositoryProviderOptions {
+  token: string;
+  repo: string;
+}
+declare function createRepositoryProvider(options: CreateRepositoryProviderOptions): RepositoryProvider;
+//#endregion
+//#region src/index.d.ts
+declare function defineConfig(config: GhfsUserConfig): GhfsUserConfig;
+//#endregion
+export { type GhfsResolvedConfig, type GhfsUserConfig, type IssueKind, type IssueState, type PaginateItemsOptions, type ProviderComment, type ProviderItem, type ProviderItemSnapshot, type ProviderLockReason, type ProviderPullMetadata, type RepositoryProvider, createRepositoryProvider, defineConfig };

package/dist/index.mjs

@@ -0,0 +1,9 @@
+import { t as createRepositoryProvider } from "./factory-CNz1r4PQ.mjs";
+
+//#region src/index.ts
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+export { createRepositoryProvider, defineConfig };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ghfs/cli",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "GitHub issues/PRs as filesystem, for offline view and operations in batch. Designed for human and agents.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",