2016-11-21 23:24:11 +00:00
|
|
|
# smartgit
|
2016-11-22 20:49:40 +00:00
|
|
|
smart git wrapper for node.
|
2016-03-30 23:59:45 +00:00
|
|
|
|
2016-11-21 23:24:11 +00:00
|
|
|
smartgit expects git to be installed on target machine.
|
|
|
|
|
|
|
|
|
|
## Availabililty
|
|
|
|
|
[](https://www.npmjs.com/package/smartgit)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartgit)
|
|
|
|
|
[](https://github.com/pushrocks/smartgit)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartgit/)
|
2016-03-30 23:59:45 +00:00
|
|
|
|
2016-11-21 23:24:11 +00:00
|
|
|
## Status for master
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartgit/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartgit/commits/master)
|
|
|
|
|
[](https://david-dm.org/pushrocks/smartgit)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartgit/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartgit)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
2016-03-30 23:59:45 +00:00
|
|
|
|
2016-11-21 23:24:11 +00:00
|
|
|
## Usage
|
|
|
|
|
We recommend the use of TypeScript for best in class intellisense
|
|
|
|
|
|
|
|
|
|
```javascript
|
2016-11-22 20:49:40 +00:00
|
|
|
// import smartgit:
|
|
|
|
|
import { GitRepo } from 'smartgit'
|
|
|
|
|
|
|
|
|
|
// Initialize smartgit:
|
|
|
|
|
// -- note: there are 3 ways to initialize smartgit
|
|
|
|
|
// -- -- 1. with a existing Git repo
|
|
|
|
|
// -- -- 2. with a cloned Git repo
|
|
|
|
|
// -- -- 3. with a new Git repo
|
|
|
|
|
|
|
|
|
|
// -- 1. existing Git Repo:
|
|
|
|
|
let myExistingGitRepo = new GitRepo('/path/to/existing/git/repo/')
|
|
|
|
|
|
|
|
|
|
// -- 2. cloned Git Repo:
|
|
|
|
|
let myClonedGitRepo: GitRepo
|
|
|
|
|
smartgit.createRepoFromClone('git@github.com:username/reponame.git')
|
|
|
|
|
.then(gitRepo => { // non blocking
|
|
|
|
|
myClonedGitRepo = gitRepo
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// -- 3. new Git Repo
|
|
|
|
|
let myNewGitRepo: GitRepo
|
|
|
|
|
smartgit.createRepoFromInit('/path/to/new/folder') // smartgit will create any new folder, be careful
|
|
|
|
|
.then(gitRepo => { // non blocking
|
|
|
|
|
myNewGitRepo = gitRepo
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Using smartgit instance
|
|
|
|
|
// -- most used actions
|
|
|
|
|
// -- all actions return promises, so make sure to use promise chaining for any dependent tasks
|
|
|
|
|
myExistingGitRepo.addAll() // returns promise, stages all changed files
|
|
|
|
|
myExistingGitRepo.add(['relative/path/to/file.txt','another/file2.txt']) // returns promise, stages specific files
|
|
|
|
|
myExistingGitRepo.commit('my commit message') // returns promise, commits staged files
|
|
|
|
|
myExistingGitRepo.status() // returns promise
|
|
|
|
|
.then(status => { // Use TypeScript for status type information
|
2016-11-21 23:24:11 +00:00
|
|
|
|
2016-11-22 20:49:40 +00:00
|
|
|
})
|
|
|
|
|
myExistingGitRepo.check() // returns promise, checks repo health
|
|
|
|
|
myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git')
|
2016-11-21 23:24:11 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
