https://github.com/jamiemason/conventional-recommended-version

Determine the semantic version number of your project
https://github.com/jamiemason/conventional-recommended-version

Last synced: about 1 month ago
JSON representation

Determine the semantic version number of your project

• Host: GitHub
• URL: https://github.com/jamiemason/conventional-recommended-version
• Owner: JamieMason
• License: other
• Created: 2015-11-06T12:54:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-22T11:08:26.000Z (over 2 years ago)
• Last Synced: 2025-04-29T10:50:11.315Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/conventional-recommended-version
• Size: 146 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# conventional-recommended-version

Using a

[conventional-changelog](https://github.com/ajoslin/conventional-changelog)

commit history, determine the current version number of your project.

This is done by reading your local git commit history and searching for fixes,

features, and breaking changes.

## Installation

```

npm install conventional-recommended-version

```

## Usage

```js

import { getVersion } from 'conventional-recommended-version';

getVersion('/Users/you/projects/some-project').then(console.log);

// { major: 1, minor: 0, patch: 0 }

```

## Supported Conventions

conventional-recommended-version currently only supports the

[angular conventional-changelog convention](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md)

as that's the one I use.

Patches are welcome.

## Badges

- [![NPM version](http://img.shields.io/npm/v/conventional-recommended-version.svg?style=flat-square)](https://www.npmjs.com/package/conventional-recommended-version)

- [![NPM downloads](http://img.shields.io/npm/dm/conventional-recommended-version.svg?style=flat-square)](https://www.npmjs.com/package/conventional-recommended-version)

- [![Follow JamieMason on GitHub](https://img.shields.io/github/followers/JamieMason.svg?style=social&label=Follow)](https://github.com/JamieMason)

- [![Follow fold_left on Twitter](https://img.shields.io/twitter/follow/fold_left.svg?style=social&label=Follow)](https://twitter.com/fold_left)