Skip to content

docs: add JSDoc for parseGitHubRemote function #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OpenCode2026 wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: add JSDoc for parseGitHubRemote function #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions packages/opencode/src/cli/cmd/github.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,20 @@ const SUPPORTED_EVENTS = [...USER_EVENTS, ...REPO_EVENTS] as const
type UserEvent = (typeof USER_EVENTS)[number]
type RepoEvent = (typeof REPO_EVENTS)[number]

// Parses GitHub remote URLs in various formats:
// - https://github.com/owner/repo.git
// - https://github.com/owner/repo
// - git@github.com:owner/repo.git
// - git@github.com:owner/repo
// - ssh://git@github.com/owner/repo.git
// - ssh://git@github.com/owner/repo
/**
* Parses GitHub remote URLs in various formats.
*
* Supported formats:
* - https://github.com/owner/repo.git
* - https://github.com/owner/repo
* - git@github.com:owner/repo.git
* - git@github.com:owner/repo
* - ssh://git@github.com/owner/repo.git
* - ssh://git@github.com/owner/repo
*
* @param url The GitHub remote URL to parse
* @returns Object with owner and repo, or null if parsing fails
*/
export function parseGitHubRemote(url: string): { owner: string; repo: string } | null {
const match = url.match(/^(?:(?:https?|ssh):\/\/)?(?:git@)?github\.com[:/]([^/]+)\/([^/]+?)(?:\.git)?$/)
if (!match) return null
Expand Down