local-repository-provider

9.0.1 • Public • Published

npm License bundlejs downloads GitHub Issues Build Status Styled with prettier Commitizen friendly Known Vulnerabilities Coverage Status

local-repository-provider

repository provider using local (native) git commands

API

Table of Contents

LocalBranch

Extends Branch

Properties

writeEntries

Writes ContentEntries into the branch

Parameters

  • entries Array<ContentEntry>

Returns Promise<Array<ContentEntry>> written entries

commit

Executes:

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

Parameters

  • message string commit message

  • entries Array<ContentEntry> file entries to be commited

  • options Object (optional, default {push:true})

    • options.push boolean exec push after commit

entries

Deliver all matchine entires for a given pattern.

Parameters

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

Returns AsyncIterable<ContentEntry> matching branch path names

entry

Search for path in the branch.

Parameters

Returns ContentEntry matching branch path names

maybeEntry

Search for path in the branch.

Parameters

Returns ContentEntry matching branch path names

Promise

Type: Promise<void>

LocalProvider

Extends SingleGroupProvider

Provider using native git executable. Known environment variables.

  • GIT_CLONE_OPTIONS

Properties

newWorkspacePath

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

Parameters

Returns string path

branches

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

Parameters

repositories

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

Parameters

repository

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

Parameters

  • name string
  • workspace string where to place the repos workspace @see #newWorkspacePath

name

We are called local.

Returns string local

attributes

Default configuration options.

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

Returns Object

LocalRepository

Extends Repository

Properties

  • workspace string
  • currentBranch Branch

setCurrentBranch

Set the current active branch (workspace)

Parameters

  • branch Branch

refId

Get sha of a ref Calls

git show-ref <ref>

Parameters

Returns Promise<string> sha of the ref

initializeBranches

build lookup of all remote branches

git ls-remote --heads

workspace

workspace directory.

Returns string

install

With npm do:

npm install local-repository-provider

license

BSD-2-Clause

Package Sidebar

Install

npm i local-repository-provider

Weekly Downloads

230

Version

9.0.1

License

BSD-2-Clause

Unpacked Size

23.3 kB

Total Files

7

Last publish

Collaborators

  • arlac77