https://github.com/pnpm/colorize-semver-diff
Makes a colorful semver diff
https://github.com/pnpm/colorize-semver-diff
Last synced: 2 months ago
JSON representation
Makes a colorful semver diff
- Host: GitHub
- URL: https://github.com/pnpm/colorize-semver-diff
- Owner: pnpm
- License: mit
- Created: 2020-01-15T01:13:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-03T06:22:33.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T02:29:54.031Z (3 months ago)
- Language: TypeScript
- Size: 32.2 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @pnpm/colorize-semver-diff
> Makes a colorful semver diff
[](https://www.npmjs.com/package/@pnpm/colorize-semver-diff) [](https://travis-ci.org/pnpm/colorize-semver-diff)
## Installation
```sh
add @pnpm/colorize-semver-diff
```
## Usage
```ts
import colorizeSemverDiff from '@pnpm/colorize-semver-diff'
console.log(colorizeSemverDiff({
change: 'feature',
diff: [['2'], ['1', '0', 'rc', '1']]
}))
```
## API
### colorizeSemverDiff(semverDiff)
Returns a string with ANSI colors.
#### semverDiff.change
type: `unknown`, `breaking`, `feature`, `fix`
#### semverDiff.diff[0]
type: `string[]`
An array of version parts that are unchanged. For instance, in a diff between
`1.0.0` and `1.2.0` the unchanged part will be `['1']`.
#### semverDiff.diff[1]
type: `string[]`
An array of version parts that are changed. For instance, in a diff between
`1.0.0` and `1.2.0` the changed part will be `['2', '0']`.
## Related
* [@pnpm/semver-diff](https://github.com/pnpm/semver-diff) - Gets the difference between two semver versions
## License
[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io/)