local-repository-provider

repository provider using local (native) git commands

API

$3

* LocalBranch
* Properties
* writeEntries
* Parameters
* commit
* Parameters
* entries
* Parameters
* entry
* Parameters
* maybeEntry
* Parameters
* Promise
* LocalProvider
* Properties
* newWorkspacePath
* Parameters
* branches
* Parameters
* repositories
* Parameters
* repository
* Parameters
* name
* attributes
* LocalRepository
* Properties
* setCurrentBranch
* Parameters
* refId
* Parameters
* initializeBranches
* workspace

LocalBranch

Extends Branch

$3

* workspace string

$3

Writes ContentEntries into the branch

#### Parameters

* entries Array\

Returns Promise<Array\> written entries

$3

Executes:

* writes all updates into the workspace
* git add
* git commit
* git push --set-upstream origin

#### Parameters

* message string commit message
* entries Array\ file entries to be commited
* options Object (optional, default {push:true})

* options.push boolean exec push after commit

$3

Deliver all matchine entires for a given pattern.

#### Parameters

matchingPatterns (Array<string> | string) (optional, default ["/"])

Returns AsyncGenerator\ matching branch path names

$3

Search for path in the branch.

#### Parameters

* name string

Returns Promise\ matching branch path names

$3

Search for path in the branch.

#### Parameters

* name string

Returns Promise<(ContentEntry | undefined)> matching branch path names

Promise

Type: Promise\

LocalProvider

Extends SingleGroupProvider

Provider using native git executable.
Known environment variables.

* GIT\_CLONE\_OPTIONS

$3

* workspace string

$3

Generate path for a new workspace.
For the livetime of the provider always genrate new names

#### Parameters

* name string

Returns string path

$3

List branches for a given set of patterns.
Only delivers branches for valid complete git urls.

#### Parameters

* patterns (string | Array<string>)

$3

List repositories for a given set of patterns.
Only delivers repositories for valid complete git urls.

#### Parameters

* patterns (Array<string> | string)?

$3

Using provider workspace and number of repositories to create repository workspace.

#### Parameters

* name string
* workspace string? where to place the repos workspace

$3

We are called local.

Returns string local

$3

Default configuration options.

* workspace
* cloneOptions defaults to \["--depth", "8", "--no-single-branch"]

Returns Object

LocalRepository

Extends Repository

$3

* workspace string
* currentBranch Branch

$3

Set the current active branch (workspace)

#### Parameters

* branch Branch

$3

Get sha of a ref
Calls

``sh
git show-ref
`

#### Parameters

* ref string

Returns Promise<string> sha of the ref

$3

build lookup of all remote branches

`sh
git ls-remote --heads
`

workspace

workspace directory.

Returns string

install

With npm do:

`shell
npm install local-repository-provider
``

license

BSD-2-Clause