Class IssueDiscovery

constructor

• new IssueDiscovery(githubToken: string): IssueDiscovery

  Parameters

  • githubToken: string

    GitHub personal access token or token from gh auth token

  Returns IssueDiscovery

rateLimitWarning

fetchStarredRepos

• fetchStarredRepos(): Promise<string[]>

  Fetch the authenticated user's starred repositories from GitHub. Updates the state manager with the list and timestamp.

  Returns Promise<string[]>

  Array of starred repo names in "owner/repo" format

formatCandidate

• formatCandidate(candidate: IssueCandidate): string

  Format issue candidate as a markdown display string.

  Parameters

  • candidate: IssueCandidate

    The issue candidate to format

  Returns string

  Multi-line markdown string with vetting details

getStarredReposWithRefresh

• getStarredReposWithRefresh(): Promise<string[]>

  Get starred repos, fetching from GitHub if cache is stale.

  Returns Promise<string[]>

  Array of starred repo names in "owner/repo" format

saveSearchResults

• saveSearchResults(candidates: IssueCandidate[]): string

  Save search results to ~/.oss-autopilot/found-issues.md. Results are sorted by viability score (highest first).

  Parameters

  • candidates: IssueCandidate[]

    Issue candidates to save

  Returns string

  Absolute path to the written file

searchIssues

• searchIssues(
      options?: {
          labels?: string[];
          languages?: string[];
          maxResults?: number;
      },
  ): Promise<IssueCandidate[]>

  Search for issues matching our criteria. Searches in priority order: merged-PR repos first (no label filter), then preferred organizations, then starred repos, then general search, then actively maintained repos. Filters out issues from low-scoring and excluded repos.

  Parameters

  • options: { labels?: string[]; languages?: string[]; maxResults?: number } = {}

    Search configuration

    • Optionallabels?: string[]

      Issue labels to search for

    • Optionallanguages?: string[]

      Programming languages to filter by

    • OptionalmaxResults?: number

      Maximum candidates to return (default: 10)

  Returns Promise<IssueCandidate[]>

  Scored and sorted issue candidates

  Throws

  If no candidates found and no rate limits prevented the search

  Example

  import { IssueDiscovery, requireGitHubToken } from '@oss-autopilot/core';
  
  const discovery = new IssueDiscovery(requireGitHubToken());
  const candidates = await discovery.searchIssues({ maxResults: 5 });
  for (const c of candidates) {
    console.log(`${c.issue.repo}#${c.issue.number}: ${c.viabilityScore}/100`);
  }
  Copy

vetIssue

• vetIssue(issueUrl: string): Promise<IssueCandidate>

  Vet a specific issue for claimability and project health.

  Parameters

  • issueUrl: string

    Full GitHub issue URL

  Returns Promise<IssueCandidate>

  The vetted issue candidate with recommendation and scores

  Throws

  If the URL is invalid or the issue cannot be fetched