mirror of
https://github.com/shimataro/ssh-key-action.git
synced 2025-06-19 22:52:10 +10:00
* first action! (#1)
This commit is contained in:
parent
8deacc95b1
commit
ace1e6a69a
3750 changed files with 1155519 additions and 0 deletions
126
node_modules/semver-utils/README.md
generated
vendored
Normal file
126
node_modules/semver-utils/README.md
generated
vendored
Normal file
|
@ -0,0 +1,126 @@
|
|||
## semver-utils.js
|
||||
|
||||
| Sponsored by [ppl](https://ppl.family)
|
||||
|
||||
Some utils that aren't provided by the mainstream `semver` module.
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
npm install --save semver-utils
|
||||
```
|
||||
|
||||
```javascript
|
||||
'use strict';
|
||||
|
||||
var semverUtils = require('semver-utils');
|
||||
var version = require('./package.json').version;
|
||||
var semver = semverUtils.parse(version);
|
||||
|
||||
console.log(semver);
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
* `semverUtils.parse(semverString)`
|
||||
* `semverUtils.stringify(semverObject)`
|
||||
* `semverUtils.parseRange(rangeString)`
|
||||
* `semverUtils.stringifyRange(rangeArray)`
|
||||
|
||||
### semverUtils.parse(semverString)
|
||||
|
||||
Turns a string such as `1.0.6-1+build-623` into the object
|
||||
|
||||
{ semver: '1.0.6-1+build-623'
|
||||
, version: '1.0.6'
|
||||
, major: '1'
|
||||
, minor: '0'
|
||||
, patch: '6'
|
||||
, release: '1'
|
||||
, build: 'build-623'
|
||||
}
|
||||
|
||||
returns `null` on **error**
|
||||
|
||||
### semverUtils.stringify(semverObject)
|
||||
|
||||
Creates a string such as `1.0.6-1+build-623` from the object
|
||||
|
||||
{ major: '1'
|
||||
, minor: '0'
|
||||
, patch: '6'
|
||||
, release: '1'
|
||||
, build: 'build-623'
|
||||
}
|
||||
|
||||
### semverUtils.parseRange(rangeString)
|
||||
|
||||
A solution to <https://github.com/isaacs/node-semver/issues/10>
|
||||
|
||||
Parses a range string into an array of semver objects
|
||||
|
||||
`>= 1.1.7 < 2.0.0 || 1.1.3` becomes
|
||||
|
||||
[
|
||||
{
|
||||
"semver": ">= v1.1.7"
|
||||
, "operator": ">="
|
||||
, "major": 1
|
||||
, "minor": 1
|
||||
, "patch": 7
|
||||
}
|
||||
, {
|
||||
"semver": "< v2.0.0"
|
||||
, "operator": "<"
|
||||
, "major": 2
|
||||
, "minor": 0
|
||||
, "patch": 0
|
||||
}
|
||||
, {
|
||||
"operator": "||"
|
||||
}
|
||||
, {
|
||||
"semver": "v1.1.3"
|
||||
, "operator": "="
|
||||
, "major": 1
|
||||
, "minor": 1
|
||||
, "patch": 3
|
||||
}
|
||||
|
||||
]
|
||||
|
||||
### semverUtils.stringifyRange(rangeArray)
|
||||
|
||||
Creates a range string such as `>= 1.1.7 < 2.0.0 || 1.1.3`
|
||||
from an array of semver objects (and operators) such as
|
||||
|
||||
[
|
||||
{ "semver": ">= v1.1.7"
|
||||
, "operator": ">="
|
||||
, "major": 1
|
||||
, "minor": 1
|
||||
, "patch": 7
|
||||
}
|
||||
, { "semver": "< v2.0.0"
|
||||
, "operator": "<"
|
||||
, "major": 2
|
||||
, "minor": 0
|
||||
, "patch": 0
|
||||
}
|
||||
, { "operator": "||"
|
||||
}
|
||||
, { "semver": "v1.1.3"
|
||||
, "operator": "="
|
||||
, "major": 1
|
||||
, "minor": 1
|
||||
, "patch": 3
|
||||
}
|
||||
|
||||
]
|
||||
|
||||
## Obsolete Work
|
||||
|
||||
* https://github.com/mojombo/semver/issues/32
|
||||
* https://gist.github.com/coolaj86/3012865
|
||||
* https://github.com/isaacs/node-semver/issues/10
|
||||
* https://github.com/mojombo/semver.org/issues/59
|
Loading…
Add table
Add a link
Reference in a new issue