# @absolunet/git-remote-semver

> Git remote tags semver

Latest version **0.2.1** (published 2018-03-29) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @absolunet/git-remote-semver
pnpm add @absolunet/git-remote-semver
yarn add @absolunet/git-remote-semver
bun add @absolunet/git-remote-semver
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2018-03-29 |
| First published | 2017-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 9.9.0 |
| Dependencies | 5 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Absolunet |
| Maintainers | absolunetdev, jblandry |

## Links

- npm: https://www.npmjs.com/package/@absolunet/git-remote-semver
- Repository: https://github.com/absolunet/node-git-remote-semver
- Issues: https://github.com/absolunet/node-git-remote-semver/issues
- npm.io page: https://npm.io/package/@absolunet/git-remote-semver

## Dependencies (5)

- [boxen](https://npm.io/package/boxen.md) ^1.3.0
- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [semver](https://npm.io/package/semver.md) ^5.5.0
- [to-semver](https://npm.io/package/to-semver.md) ^1.1.0
- [configstore](https://npm.io/package/configstore.md) ^3.1.2

## Recent versions

- 0.2.1 (latest) — 2018-03-29
- 0.2.0 — 2018-03-20
- 0.1.1 — 2017-09-26
- 0.1.0 — 2017-05-14
- 0.0.1 — 2017-05-14

## README

# @absolunet/git-remote-semver

[![NPM version](https://img.shields.io/npm/v/@absolunet/git-remote-semver.svg)](https://www.npmjs.com/package/@absolunet/git-remote-semver)
[![Travis build](https://api.travis-ci.org/absolunet/node-git-remote-semver.svg?branch=master)](https://travis-ci.org/absolunet/node-git-remote-semver/builds)
[![Dependencies](https://david-dm.org/absolunet/node-git-remote-semver/status.svg)](https://david-dm.org/absolunet/node-git-remote-semver)
[![Dev dependencies](https://david-dm.org/absolunet/node-git-remote-semver/dev-status.svg)](https://david-dm.org/absolunet/node-git-remote-semver?type=dev)

> Git remote tags semver


## Install

```sh
$ npm install @absolunet/git-remote-semver
```


## Usage

```js
const pkg             = require('package');
const gitRemoteSemver = require('@absolunet/git-remote-semver');

gitRemoteSemver.needUpdate('git@github.com:absolunet/node-git-remote-semver.git', pkg.version).then((version) => {
	if (version) {
		console.log(gitRemoteSemver.updateNotification({
			current: pkg.version,
			latest:  version,
			msg:     'Please update...'
		}));
	} else {
		console.log('You are up to date!');
	}
});
```


## API

### configstore(name)

Returns an [configstore](https://www.npmjs.com/package/configstore) `Object`.

#### name

*Required*  
Type: `string`  

Id for the configstore


### getVersions(url)

`Promise` returns an `Array` of valid, sorted, and cleaned semver tags.

#### url

*Required*  
Type: `string`  

The [remote git url](https://git-scm.com/docs/git-fetch#_git_urls_a_id_urls_a)


### getLatest(url)

`Promise` returns a `string` of the latest semver tag.

#### url

*Required*  
Type: `string`  

The [remote git url](https://git-scm.com/docs/git-fetch#_git_urls_a_id_urls_a)


### needUpdate(url, current)

`Promise` returns a `string` of version if `current` is lower than latest tag or `false`

#### url

*Required*  
Type: `string`  

The [remote git url](https://git-scm.com/docs/git-fetch#_git_urls_a_id_urls_a)

#### current

*Required*  
Type: `string`

Current semver version.


### updateNotification(options)

Returns a `string` of a [update-notifier](https://www.npmjs.com/package/update-notifier) style notification.

#### options

*Required*  
Type: `Object`

##### current

*Required*  
Type: `string`<br>
Current semver version.

##### latest

*Required*  
Type: `string`<br>
Latest semver version.

##### lang

Type: `string`<br>
Default: 'en'<br>
Language to use for notification (fr/en).

##### msg

Type: `string`<br>
Additional message for the notification.


### obnoxiousNotification(options)

Check for updates unobtrusively and outputs a [update-notifier](https://www.npmjs.com/package/update-notifier) style notification if an update is available.

#### options

*Required*  
Type: `Object`

##### url

*Required*  
Type: `string`<br>
The [remote git url](https://git-scm.com/docs/git-fetch#_git_urls_a_id_urls_a)


##### current

*Required*  
Type: `string`<br>
Current semver version.

##### name

*Required*  
Type: `string`<br>
Id for the configstore.

##### lang

Type: `string`<br>
Default: 'en'<br>
Language to use for notification (fr/en).

##### msg

Type: `string`<br>
Additional message for the notification.


## License

MIT © [Absolunet](https://absolunet.com)

---
_Source: https://npm.io/package/@absolunet/git-remote-semver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._