https://github.com/arlac77/local-repository-provider

repository provider using local (native) git commands
https://github.com/arlac77/local-repository-provider
Last synced: about 1 year ago
JSON representation
repository provider using local (native) git commands
Host: GitHub
URL: https://github.com/arlac77/local-repository-provider
Owner: arlac77
License: 0bsd
Created: 2017-11-16T17:03:08.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2025-03-17T17:32:37.000Z (about 1 year ago)
Last Synced: 2025-03-21T08:46:59.652Z (about 1 year ago)
Language: JavaScript
Homepage:
Size: 3.18 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          [![npm](https://img.shields.io/npm/v/local-repository-provider.svg)](https://www.npmjs.com/package/local-repository-provider)

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)

[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)

[![bundlejs](https://deno.bundlejs.com/?q=local-repository-provider\&badge=detailed)](https://bundlejs.com/?q=local-repository-provider)

[![downloads](http://img.shields.io/npm/dm/local-repository-provider.svg?style=flat-square)](https://npmjs.org/package/local-repository-provider)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/local-repository-provider.svg?style=flat-square)](https://github.com/arlac77/local-repository-provider/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Flocal-repository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/local-repository-provider/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/local-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/local-repository-provider)

[![Coverage Status](https://coveralls.io/repos/arlac77/local-repository-provider/badge.svg)](https://coveralls.io/github/arlac77/local-repository-provider)

# local-repository-provider

repository provider using local (native) git commands

# API

### Table of Contents

*   [LocalBranch](#localbranch)

    *   [Properties](#properties)

    *   [writeEntries](#writeentries)

        *   [Parameters](#parameters)

    *   [commit](#commit)

        *   [Parameters](#parameters-1)

    *   [entries](#entries)

        *   [Parameters](#parameters-2)

    *   [entry](#entry)

        *   [Parameters](#parameters-3)

    *   [maybeEntry](#maybeentry)

        *   [Parameters](#parameters-4)

*   [Promise](#promise)

*   [LocalProvider](#localprovider)

    *   [Properties](#properties-1)

    *   [newWorkspacePath](#newworkspacepath)

        *   [Parameters](#parameters-5)

    *   [branches](#branches)

        *   [Parameters](#parameters-6)

    *   [repositories](#repositories)

        *   [Parameters](#parameters-7)

    *   [repository](#repository)

        *   [Parameters](#parameters-8)

    *   [name](#name)

    *   [attributes](#attributes)

*   [LocalRepository](#localrepository)

    *   [Properties](#properties-2)

    *   [setCurrentBranch](#setcurrentbranch)

        *   [Parameters](#parameters-9)

    *   [refId](#refid)

        *   [Parameters](#parameters-10)

    *   [initializeBranches](#initializebranches)

*   [workspace](#workspace)

## LocalBranch

**Extends Branch**

### Properties

*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

### writeEntries

Writes ContentEntries into the branch

#### Parameters

*   `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** 

Returns **[Promise](#promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\>** written entries

### commit

Executes:

*   writes all updates into the workspace

*   git add

*   git commit

*   git push --set-upstream origin

#### Parameters

*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message

*   `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** file entries to be commited

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{push:true}`)

    *   `options.push` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** exec push after commit

### entries

Deliver all matchine entires for a given pattern.

#### Parameters

*   `matchingPatterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**  (optional, default `["**/*"]`)

Returns **AsyncGenerator\** matching branch path names

### entry

Search for path in the branch.

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](#promise)\** matching branch path names

### maybeEntry

Search for path in the branch.

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](#promise)<(ContentEntry | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** matching branch path names

## Promise

Type: [Promise](#promise)\

## LocalProvider

**Extends SingleGroupProvider**

Provider using native git executable.

Known environment variables.

*   GIT\_CLONE\_OPTIONS

### Properties

*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

### newWorkspacePath

Generate path for a new workspace.

For the livetime of the provider always genrate new names

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path

### branches

List branches for a given set of patterns.

Only delivers branches for valid complete git urls.

#### Parameters

*   `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)** 

### repositories

List repositories for a given set of patterns.

Only delivers repositories for valid complete git urls.

#### Parameters

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** 

### repository

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

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** where to place the repos workspace

### name

We are called local.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** local

### attributes

Default configuration options.

*   workspace

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

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

## LocalRepository

**Extends Repository**

### Properties

*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `currentBranch` **Branch** 

### setCurrentBranch

Set the current active branch (workspace)

#### Parameters

*   `branch` **Branch** 

### refId

Get sha of a ref

Calls

```sh

git show-ref 

```

#### Parameters

*   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](#promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref

### initializeBranches

build lookup of all remote branches

```sh

git ls-remote --heads

```

## workspace

workspace directory.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

# install

With [npm](http://npmjs.org) do:

```shell

npm install local-repository-provider

```

# license

BSD-2-Clause
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/arlac77/local-repository-provider

Awesome Lists containing this project

README
