Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jokeyrhyme/package-diff-summary.js
compare package.json files to create CHANGELOG.md entries
https://github.com/jokeyrhyme/package-diff-summary.js
Last synced: 21 days ago
JSON representation
compare package.json files to create CHANGELOG.md entries
- Host: GitHub
- URL: https://github.com/jokeyrhyme/package-diff-summary.js
- Owner: jokeyrhyme
- License: mit
- Created: 2017-01-09T14:44:31.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2021-04-18T00:22:45.000Z (over 3 years ago)
- Last Synced: 2024-10-14T21:23:39.538Z (25 days ago)
- Language: JavaScript
- Size: 2.58 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# package-diff-summary.js [](https://www.npmjs.com/package/package-diff-summary) [](https://travis-ci.org/jokeyrhyme/package-diff-summary.js)
compare package.json files to create CHANGELOG.md entries
## Installation
```
npm install --global package-diff-summary
```
OR
```
yarn global add package-diff-summary
```
## Usage
```
Usage
$ package-diff-summary
Options
-h, --help
-v, --version
```
Output is intended to be copy-paste compatible with "Keep a CHANGELOG"
## Example
For this very project, these commands:
```sh
git checkout 1.1.0
package-diff-summary 1.0.0
```
outputs this Markdown / CommonMark text:
```md
- depend upon [github-url-from-git](https://www.npmjs.com/package/github-url-from-git) ^[1.5.0](https://github.com/visionmedia/node-github-url-from-git/blob/master/CHANGELOG.md)
- depend upon [package-engines-notifier](https://www.npmjs.com/package/package-engines-notifier) ^[1.1.0](https://github.com/jokeyrhyme/package-engines-notifier.js/releases/tag/1.1.0)
- depend upon [read-pkg-up](https://www.npmjs.com/package/read-pkg-up) ^2.0.0
```
which looks like:
> - depend upon [github-url-from-git](https://www.npmjs.com/package/github-url-from-git) ^[1.5.0](https://github.com/visionmedia/node-github-url-from-git/blob/master/CHANGELOG.md)
>
> - depend upon [package-engines-notifier](https://www.npmjs.com/package/package-engines-notifier) ^[1.1.0](https://github.com/jokeyrhyme/package-engines-notifier.js/releases/tag/1.1.0)
>
> - depend upon [read-pkg-up](https://www.npmjs.com/package/read-pkg-up) ^2.0.0
## Configuration
### GITHUB_OAUTH_TOKEN
Generate a new [GitHub Personal Access Token](https://github.com/settings/tokens) without any special permissions,
and set this as the value for the `GITHUB_OAUTH_TOKEN` environment variable.
This will reduce the likelihood of rate-limiting by GitHub's API,
which will in turn increase the accuracy of the hyperlinks discovered.
## See Also
- [dependency-diff](https://www.npmjs.com/package/dependency-diff)
- [execa](https://github.com/sindresorhus/execa)
- [Keep a CHANGELOG](http://keepachangelog.com/)
- [github](https://github.com/mikedeboer/node-github)
- [github-url-from-git](https://github.com/tj/node-github-url-from-git)
- [got](https://github.com/sindresorhus/got)
- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up)
- [semver](https://github.com/npm/node-semver)