https://github.com/asterics/node-git-tools

https://github.com/asterics/node-git-tools

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/asterics/node-git-tools
• Owner: asterics
• License: gpl-3.0
• Created: 2019-01-27T00:50:54.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-14T22:54:50.000Z (almost 7 years ago)
• Last Synced: 2025-12-27T17:22:45.145Z (3 months ago)
• Language: JavaScript
• Size: 82 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# git-tools

git-tools is a collection of methods to manipulate local git repositories and perform git repository-related functionality.

## Install

Install git-tools with npm:

    npm install --save-dev @asterics/git-tools

Install with yarn:

    yarn add @asterics/git-tools --dev

## Introduction

Most of the exported functions depend on [`@asterics/node-utils`](https://www.npmjs.com/package/@asterics/node-utils) and [`git`](https://git-scm.com/). 

## API Reference

### gitLocalPath( from, name ) `deprecated`

Deprecated since: `v0.1.5`

Get path to git repository `name` starting `from` in all parent directories.

Available parameters:

* `from`: Path to start search from.

* `name`: Name of folder containing git repository.  The Name 

  

  The `name` must either be _prefixed_ or an _absolute path_.

  * `auto:` search for repository with the name following the prefix.

  * `remote:` returns `""`.

  * `/path/to/repo`: check and return if path is absolute.

Returns:

Local path to git repository. `""` (empty string) if not available.

### checkoutSubmodule( { name, destination, branch, fatality }, verbose )

Check out git submodule.

Available properties:

* `name`: Name of submodule.

* `destination`: Path to submodule.

* `[branch]`: Branch to check out (default: "master").

* `[fatality]`: Abort program on error (default: false).

* `[verbose]`: Verbose logging (default: false).

### ensureGitSubmodule( { name, destination, reference, branch, fatality }, verbose )

Clone git submodule.

Available properties:

* `name`: Name of submodule.

* `destination`: Path to submodule.

* `[reference]`: Local reference to git repository of submodule (default: "").

* `[branch]`: Branch to check out (default: "master").

* `[fatality]`: Abort program on error (default: false).

* `[verbose]`: Verbose logging (default: false).

### getReferenceInPath( path, name )

Get reference to git repository `name` searching `path` and parent directories.

Available parameters:

* `path`: Path to search (incl. parent directories).

* `name`: Directory name containing git repository.

Returns:

Path to reference git repository. `""` (empty string) if none available.