Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willmendesneto/node-github-diff
Github diffs with Node style 😎
https://github.com/willmendesneto/node-github-diff
diff git github github-diffs hacktoberfest node-github-diff nodejs
Last synced: about 2 months ago
JSON representation
Github diffs with Node style 😎
- Host: GitHub
- URL: https://github.com/willmendesneto/node-github-diff
- Owner: willmendesneto
- License: mit
- Created: 2018-04-05T12:09:06.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T06:41:24.000Z (about 2 months ago)
- Last Synced: 2024-11-12T07:31:22.868Z (about 2 months ago)
- Topics: diff, git, github, github-diffs, hacktoberfest, node-github-diff, nodejs
- Language: JavaScript
- Homepage:
- Size: 464 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# node-github-diff
[](https://greenkeeper.io/)
[](https://circleci.com/gh/willmendesneto/node-github-diff)
[](https://coveralls.io/github/willmendesneto/node-github-diff?branch=master)
> Github diffs with Node style 😎
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]
A script to check the diffs between project versions.
## Usage
```js
const nodeGithubDiff = require('node-github-diff');
// Using promises
nodeGithubDiff({
repository: 'willmendesneto/generator-update-yeoman-test',
base: 'v0.0.3',
head: 'v0.0.5',
})
.then((gitPatches) => console.log(gitPatches));
// using async/await
const gitPatches = await nodeGithubDiff({
repository: 'willmendesneto/generator-update-yeoman-test',
base: 'v0.0.3',
head: 'v0.0.5',
});
console.log(gitPatches);
```
## Setup
### Private repositories
In order to use node-github-diff in private repositories you'll need to
[create a personal access token](https://github.com/settings/tokens)
which has permissions to read private repositories:
Then, you can pass the github token information in the options object, using the `token` key.
```js
const nodeGithubDiff = require('node-github-diff');
...
nodeGithubDiff({
repository: 'willmendesneto/generator-update-yeoman-test',
base: 'v0.0.3',
head: 'v0.0.5',
token: 'your-github-token',
});
...
```
### Run node-github-diff
Make sure you have `npm@>=9.6.7`:
```
npm install -g npm@latest
```
This package is using `async/await` feature, so please make sure you are using `node@>=v18.0.0` which supports this feature by default based on [Node.green website](https://node.green/). In case you can't please make sure you're running the code with `--harmony-async-await` flag or using solving in your code.
### Parameters
- `repository`: Github repository to be checked;
- `base`: Package version to use as a starting point to check the diff;
- `head`: Package version to use as a final point to check the diff;
- `token`: github token to be used in case of private repositories;
## Author
**Wilson Mendes (willmendesneto)**
+
+
[license-badge]: https://img.shields.io/badge/license-MIT%20License-blue.svg?style=flat-square
[license]: https://github.com/willmendesneto/node-github-diff/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[github-watch-badge]: https://img.shields.io/github/watchers/willmendesneto/node-github-diff.svg?style=social
[github-watch]: https://github.com/willmendesneto/node-github-diff/watchers
[github-star-badge]: https://img.shields.io/github/stars/willmendesneto/node-github-diff.svg?style=social
[github-star]: https://github.com/willmendesneto/node-github-diff/stargazers
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20node-github-diff%20by%20@willmendesneto%20https://goo.gl/sqZ8dh%20%F0%9F%91%8D
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/willmendesneto/node-github-diff.svg?style=social