https://github.com/bahmutov/largest-semantic-change

Given list of semantic commit changes, returns largest one
https://github.com/bahmutov/largest-semantic-change

semantic-versioning semver

Last synced: 21 days ago
JSON representation

Given list of semantic commit changes, returns largest one

• Host: GitHub
• URL: https://github.com/bahmutov/largest-semantic-change
• Owner: bahmutov
• Created: 2017-02-14T05:57:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-15T03:59:58.000Z (almost 7 years ago)
• Last Synced: 2024-12-16T21:41:46.476Z (about 1 month ago)
• Topics: semantic-versioning, semver
• Language: JavaScript
• Size: 6.84 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# largest-semantic-change

> Given a list of semantic commit changes, returns the largest one

[![NPM][npm-icon] ][npm-url]

[![Build status][ci-image] ][ci-url]

[![semantic-release][semantic-image] ][semantic-url]

[![js-standard-style][standard-image]][standard-url]

A couple of utility methods that compare semantic changes. For example

when comparing `feat` and `chore`, `feat` is larger. Similarly, `major`

is the largest.

## Use

Install using Node `npm install --save largest-semantic-change`

```js

const {largerChange, topChange} = require('largest-semantic-change')

largerChange('feat', 'fix')       //> 'feat'

topChange(['feat', 'fix', 'fix']) //> 'feat'

```

### Input values

You can send aliases; for example `major|break` are same as `major`, `minor|feat` are same as `feat` and `patch|fix` are equivalent. Returned value is always `major|feat|fix|chore`.

### Small print

Author: Gleb Bahmutov <[email protected]> © 2017

* [@bahmutov](https://twitter.com/bahmutov)

* [glebbahmutov.com](http://glebbahmutov.com)

* [blog](http://glebbahmutov.com/blog)

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet /

[open issue](https://github.com/bahmutov/largest-semantic-change/issues) on Github

## MIT License

Copyright (c) 2017 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

[npm-icon]: https://nodei.co/npm/largest-semantic-change.svg?downloads=true

[npm-url]: https://npmjs.org/package/largest-semantic-change

[ci-image]: https://travis-ci.org/bahmutov/largest-semantic-change.svg?branch=master

[ci-url]: https://travis-ci.org/bahmutov/largest-semantic-change

[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

[semantic-url]: https://github.com/semantic-release/semantic-release

[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[standard-url]: http://standardjs.com/