Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuchi/java-npm-semver
Implementation of the SemVer Specification — strictly follows npm semantics
https://github.com/yuchi/java-npm-semver
java npm porting semantic semver
Last synced: 3 months ago
JSON representation
Implementation of the SemVer Specification — strictly follows npm semantics
- Host: GitHub
- URL: https://github.com/yuchi/java-npm-semver
- Owner: yuchi
- License: lgpl-2.1
- Created: 2016-12-18T13:04:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-25T16:44:27.000Z (about 5 years ago)
- Last Synced: 2024-04-14T14:12:44.033Z (10 months ago)
- Topics: java, npm, porting, semantic, semver
- Language: Java
- Homepage:
- Size: 95.7 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Java _npm_ SemVer
=================
This is a direct port [`node-semver`](https://github.com/npm/node-semver), great to have npm like semantics in a Java application.
Releases
--------
Available in the [Maven Central repository](http://search.maven.org/#artifactdetails%7Ccom.github.yuchi%7Cnpm-semver%7C1.0.0%7Cjar).
#### Maven configuration
```xml
com.github.yuchi
npm-semver
1.0.0
```
#### Gradle configuration
```groovy
compile group: "com.github.yuchi", name: "npm-semver", version: "1.0.0"
// or
compile "com.github.yuchi:npm-semver:1.0.0"
```
Quick usage
-----------
```java
Version version = Version.from("1.2.3");
Range range = Range.from("^1.2.0");
range.test(version) // true
```
Full Usage
----------
#### Version comparison
```java
boolean loose = false;
Version v1 = Version.from("1.2.3", loose);
String v2 = Version.from("1.3.0", loose);
v1.compareTo(v2); // -1
v2.compareTo(v1); // +1
v1.compareTo(v1); // 0
```
#### In Range tests
```java
boolean loose = false;
Version v = Version.from("1.2.3", loose);
Range r = Range.from("^1.0.0", loose);
r.test(v); // true
```
#### Range boundaries test
```java
boolean loose = false;
SemVer.isGreaterThenRange("1.3.0", ">1.0.0 <1.4.0", loose); // false
SemVer.isGreaterThenRange("1.5.0", ">1.0.0 <1.4.0", loose); // true
SemVer.isGreaterThenRange("0.9.0", ">1.0.0 <1.4.0", loose); // false
SemVer.isLessThenRange("1.3.0", ">1.0.0 <1.4.0", loose); // false
SemVer.isLessThenRange("1.5.0", ">1.0.0 <1.4.0", loose); // false
SemVer.isLessThenRange("0.9.0", ">1.0.0 <1.4.0", loose); // true
```
#### Sorting
```java
List versions = new ArrayList();
versions.add(Version.from("4.2.0", false));
versions.add(Version.from("1.8.0", false));
versions.add(Version.from("1.2.0", false));
versions.sort(new VersionComparator()); // { "4.2.0", "1.8.0", "1.2.0" }
```
#### Versions Stream filtering
```java
List versions = new ArrayList();
versions.add(Version.from("4.2.0", false));
versions.add(Version.from("1.8.0", false));
versions.add(Version.from("1.2.0", false));
Range range = Range.from(">3.0.0", false);
version.stream().filter(range::test); // { "4.2.0" }
```
Publishing
----------
```
$ trash build
$ trash tmp
$ mkdir tmp
$ gradle clean preparePublish publish
$ gradle clean preparePublish publish # yes you need to launch it twice
```
License
-------
This library, *java-npm-semver*, is free software ("Licensed Software"); you can
redistribute it and/or modify it under the terms of the [GNU Lesser General
Public License](http://www.gnu.org/licenses/lgpl-2.1.html) as published by the
Free Software Foundation; either version 2.1 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; including but not limited to, the implied warranty of MERCHANTABILITY,
NONINFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
Public License for more details.
You should have received a copy of the [GNU Lesser General Public
License](http://www.gnu.org/licenses/lgpl-2.1.html) along with this library; if
not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
Floor, Boston, MA 02110-1301 USA