@bretwardjames/ghp-core 0.1.3 → 0.1.5

package/README.md

@@ -0,0 +1,123 @@
+# GHP Tools
+
+A suite of tools for managing GitHub Projects from your terminal and editor.
+
+## What's Included
+
+| Package | Description |
+|---------|-------------|
+| **[@bretwardjames/ghp-cli](https://github.com/bretwardjames/ghp-cli)** | Command-line interface for GitHub Projects |
+| **[vscode-gh-projects](https://github.com/bretwardjames/vscode-gh-projects)** | VS Code / Cursor extension with visual boards |
+| **@bretwardjames/ghp-core** | Shared library (this package) |
+
+Both the CLI and extension share the same underlying library and are designed to work together.
+
+## Quick Install
+
+Install both the CLI and VS Code/Cursor extension with a single command:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/bretwardjames/ghp-core/main/install.sh | bash
+```
+
+This will:
+1. Install the `ghp` CLI globally via npm
+2. Install the VS Code/Cursor extension from the latest release
+
+### Manual Installation
+
+**CLI only:**
+```bash
+npm install -g @bretwardjames/ghp-cli
+```
+
+**Extension only:**
+Download the `.vsix` from [releases](https://github.com/bretwardjames/vscode-gh-projects/releases) and install:
+```bash
+code --install-extension gh-projects-*.vsix
+# or for Cursor:
+cursor --install-extension gh-projects-*.vsix
+```
+
+## Getting Started
+
+1. Authenticate with GitHub:
+   ```bash
+   ghp auth
+   ```
+
+2. View your assigned work:
+   ```bash
+   ghp work
+   ```
+
+3. Open VS Code/Cursor and find the GitHub Projects panel in the sidebar
+
+## Features
+
+### Shared Across Both Tools
+
+- **Branch Linking** - Link branches to issues, track which issues have active work
+- **Workflow Automation** - "Start Working" creates branches and updates status
+- **Project Board Views** - See your boards exactly as configured on GitHub
+- **Issue Templates** - Create issues using your repo's templates
+
+### CLI-Specific
+
+- **Shortcuts** - Define named filter combinations (`ghp plan bugs`)
+- **Slice Filters** - Filter by any field (`--slice Priority=High`)
+- **Workspace Config** - Share settings with your team via `.ghp/config.json`
+- **Simple List Output** - Integration with fzf, rofi, and other pickers
+
+### Extension-Specific
+
+- **Drag and Drop** - Move issues between columns visually
+- **Planning Board** - Full-screen kanban view
+- **Multi-Select** - Bulk operations on multiple items
+- **Real-Time Sync** - Stay in sync with GitHub
+
+## Configuration
+
+Both tools share the same configuration concepts. The CLI uses JSON files, the extension uses VS Code settings.
+
+### CLI Configuration (ghp-cli)
+
+```bash
+# View all settings with their sources
+ghp config --show
+
+# Edit user config (opens $EDITOR)
+ghp config
+
+# Edit workspace config (shared with team)
+ghp config -w
+
+# Set individual value
+ghp config mainBranch develop
+```
+
+**Config files:**
+- User: `~/.config/ghp-cli/config.json` (personal overrides)
+- Workspace: `.ghp/config.json` (committed, shared with team)
+
+Merge order: defaults -> workspace -> user
+
+### Extension Configuration (VS Code)
+
+Settings are in VS Code's settings UI under "GitHub Projects", or in your workspace `.vscode/settings.json`.
+
+## Links
+
+- [ghp-cli Documentation](https://github.com/bretwardjames/ghp-cli)
+- [VS Code Extension Documentation](https://github.com/bretwardjames/vscode-gh-projects)
+- [Report Issues](https://github.com/bretwardjames/ghp-core/issues)
+
+## Requirements
+
+- Node.js >= 18
+- GitHub account with Projects access
+- VS Code 1.85+ or Cursor (for extension)
+
+## License
+
+MIT

package/dist/index.cjs

@@ -33,10 +33,13 @@ __export(index_exports, {
   detectRepository: () => detectRepository,
   fetchOrigin: () => fetchOrigin,
   generateBranchName: () => generateBranchName,
+  getAllBranches: () => getAllBranches,
   getCommitsAhead: () => getCommitsAhead,
   getCommitsBehind: () => getCommitsBehind,
   getCurrentBranch: () => getCurrentBranch,
   getDefaultBranch: () => getDefaultBranch,
+  getLocalBranches: () => getLocalBranches,
+  getRemoteBranches: () => getRemoteBranches,
   getRepositoryRoot: () => getRepositoryRoot,
   hasUncommittedChanges: () => hasUncommittedChanges,
   isGitRepository: () => isGitRepository,
@@ -1225,6 +1228,34 @@ function generateBranchName(pattern, vars, maxLength = 60) {
   }
   return branch;
 }
+async function getLocalBranches(options = {}) {
+  try {
+    const { stdout } = await execGit('git branch --format="%(refname:short)"', options);
+    return stdout.split("\n").map((b) => b.trim()).filter((b) => b.length > 0);
+  } catch {
+    return [];
+  }
+}
+async function getRemoteBranches(options = {}) {
+  try {
+    await execGit("git fetch --prune", options);
+    const { stdout } = await execGit('git branch -r --format="%(refname:short)"', options);
+    return stdout.split("\n").map((b) => b.trim()).filter((b) => b.length > 0 && !b.includes("HEAD")).map((b) => b.replace(/^origin\//, ""));
+  } catch {
+    return [];
+  }
+}
+async function getAllBranches(options = {}) {
+  const [local, remote] = await Promise.all([
+    getLocalBranches(options),
+    getRemoteBranches(options)
+  ]);
+  const all = new Set(local);
+  for (const b of remote) {
+    all.add(b);
+  }
+  return Array.from(all);
+}
 async function getDefaultBranch(options = {}) {
   try {
     const { stdout } = await execGit(
@@ -1258,10 +1289,13 @@ async function getDefaultBranch(options = {}) {
   detectRepository,
   fetchOrigin,
   generateBranchName,
+  getAllBranches,
   getCommitsAhead,
   getCommitsBehind,
   getCurrentBranch,
   getDefaultBranch,
+  getLocalBranches,
+  getRemoteBranches,
   getRepositoryRoot,
   hasUncommittedChanges,
   isGitRepository,

package/dist/index.d.cts

@@ -625,6 +625,18 @@ declare function generateBranchName(pattern: string, vars: {
     title: string;
     repo: string;
 }, maxLength?: number): string;
+/**
+ * Get all local branches
+ */
+declare function getLocalBranches(options?: GitOptions): Promise<string[]>;
+/**
+ * Get all remote branches (excluding HEAD), stripped of origin/ prefix
+ */
+declare function getRemoteBranches(options?: GitOptions): Promise<string[]>;
+/**
+ * Get all branches (local + remote unique)
+ */
+declare function getAllBranches(options?: GitOptions): Promise<string[]>;
 /**
  * Get the default branch name (main or master)
  */
@@ -817,4 +829,4 @@ declare namespace queries {
   export { queries_ADD_COMMENT_MUTATION as ADD_COMMENT_MUTATION, queries_ADD_LABELS_MUTATION as ADD_LABELS_MUTATION, queries_ADD_TO_PROJECT_MUTATION as ADD_TO_PROJECT_MUTATION, queries_COLLABORATORS_QUERY as COLLABORATORS_QUERY, queries_CREATE_ISSUE_MUTATION as CREATE_ISSUE_MUTATION, queries_ISSUES_WITH_LABEL_QUERY as ISSUES_WITH_LABEL_QUERY, queries_ISSUE_AND_LABEL_QUERY as ISSUE_AND_LABEL_QUERY, queries_ISSUE_DETAILS_QUERY as ISSUE_DETAILS_QUERY, queries_ISSUE_FOR_UPDATE_QUERY as ISSUE_FOR_UPDATE_QUERY, queries_ISSUE_NODE_ID_QUERY as ISSUE_NODE_ID_QUERY, queries_ISSUE_TYPES_QUERY as ISSUE_TYPES_QUERY, queries_LABEL_EXISTS_QUERY as LABEL_EXISTS_QUERY, queries_PROJECT_FIELDS_QUERY as PROJECT_FIELDS_QUERY, queries_PROJECT_ITEMS_QUERY as PROJECT_ITEMS_QUERY, queries_PROJECT_VIEWS_QUERY as PROJECT_VIEWS_QUERY, queries_RECENT_ISSUES_QUERY as RECENT_ISSUES_QUERY, queries_REMOVE_LABELS_MUTATION as REMOVE_LABELS_MUTATION, queries_REPOSITORY_ID_QUERY as REPOSITORY_ID_QUERY, queries_REPOSITORY_PROJECTS_QUERY as REPOSITORY_PROJECTS_QUERY, queries_UPDATE_ISSUE_BODY_MUTATION as UPDATE_ISSUE_BODY_MUTATION, queries_UPDATE_ISSUE_MUTATION as UPDATE_ISSUE_MUTATION, queries_UPDATE_ISSUE_TYPE_MUTATION as UPDATE_ISSUE_TYPE_MUTATION, queries_UPDATE_ITEM_FIELD_MUTATION as UPDATE_ITEM_FIELD_MUTATION, queries_UPDATE_ITEM_STATUS_MUTATION as UPDATE_ITEM_STATUS_MUTATION, queries_VIEWER_QUERY as VIEWER_QUERY };
 }
 
-export { type AssigneeInfo, type AuthError, BranchLinker, type Collaborator, type DateFieldValue, type FieldInfo, type FieldValue, type FieldValueConnection, GitHubAPI, type GitHubAPIOptions, type GitOptions, type IssueDetails, type IssueReference, type IterationFieldValue, type LabelInfo, type NumberFieldValue, type Project, type ProjectConfig, type ProjectItem, type ProjectItemContent, type ProjectItemsQueryResponse, type ProjectV2, type ProjectV2Field, type ProjectV2Item, type ProjectV2View, type ProjectWithViews, type ProjectsQueryResponse, type RepoInfo, type SingleSelectFieldValue, type StatusField, type TextFieldValue, type TokenProvider, branchExists, buildIssueUrl, buildOrgProjectUrl, buildProjectUrl, buildPullRequestUrl, buildRepoUrl, checkoutBranch, createBranch, detectRepository, fetchOrigin, generateBranchName, getCommitsAhead, getCommitsBehind, getCurrentBranch, getDefaultBranch, getRepositoryRoot, hasUncommittedChanges, isGitRepository, parseBranchLink, parseGitHubUrl, parseIssueUrl, pullLatest, queries, removeBranchLinkFromBody, sanitizeForBranchName, setBranchLinkInBody };
+export { type AssigneeInfo, type AuthError, BranchLinker, type Collaborator, type DateFieldValue, type FieldInfo, type FieldValue, type FieldValueConnection, GitHubAPI, type GitHubAPIOptions, type GitOptions, type IssueDetails, type IssueReference, type IterationFieldValue, type LabelInfo, type NumberFieldValue, type Project, type ProjectConfig, type ProjectItem, type ProjectItemContent, type ProjectItemsQueryResponse, type ProjectV2, type ProjectV2Field, type ProjectV2Item, type ProjectV2View, type ProjectWithViews, type ProjectsQueryResponse, type RepoInfo, type SingleSelectFieldValue, type StatusField, type TextFieldValue, type TokenProvider, branchExists, buildIssueUrl, buildOrgProjectUrl, buildProjectUrl, buildPullRequestUrl, buildRepoUrl, checkoutBranch, createBranch, detectRepository, fetchOrigin, generateBranchName, getAllBranches, getCommitsAhead, getCommitsBehind, getCurrentBranch, getDefaultBranch, getLocalBranches, getRemoteBranches, getRepositoryRoot, hasUncommittedChanges, isGitRepository, parseBranchLink, parseGitHubUrl, parseIssueUrl, pullLatest, queries, removeBranchLinkFromBody, sanitizeForBranchName, setBranchLinkInBody };

package/dist/index.d.ts

@@ -625,6 +625,18 @@ declare function generateBranchName(pattern: string, vars: {
     title: string;
     repo: string;
 }, maxLength?: number): string;
+/**
+ * Get all local branches
+ */
+declare function getLocalBranches(options?: GitOptions): Promise<string[]>;
+/**
+ * Get all remote branches (excluding HEAD), stripped of origin/ prefix
+ */
+declare function getRemoteBranches(options?: GitOptions): Promise<string[]>;
+/**
+ * Get all branches (local + remote unique)
+ */
+declare function getAllBranches(options?: GitOptions): Promise<string[]>;
 /**
  * Get the default branch name (main or master)
  */
@@ -817,4 +829,4 @@ declare namespace queries {
   export { queries_ADD_COMMENT_MUTATION as ADD_COMMENT_MUTATION, queries_ADD_LABELS_MUTATION as ADD_LABELS_MUTATION, queries_ADD_TO_PROJECT_MUTATION as ADD_TO_PROJECT_MUTATION, queries_COLLABORATORS_QUERY as COLLABORATORS_QUERY, queries_CREATE_ISSUE_MUTATION as CREATE_ISSUE_MUTATION, queries_ISSUES_WITH_LABEL_QUERY as ISSUES_WITH_LABEL_QUERY, queries_ISSUE_AND_LABEL_QUERY as ISSUE_AND_LABEL_QUERY, queries_ISSUE_DETAILS_QUERY as ISSUE_DETAILS_QUERY, queries_ISSUE_FOR_UPDATE_QUERY as ISSUE_FOR_UPDATE_QUERY, queries_ISSUE_NODE_ID_QUERY as ISSUE_NODE_ID_QUERY, queries_ISSUE_TYPES_QUERY as ISSUE_TYPES_QUERY, queries_LABEL_EXISTS_QUERY as LABEL_EXISTS_QUERY, queries_PROJECT_FIELDS_QUERY as PROJECT_FIELDS_QUERY, queries_PROJECT_ITEMS_QUERY as PROJECT_ITEMS_QUERY, queries_PROJECT_VIEWS_QUERY as PROJECT_VIEWS_QUERY, queries_RECENT_ISSUES_QUERY as RECENT_ISSUES_QUERY, queries_REMOVE_LABELS_MUTATION as REMOVE_LABELS_MUTATION, queries_REPOSITORY_ID_QUERY as REPOSITORY_ID_QUERY, queries_REPOSITORY_PROJECTS_QUERY as REPOSITORY_PROJECTS_QUERY, queries_UPDATE_ISSUE_BODY_MUTATION as UPDATE_ISSUE_BODY_MUTATION, queries_UPDATE_ISSUE_MUTATION as UPDATE_ISSUE_MUTATION, queries_UPDATE_ISSUE_TYPE_MUTATION as UPDATE_ISSUE_TYPE_MUTATION, queries_UPDATE_ITEM_FIELD_MUTATION as UPDATE_ITEM_FIELD_MUTATION, queries_UPDATE_ITEM_STATUS_MUTATION as UPDATE_ITEM_STATUS_MUTATION, queries_VIEWER_QUERY as VIEWER_QUERY };
 }
 
-export { type AssigneeInfo, type AuthError, BranchLinker, type Collaborator, type DateFieldValue, type FieldInfo, type FieldValue, type FieldValueConnection, GitHubAPI, type GitHubAPIOptions, type GitOptions, type IssueDetails, type IssueReference, type IterationFieldValue, type LabelInfo, type NumberFieldValue, type Project, type ProjectConfig, type ProjectItem, type ProjectItemContent, type ProjectItemsQueryResponse, type ProjectV2, type ProjectV2Field, type ProjectV2Item, type ProjectV2View, type ProjectWithViews, type ProjectsQueryResponse, type RepoInfo, type SingleSelectFieldValue, type StatusField, type TextFieldValue, type TokenProvider, branchExists, buildIssueUrl, buildOrgProjectUrl, buildProjectUrl, buildPullRequestUrl, buildRepoUrl, checkoutBranch, createBranch, detectRepository, fetchOrigin, generateBranchName, getCommitsAhead, getCommitsBehind, getCurrentBranch, getDefaultBranch, getRepositoryRoot, hasUncommittedChanges, isGitRepository, parseBranchLink, parseGitHubUrl, parseIssueUrl, pullLatest, queries, removeBranchLinkFromBody, sanitizeForBranchName, setBranchLinkInBody };
+export { type AssigneeInfo, type AuthError, BranchLinker, type Collaborator, type DateFieldValue, type FieldInfo, type FieldValue, type FieldValueConnection, GitHubAPI, type GitHubAPIOptions, type GitOptions, type IssueDetails, type IssueReference, type IterationFieldValue, type LabelInfo, type NumberFieldValue, type Project, type ProjectConfig, type ProjectItem, type ProjectItemContent, type ProjectItemsQueryResponse, type ProjectV2, type ProjectV2Field, type ProjectV2Item, type ProjectV2View, type ProjectWithViews, type ProjectsQueryResponse, type RepoInfo, type SingleSelectFieldValue, type StatusField, type TextFieldValue, type TokenProvider, branchExists, buildIssueUrl, buildOrgProjectUrl, buildProjectUrl, buildPullRequestUrl, buildRepoUrl, checkoutBranch, createBranch, detectRepository, fetchOrigin, generateBranchName, getAllBranches, getCommitsAhead, getCommitsBehind, getCurrentBranch, getDefaultBranch, getLocalBranches, getRemoteBranches, getRepositoryRoot, hasUncommittedChanges, isGitRepository, parseBranchLink, parseGitHubUrl, parseIssueUrl, pullLatest, queries, removeBranchLinkFromBody, sanitizeForBranchName, setBranchLinkInBody };

package/dist/index.js

@@ -1178,6 +1178,34 @@ function generateBranchName(pattern, vars, maxLength = 60) {
   }
   return branch;
 }
+async function getLocalBranches(options = {}) {
+  try {
+    const { stdout } = await execGit('git branch --format="%(refname:short)"', options);
+    return stdout.split("\n").map((b) => b.trim()).filter((b) => b.length > 0);
+  } catch {
+    return [];
+  }
+}
+async function getRemoteBranches(options = {}) {
+  try {
+    await execGit("git fetch --prune", options);
+    const { stdout } = await execGit('git branch -r --format="%(refname:short)"', options);
+    return stdout.split("\n").map((b) => b.trim()).filter((b) => b.length > 0 && !b.includes("HEAD")).map((b) => b.replace(/^origin\//, ""));
+  } catch {
+    return [];
+  }
+}
+async function getAllBranches(options = {}) {
+  const [local, remote] = await Promise.all([
+    getLocalBranches(options),
+    getRemoteBranches(options)
+  ]);
+  const all = new Set(local);
+  for (const b of remote) {
+    all.add(b);
+  }
+  return Array.from(all);
+}
 async function getDefaultBranch(options = {}) {
   try {
     const { stdout } = await execGit(
@@ -1210,10 +1238,13 @@ export {
   detectRepository,
   fetchOrigin,
   generateBranchName,
+  getAllBranches,
   getCommitsAhead,
   getCommitsBehind,
   getCurrentBranch,
   getDefaultBranch,
+  getLocalBranches,
+  getRemoteBranches,
   getRepositoryRoot,
   hasUncommittedChanges,
   isGitRepository,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bretwardjames/ghp-core",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Shared core library for GitHub Projects tools",
   "main": "dist/index.cjs",
   "module": "dist/index.js",