A smart wrapper for nodegit that simplifies Git operations in Node.js.
Go to file
2021-10-21 19:09:14 +02:00
.vscode fix(core): update 2020-08-15 13:51:24 +00:00
test BREAKING CHANGE(dependencies): switch to isomorphic git 2021-10-21 19:09:14 +02:00
ts BREAKING CHANGE(dependencies): switch to isomorphic git 2021-10-21 19:09:14 +02:00
.gitignore fix(core): update 2020-08-15 13:51:24 +00:00
.gitlab-ci.yml fix(core): update 2020-08-15 13:51:24 +00:00
LICENSE fix(core): update 2019-06-18 15:41:03 +02:00
npmextra.json fix(core): update 2020-08-15 13:53:02 +00:00
package-lock.json BREAKING CHANGE(dependencies): switch to isomorphic git 2021-10-21 19:09:14 +02:00
package.json BREAKING CHANGE(dependencies): switch to isomorphic git 2021-10-21 19:09:14 +02:00
readme.md fix(core): update 2020-08-15 13:51:38 +00:00
tslint.json fix(core): update 2019-06-18 15:17:50 +02:00

@pushrocks/smartgit

smart wrapper for nodegit

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

Usage

We recommend the use of TypeScript for best in class intellisense

// 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
  });
myExistingGitRepo.check(); // returns promise, checks repo health
myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git');

Tip: use smartssh to setup your SSH environment

npm

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer