git-clone-promises

git-clone-promises

Promise version of jaz303's 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:

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:

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
Website : therolf.fr
GitHub : @TheRolfFR

Released under the ISC license.