Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/XervoIO/get-version
Get the node version from a package.json
https://github.com/XervoIO/get-version
Last synced: about 2 months ago
JSON representation
Get the node version from a package.json
- Host: GitHub
- URL: https://github.com/XervoIO/get-version
- Owner: XervoIO
- License: mit
- Created: 2015-03-27T19:40:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-19T17:45:50.000Z (over 6 years ago)
- Last Synced: 2024-07-03T09:52:41.915Z (3 months ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 6
- Watchers: 12
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
get-version
===========
[](http://badge.fury.io/js/get-version) [](https://codeclimate.com/github/onmodulus/get-version)
Parse package.json files and determine a version for npm, node or iojs.
## Installation
`$ npm install get-version`
## Usage
There are 3 supported engines: **npm**, **node** and **iojs**.
### Command Line
```
$ get-version --engine /path/to/package.json
> 0.12.0
```
### CommonJS
get-version returns a promise.
```js
var getVersion = require('get-version');
getVersion('npm', '/path/to/package.json').then(success, failure);
```
`success` receives a string of the resolved version.
`failure` receives an instance of Error.
### Notes
If no package.json file is specified, get-version will return the latest version for the specified engine.
get-version will use semantic versioning to find versions for both npm and iojs if one is not specified.
Since node uses it's own versioning system, semantic versioning is not used to find node versions. It uses the following rules to evaluate node versions:
* If `latest` or `*` are specified, the latest stable version of node will be used.
* If a valid node version cannot be found, get-version will attempt to find an appropriate version of iojs and use it instead.
* If neither a node nor iojs version can be found, the latest stable version of node will be used.
* If the node engine is requested but an iojs key/value is present in the engines property of the package.json, iojs will be used without a fallback to node.
### License
The MIT License (MIT)
Copyright (c) 2015 Modulus
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.