https://github.com/therolffr/git-clone-promises

https://github.com/therolffr/git-clone-promises

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/therolffr/git-clone-promises
• Owner: TheRolfFR
• License: isc
• Created: 2021-03-29T07:54:31.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-03-29T10:39:19.000Z (over 3 years ago)
• Last Synced: 2024-09-14T22:15:52.865Z (about 2 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# git-clone-promises

Promise version of [jaz303](https://github.com/jaz303)'s [git-clone](https://www.npmjs.com/package/git-clone) npm module. Clones a git repository via shell command and with promises!

## Installation

Install:

	$ npm install git-clone-promises

Require:

	const { clone, cloneCallback } = require('git-clone-promises');

## API

#### `clone(repo, targetPath, [options=undefined])`

Clones `repo` to `targetPath`, returning promise

Supported `options`:

  * `git`: path to `git` binary; default: `git` (optional).

  * `shallow`: when `true`, clone with depth 1 (optional).

  * `checkout`: revision/branch/tag to check out (optional).

  * `remove`: removes targetPath if already existing (optional).

## Example

Fullfills if done with no return value

Rejects if folder already exists and not empty and no `remove` option or else failed to remove folder:

```js

const { clone } = require('git-clone-promises');

clone('https://github.com/TheRolfFR/git-clone-promises.git', './test-clone', {

  remove: true

}).then(() => {

  console.log('complete!')

}).catch((err) => {

  console.error(err)

})

```

## Legacy example

I left callback version with my remove option addition:

```js

const { cloneCallback } = require('git-clone-promises');

cloneCallback('https://github.com/TheRolfFR/git-clone-promises.git', './test-clone', {

  remove: true

}, function (err) {

  if(err)

    console.error(err)

  console.log('finished!')

})

```

## Copyright & License

© 2021 Le Vaguerès Yann 

Twitter : [@TheRolfFR](https://bit.ly/therolf-twitter)


Website : [therolf.fr](https://therolf.fr)


GitHub : [@TheRolfFR](https://bit.ly/therolf-github)

Released under the ISC license.