Options
All
  • Public
  • Public/Protected
  • All
Menu

Package plugin-git

@yarnpkg/plugin-git

This plugin adds support for cloning packages from Git repositories.

Install

This plugin is included by default in Yarn.

Type aliases

RepoUrlParts

RepoUrlParts: object

Type declaration

  • extra: object
    • [key: string]: string
  • repo: string
  • treeish: object

Variables

Const gitPatterns

gitPatterns: RegExp[] = [/^ssh:/,/^git(?:\+ssh)?:/,// `git+` is optional, `.git` is required/^(?:git\+)?https?:[^#]+\/[^#]+(?:\.git)(?:#.*)?$/,// `git+` is required, `.git` is optional/^(?:git\+)https?:[^#]+\/[^#]+(?:\.git)?(?:#.*)?$/,/^git@[^#]+\/[^#]+\.git(?:#.*)?$/,/^(?:github:|https:\/\/github\.com\/)?(?!\.{1,2}\/)([a-zA-Z._0-9-]+)\/(?!\.{1,2}(?:#|$))([a-zA-Z._0-9-]+?)(?:\.git)?(?:#.*)?$/,// GitHub `/tarball/` URLs/^https:\/\/github\.com\/(?!\.{1,2}\/)([a-zA-Z0-9._-]+)\/(?!\.{1,2}(?:#|$))([a-zA-Z0-9._-]+?)\/tarball\/(.+)?$/,]

Functions

clone

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

isGitUrl

  • isGitUrl(url: string): boolean

lsRemote

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

makeGitEnvironment

  • makeGitEnvironment(): object

normalizeLocator

normalizeRepoUrl

  • normalizeRepoUrl(url: string): string

resolveUrl

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

splitRepoUrl

Object literals

Const plugin

plugin: object

fetchers

fetchers: GitFetcher[] = [GitFetcher,]

resolvers

resolvers: GitResolver[] = [GitResolver,]

Generated using TypeDoc