https://github.com/warningimhack3r/npm-stats-comparator

Compare a few statistics between two GitHub releases of an NPM package
https://github.com/warningimhack3r/npm-stats-comparator

github-releases golang npm

Last synced: about 1 month ago
JSON representation

Compare a few statistics between two GitHub releases of an NPM package

• Host: GitHub
• URL: https://github.com/warningimhack3r/npm-stats-comparator
• Owner: WarningImHack3r
• Created: 2024-04-01T22:45:41.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T06:00:35.000Z (4 months ago)
• Last Synced: 2024-09-07T07:21:18.881Z (4 months ago)
• Topics: github-releases, golang, npm
• Language: Go
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# npm-stats-comparator

Compare a few statistics between two GitHub releases of an NPM package. **For now, only the LOCs comparison is available.**  

Includes the intermediate releases between the two specified releases.

_Inspired by [this tweet](https://twitter.com/denlukia/status/1772818790415225202) by [@denlukia](https://github.com/denlukia)._

[![Demo](https://github.com/WarningImHack3r/npm-stats-comparator/assets/43064022/5e822a1d-3d1c-4e6e-b381-4751220cac59)](https://twitter.com/probably_coding/status/1774934048114164069)

:---:

*Demo (click the image to watch the video!)*

## Usage

```bash

$ ./npm-stats-comparator --repo user/repo --from v1.0.0 --to v2.0.0

```

Available options:

- `--repo`: The GitHub repository to compare the releases from.

- `--token`: The GitHub token to use for the requests. _(Optional, defaults to none)_

- `--from`: The base release to compare from.

- `--to`: The release to compare to.

- `--ignore`: A regex pattern to ignore tag names. _(Optional, defaults to none)_

- `--output`: The output directory to download releases into. _(Optional, defaults to `./releases/`)_

- `--remove`: Remove the downloaded releases after the comparison. _(Optional, defaults to `false`)_

- `--help`: Display the help message.

- `--version`: Display the version of the script.

## Installation

Just download the binary from the [Releases page](https://github.com/WarningImHack3r/npm-stats-comparator/releases)

and you're good to Go!