Globals

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.

Namespaces

@yarnpkg/core

Enumerations

TreeishProtocols

Classes

Interfaces

Hooks

Type aliases

RepoUrlParts

Variables

Functions

Object literals

plugin

Type aliases

RepoUrlParts

RepoUrlParts: object

Type declaration

extra: object
- [key: string]: string
repo: string
treeish: object
- protocol: TreeishProtocols | string | null
- request: string

Variables

Const INVALID_PATTERNS

INVALID_PATTERNS: string[] = [`./.`,`../..`,]

Const VALID_PATTERNS

VALID_PATTERNS: [["GitHubOrg/foo-bar.js", object, object], ["GitHubOrg/foo2bar.js", object, object], ["GitHubOrg/foo-bar.js#hash", object, object], ["GitHubOrg/foo-bar.js#commit:hash", object, object], ["GitHubOrg/foo-bar.js#commit=hash", object, object], ["GitHubOrg/foo-bar.js#commit=hash&workspace=foo", object, object], ["GitHubOrg/foo-bar.js#tag=hello", object, object], ["GitHubOrg/foo-bar.js#workspace=foo", object, object], ["github:GitHubOrg/foo-bar.js", object, object], ["github:GitHubOrg/foo-bar.js#hash", object, object], ["https://github.com/yarnpkg/util-deprecate.git#v1.0.0", object, object], ["https://github.com/yarnpkg/util-deprecate.git#semver:v1.0.0", object, object], ["https://github.com/yarnpkg/util-deprecate.git#master", object, object], ["https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d", object, object], ["https://github.com/yarnpkg/util-deprecate/tarball/b3562c2798507869edb767da869cd7b85487726d", object, object], ["git://github.com/yarnpkg/util-deprecate.git#v1.0.1", object, object], ["git+ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1", object, object], ["ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1", object, object], ["git+ssh://git@github.com:yarnpkg/berry.git#v2.1.1", object, object], ["ssh://git@github.com:yarnpkg/berry.git#v2.1.1", object, object], ["git+https://github.com/yarnpkg/util-deprecate#v1.0.1", object, object], ["git+https://github.com/yarnpkg/util-deprecate.git#v1.0.1", object, object]] = [[`GitHubOrg/foo-bar.js`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git`,git: `https://github.com/GitHubOrg/foo-bar.js.git`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `head`,request: `HEAD`,},}],[`GitHubOrg/foo2bar.js`, {standard: `https://github.com/GitHubOrg/foo2bar.js.git`,git: `https://github.com/GitHubOrg/foo2bar.js.git`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo2bar.js.git`,treeish: {protocol: `head`,request: `HEAD`,},}],[`GitHubOrg/foo-bar.js#hash`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#hash`,git: `https://github.com/GitHubOrg/foo-bar.js.git#hash`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: null,request: `hash`,},}],[`GitHubOrg/foo-bar.js#commit:hash`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#commit:hash`,git: `https://github.com/GitHubOrg/foo-bar.js.git#commit:hash`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `commit`,request: `hash`,},}],[`GitHubOrg/foo-bar.js#commit=hash`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#commit=hash`,git: `https://github.com/GitHubOrg/foo-bar.js.git#commit=hash`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `commit`,request: `hash`,},}],[`GitHubOrg/foo-bar.js#commit=hash&workspace=foo`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#commit=hash&workspace=foo`,git: `https://github.com/GitHubOrg/foo-bar.js.git#commit=hash&workspace=foo`,}, {extra: {workspace: `foo`,},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `commit`,request: `hash`,},}],[`GitHubOrg/foo-bar.js#tag=hello`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#tag=hello`,git: `https://github.com/GitHubOrg/foo-bar.js.git#tag=hello`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `tag`,request: `hello`,},}],[`GitHubOrg/foo-bar.js#workspace=foo`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#workspace=foo`,git: `https://github.com/GitHubOrg/foo-bar.js.git#workspace=foo`,}, {extra: {workspace: `foo`,},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `head`,request: `HEAD`,},}],[`github:GitHubOrg/foo-bar.js`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git`,git: `https://github.com/GitHubOrg/foo-bar.js.git`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: `head`,request: `HEAD`,},}],[`github:GitHubOrg/foo-bar.js#hash`, {standard: `https://github.com/GitHubOrg/foo-bar.js.git#hash`,git: `https://github.com/GitHubOrg/foo-bar.js.git#hash`,}, {extra: {},repo: `https://github.com/GitHubOrg/foo-bar.js.git`,treeish: {protocol: null,request: `hash`,},}],[`https://github.com/yarnpkg/util-deprecate.git#v1.0.0`, {standard: `https://github.com/yarnpkg/util-deprecate.git#v1.0.0`,git: `https://github.com/yarnpkg/util-deprecate.git#v1.0.0`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.0`,},}],[`https://github.com/yarnpkg/util-deprecate.git#semver:v1.0.0`, {standard: `https://github.com/yarnpkg/util-deprecate.git#semver:v1.0.0`,git: `https://github.com/yarnpkg/util-deprecate.git#semver:v1.0.0`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: `semver`,request: `v1.0.0`,},}],[`https://github.com/yarnpkg/util-deprecate.git#master`, {standard: `https://github.com/yarnpkg/util-deprecate.git#master`,git: `https://github.com/yarnpkg/util-deprecate.git#master`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `master`,},}],[`https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d`, {standard: `https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d`,git: `https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `b3562c2798507869edb767da869cd7b85487726d`,},}],[`https://github.com/yarnpkg/util-deprecate/tarball/b3562c2798507869edb767da869cd7b85487726d`, {standard: `https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d`,git: `https://github.com/yarnpkg/util-deprecate.git#b3562c2798507869edb767da869cd7b85487726d`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `b3562c2798507869edb767da869cd7b85487726d`,},}],[`git://github.com/yarnpkg/util-deprecate.git#v1.0.1`, {standard: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,git: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.1`,},}],[`git+ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`, {standard: `git+ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`,git: `ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`,}, {extra: {},repo: `git+ssh://git@github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.1`,},}],[`ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`, {standard: `ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`,git: `ssh://git@github.com/yarnpkg/util-deprecate.git#v1.0.1`,}, {extra: {},repo: `ssh://git@github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.1`,},}],[`git+ssh://git@github.com:yarnpkg/berry.git#v2.1.1`, {standard: `git+ssh://git@github.com:yarnpkg/berry.git#v2.1.1`,git: `ssh://git@github.com/yarnpkg/berry.git#v2.1.1`,}, {extra: {},repo: `git+ssh://git@github.com:yarnpkg/berry.git`,treeish: {protocol: null,request: `v2.1.1`,},}],[`ssh://git@github.com:yarnpkg/berry.git#v2.1.1`, {standard: `ssh://git@github.com:yarnpkg/berry.git#v2.1.1`,git: `ssh://git@github.com/yarnpkg/berry.git#v2.1.1`,}, {extra: {},repo: `ssh://git@github.com:yarnpkg/berry.git`,treeish: {protocol: null,request: `v2.1.1`,},}],[`git+https://github.com/yarnpkg/util-deprecate#v1.0.1`, {standard: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,git: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.1`,},}],[`git+https://github.com/yarnpkg/util-deprecate.git#v1.0.1`, {standard: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,git: `https://github.com/yarnpkg/util-deprecate.git#v1.0.1`,}, {extra: {},repo: `https://github.com/yarnpkg/util-deprecate.git`,treeish: {protocol: null,request: `v1.0.1`,},}],] as const

Const gitPatterns

gitPatterns: RegExp[] = [/^ssh:/,/^git(?:\+[^:]+)?:/,// `git+` is optional, `.git` is required/^(?: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>

- Defined in packages/plugin-git/sources/gitUtils.ts:251
Parameters
- url: string
- configuration: Configuration
Returns Promise<string & object>

correctURL

correctURL(gitURL: string): string

- Defined in packages/plugin-git/sources/hosted-git-info-parse.ts:34
Parameters
- gitURL: string
Returns string

fetchBase

fetchBase(root: PortablePath, __namedParameters: object): Promise<object>

- Defined in packages/plugin-git/sources/gitUtils.ts:286
Parameters
- root: PortablePath
- __namedParameters: object
  - baseRefs: string[]
Returns Promise<object>

fetchChangedFiles

fetchChangedFiles(root: PortablePath, __namedParameters: object): Promise<(string & object)[]>

- Defined in packages/plugin-git/sources/gitUtils.ts:313
Parameters
- root: PortablePath
- __namedParameters: object
  - base: string
  - project: Project
Returns Promise<(string & object)[]>

fetchChangedWorkspaces

fetchChangedWorkspaces(__namedParameters: object): Promise<Set<Workspace>>

- Defined in packages/plugin-git/sources/gitUtils.ts:331
Parameters
- __namedParameters: object
  - project: Project
  - ref: string | true
Returns Promise<Set<Workspace>>

fetchRoot

fetchRoot(initialCwd: PortablePath): Promise<null | string & object>

- Defined in packages/plugin-git/sources/gitUtils.ts:269
Parameters
- initialCwd: PortablePath
Returns Promise<null | string & object>

git

git(message: string, args: Array<string>, opts: Omit<execUtils.ExecvpOptions, "strict">, __namedParameters: object): Promise<object>

- Defined in packages/plugin-git/sources/gitUtils.ts:368
Parameters
- message: string
- args: Array<string>
- opts: Omit<execUtils.ExecvpOptions, "strict">
- __namedParameters: object
  - configuration: Configuration
  - normalizedRepoUrl: string
Returns Promise<object>

isGitUrl

isGitUrl(url: string): boolean

- Defined in packages/plugin-git/sources/gitUtils.ts:45
Determines whether a given url is a valid github git url via regex

Parameters
- url: string
Returns boolean

lastIndexOfBefore

lastIndexOfBefore(str: string, char: string, beforeChar: string): number

- Defined in packages/plugin-git/sources/hosted-git-info-parse.ts:20
license

Copyright (c) 2015, Rebecca Turner

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Parameters
- str: string
- char: string
- beforeChar: string
Returns number

lsRemote

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

- Defined in packages/plugin-git/sources/gitUtils.ts:134
Parameters
- repo: string
- configuration: Configuration
Returns Promise<Map<any, any>>

makeGitEnvironment

makeGitEnvironment(): object

- Defined in packages/plugin-git/sources/gitUtils.ts:13
Returns object
- GIT_SSH_COMMAND: string

normalizeLocator

normalizeLocator(locator: Locator): Locator

- Defined in packages/plugin-git/sources/gitUtils.ts:121
Parameters
- locator: Locator
Returns Locator

normalizeRepoUrl

normalizeRepoUrl(url: string, __namedParameters?: object): string

- Defined in packages/plugin-git/sources/utils/normalizeRepoUrl.ts:3
Parameters
- url: string
- Default value __namedParameters: object = {}
  - git: boolean
Returns string

resolveUrl

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

- Defined in packages/plugin-git/sources/gitUtils.ts:156
Parameters
- url: string
- configuration: Configuration
Returns Promise<string>

safeURL

safeURL(url: string): undefined | URL

- Defined in packages/plugin-git/sources/hosted-git-info-parse.ts:25
Parameters
- url: string
Returns undefined | URL

splitRepoUrl

splitRepoUrl(url: string): RepoUrlParts

- Defined in packages/plugin-git/sources/gitUtils.ts:60
Parameters
- url: string
Returns RepoUrlParts

tryParseGitURL

tryParseGitURL(gitURL: string): undefined | URL

- Defined in packages/plugin-git/sources/hosted-git-info-parse.ts:65
Parameters
- gitURL: string
Returns undefined | URL

validateRepoUrl

validateRepoUrl(url: string, __namedParameters: object): string

- Defined in packages/plugin-git/sources/gitUtils.ts:125
Parameters
- url: string
- __namedParameters: object
  - configuration: Configuration
Returns string

Object literals

Const plugin

plugin: object

fetchers

fetchers: GitFetcher[] = [GitFetcher,]

resolvers

resolvers: GitResolver[] = [GitResolver,]

configuration

configuration: object

changesetBaseRefs

changesetBaseRefs: object

default

default: string[] = [`master`, `origin/master`, `upstream/master`, `main`, `origin/main`, `upstream/main`]

description

description: string = `The base git refs that the current HEAD is compared against when detecting changes. Supports git branches, tags, and commits.`

isArray

isArray: true = true

isNullable

isNullable: false = false

type

type: STRING = SettingsType.STRING

changesetIgnorePatterns

changesetIgnorePatterns: object

default

default: never[] = []

description

description: string = `Array of glob patterns; files matching them will be ignored when fetching the changed files`

isArray

isArray: true = true

type

type: STRING = SettingsType.STRING

cloneConcurrency

cloneConcurrency: object

default

default: number = 2

description

description: string = `Maximal number of concurrent clones`

type

type: NUMBER = SettingsType.NUMBER

Package plugin-git

@yarnpkg/plugin-git

Install

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

RepoUrlParts

Type declaration

extra: object

[key: string]: string

repo: string

treeish: object

protocol: TreeishProtocols | string | null

request: string

Variables

Const INVALID_PATTERNS

Const VALID_PATTERNS

Const gitPatterns

Functions

clone

Parameters

url: string

configuration: Configuration

Returns Promise<string & object>

correctURL

Parameters

gitURL: string

Returns string

fetchBase

Parameters

root: PortablePath

__namedParameters: object

baseRefs: string[]

Returns Promise<object>

fetchChangedFiles

Parameters

root: PortablePath

__namedParameters: object

base: string

project: Project

Returns Promise<(string & object)[]>

fetchChangedWorkspaces

Parameters

__namedParameters: object

project: Project

ref: string | true

Returns Promise<Set<Workspace>>

fetchRoot

Parameters

initialCwd: PortablePath

Returns Promise<null | string & object>

git

Parameters

message: string

args: Array<string>

opts: Omit<execUtils.ExecvpOptions, "strict">

__namedParameters: object

configuration: Configuration

normalizedRepoUrl: string

Returns Promise<object>

isGitUrl

Parameters

url: string

Returns boolean

lastIndexOfBefore

Parameters

str: string

char: string

beforeChar: string

Returns number

lsRemote

Parameters

repo: string

configuration: Configuration

`@yarnpkg/plugin-git`