gitUtils

Index

Enumerations

• TreeishProtocols

Type Aliases

• RepoUrlParts

Functions

• clone
• fetchBase
• fetchChangedFiles
• fetchChangedWorkspaces
• fetchRoot
• isGitUrl
• lsRemote
• normalizeLocator
• normalizeRepoUrl
• resolveUrl
• splitRepoUrl
• validateRepoUrl

Enumerations

TreeishProtocols

TreeishProtocols:

Commit

Commit: commit

Head

Head: head

Semver

Semver: semver

Tag

Tag: tag

Type Aliases

RepoUrlParts

RepoUrlParts: { extra: {}; repo: string; treeish: { protocol: TreeishProtocols | string | null; request: string } }

Type declaration

• extra: {}

  • [key string]: string

• repo: string

• treeish: { protocol: TreeishProtocols | string | null; request: string }

  • protocol: TreeishProtocols | string | null

  • request: string

Functions

clone

• clone(url: string, configuration: Configuration): Promise<PortablePath>

• Parameters

  • url: string

  • configuration: Configuration

  Returns Promise<PortablePath>

fetchBase

• fetchBase(root: PortablePath, __namedParameters: { baseRefs: string[] }): Promise<{ hash: string; title: string }>

• Parameters

  • root: PortablePath

  • __namedParameters: { baseRefs: string[] }

  Returns Promise<{ hash: string; title: string }>

fetchChangedFiles

• fetchChangedFiles(root: PortablePath, __namedParameters: { base: string; project: Project }): Promise<PortablePath[]>

• Parameters

  • root: PortablePath

  • __namedParameters: { base: string; project: Project }

  Returns Promise<PortablePath[]>

fetchChangedWorkspaces

• fetchChangedWorkspaces(__namedParameters: { project: Project; ref: string | true }): Promise<Set<Workspace>>

• Parameters

  • __namedParameters: { project: Project; ref: string | true }

  Returns Promise<Set<Workspace>>

fetchRoot

• fetchRoot(initialCwd: PortablePath): Promise<null | PortablePath>

• Parameters

  • initialCwd: PortablePath

  Returns Promise<null | PortablePath>

isGitUrl

• isGitUrl(url: string): boolean

• Determines whether a given url is a valid github git url via regex

  ---

  Parameters

  • url: string

  Returns boolean

lsRemote

• lsRemote(repo: string, configuration: Configuration): Promise<Map<any, any>>

• Parameters

  • repo: string

  • configuration: Configuration

  Returns Promise<Map<any, any>>

normalizeLocator

• normalizeLocator(locator: Locator): Locator

• Parameters

  • locator: Locator

  Returns Locator

normalizeRepoUrl

• normalizeRepoUrl(url: string, __namedParameters?: { git?: boolean }): string

• Parameters

  • url: string

  • __namedParameters: { git?: boolean } = {}

  Returns string

resolveUrl

• resolveUrl(url: string, configuration: Configuration): Promise<string>

• Parameters

  • url: string

  • configuration: Configuration

  Returns Promise<string>

splitRepoUrl

• splitRepoUrl(url: string): RepoUrlParts

• Parameters

  • url: string

  Returns RepoUrlParts

validateRepoUrl

• validateRepoUrl(url: string, __namedParameters: { configuration: Configuration }): string

• Parameters

  • url: string

  • __namedParameters: { configuration: Configuration }

  Returns string