253 lines
9.0 KiB
Markdown
253 lines
9.0 KiB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
|
|
|
|
|
|
[](#)
|
|
|
|
# gry
|
|
|
|
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://travis-ci.org/IonicaBizau/node-gry/) [](https://www.npmjs.com/package/gry) [](https://www.npmjs.com/package/gry) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
|
|
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
|
|
|
> A minimalist NodeJS wrapper for the `git` commands. `gry` stands for the Git RepositorY.
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save gry
|
|
|
|
# Using yarn
|
|
yarn add gry
|
|
```
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
// Dependencies
|
|
const Repo = require("gry")
|
|
, fs = require("fs")
|
|
, oneByOne = require("one-by-one")
|
|
;
|
|
|
|
// Create the repository
|
|
var myRepo = new Repo("./foo");
|
|
oneByOne([
|
|
myRepo.create.bind(myRepo)
|
|
, cb => {
|
|
console.log("> Created the repository.");
|
|
fs.writeFile("./foo/README", "Hello World!", cb);
|
|
}
|
|
, cb => {
|
|
console.log("> Created README.md");
|
|
myRepo.exec("add .", cb);
|
|
}
|
|
, cb => {
|
|
console.log("> Added the files.");
|
|
myRepo.commit("Initial commit.", cb);
|
|
}
|
|
, cb => {
|
|
console.log("> Created the initial commit.");
|
|
cb();
|
|
}
|
|
], function (err) {
|
|
console.log(err ? "An error appeared: " + err.stack : "Successfully done.");
|
|
});
|
|
```
|
|
|
|
|
|
|
|
## :question: Get Help
|
|
|
|
There are few ways to get help:
|
|
|
|
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
|
2. For bug reports and feature requests, open issues. :bug:
|
|
|
|
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
|
|
|
|
|
|
|
|
## :memo: Documentation
|
|
|
|
|
|
### `Gry(options)`
|
|
Creates a new `Gry` instance.
|
|
|
|
#### Params
|
|
|
|
- **Object** `options`: An object containing the following fields:
|
|
- `path` (String): The path to the git repository.
|
|
- `limit` (Number): The limit of commands to run same time.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `exec(command, args, callback)`
|
|
Executes a git command in the repository directory.
|
|
|
|
#### Params
|
|
|
|
- **String** `command`: The git command that should be executed in the repository directory.
|
|
- **Array** `args`: An array of options passed to the spawned process. This is optional (if not provided, `exec` will be used instead).
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `init(callback)`
|
|
Inits the git repository.
|
|
|
|
#### Params
|
|
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `create(path, callback)`
|
|
Creates a git repository.
|
|
|
|
#### Params
|
|
|
|
- **String** `path`: The path of the repository.
|
|
- **Function** `callback`: The callback function
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `commit(message, options, callback)`
|
|
Creates a commit, providing the `message`.
|
|
|
|
#### Params
|
|
|
|
- **String** `message`: The commit message
|
|
- **String** `options`: Additional options passed to the commit command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `pull(options, callback)`
|
|
Runs `git pull`.
|
|
|
|
#### Params
|
|
|
|
- **String** `options`: Additional options passed to the `pull` command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `add(options, callback)`
|
|
Runs `git add`.
|
|
|
|
#### Params
|
|
|
|
- **String** `options`: Additional options passed to the `add` command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `branch(options, callback)`
|
|
Runs `git branch`.
|
|
|
|
#### Params
|
|
|
|
- **String** `options`: Additional options passed to the `branch` command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `checkout(options, callback)`
|
|
Runs `git checkout`.
|
|
|
|
#### Params
|
|
|
|
- **String** `options`: Additional options passed to the `checkout` command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
### `clone(gitUrl, options, callback)`
|
|
Runs `git clone`.
|
|
|
|
#### Params
|
|
|
|
- **String** `gitUrl`: The git url of the repository that should be cloned.
|
|
- **String** `options`: Additional options passed to the `checkout` command.
|
|
- **Function** `callback`: The callback function.
|
|
|
|
#### Return
|
|
- **Gry** The `Gry` instance.
|
|
|
|
|
|
|
|
## :yum: How to contribute
|
|
Have an idea? Found a bug? See [how to contribute][contributing].
|
|
|
|
|
|
## :sparkling_heart: Support my projects
|
|
|
|
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
|
|
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
|
|
|
|
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
|
|
|
|
|
|
- Starring and sharing the projects you like :rocket:
|
|
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
|
|
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
|
|
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
|
|
|
|
|
|
|
|
|
|
Thanks! :heart:
|
|
|
|
|
|
## :dizzy: Where is this library used?
|
|
If you are using this library in one of your projects, add it in this list. :sparkles:
|
|
|
|
|
|
- [`bloggify-tools`](https://github.com/Bloggify/bloggify-tools)—Interactive command line tool to help you win at Bloggify.
|
|
- [`cdnjs-importer`](https://github.com/cdnjs/cdnjs-importer)—Easy way to import a library into CDNJS.
|
|
- [`engine-tools`](https://github.com/jillix/engine-tools) (by jillix)—Engine Tools library and CLI app.
|
|
- [`gh-contributions`](https://github.com/IonicaBizau/github-contributions)—A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
|
|
- [`git-issues`](https://github.com/softwarescales/git-issues) (by Gabriel Petrovay)—Git issues extension to list issues of a Git project
|
|
- [`git-package-json`](https://github.com/IonicaBizau/git-package-json#readme)—Get the package.json contents from git repositories.
|
|
- [`git-stats`](https://github.com/IonicaBizau/git-stats)—Local git statistics including GitHub-like contributions calendars.
|
|
- [`git-stats-importer`](https://github.com/IonicaBizau/git-stats-importer)—Imports your commits from a repository into git-stats history.
|
|
- [`gpm`](https://github.com/IonicaBizau/gpm)—npm + git = gpm - Install NPM packages and dependencies from git repositories.
|
|
- [`machine-ip`](https://github.com/IonicaBizau/machine-ip#readme)—Update your public ip information in a git repository.
|
|
- [`np-init`](https://github.com/IonicaBizau/np-init#readme)—Easily start a npm package from scratch.
|
|
- [`repo-downloader`](https://github.com/IonicaBizau/repository-downloader)—Download all the repositories from BitBucket and GitHub, including your account, teams and where you created pull requests.
|
|
- [`repository-downloader`](https://github.com/IonicaBizau/repository-downloader)—Download all the repositories from BitBucket and GitHub, including your account, teams and where you created pull requests.
|
|
- [`ssh-remote`](https://github.com/IonicaBizau/ssh-remote)—Automagically switch on the SSH remote url in a Git repository.
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
|
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
|
|
|
|
[patreon]: https://www.patreon.com/ionicabizau
|
|
[amazon]: http://amzn.eu/hRo9sIZ
|
|
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|
|
|
|
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
|
|
[website]: https://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|