semver-parser - npm Package Compare versions

Comparing version 2.0.7 to 3.0.0-b.1

index.js

@@ -8,181 +8,6 @@ /**
 /* api */
-const {getType, isString} = require("./modules/common");
+const {
+  compareSemVer, isValidSemVer, parseSemVer, promises,
+} = require("./modules/semver");
 
-/* constants */
-const BASE = 10;
-const INT = "(?:0|[1-9]\\d*)";
-const ALPHA_NUM = "\\d*[A-z-][A-z\\d-]*";
-const PRE_PART = `(?:${ALPHA_NUM}|${INT})`;
-const PRE = `${PRE_PART}(?:\\.${PRE_PART})*`;
-const BUILD_PART = `(?:${ALPHA_NUM}|\\d+)`;
-const BUILD = `${BUILD_PART}(?:\\.${BUILD_PART})*`;
-const SEMVER = `(${INT}(?:\\.${INT}){2})(?:-(${PRE}))?(?:\\+(${BUILD}))?`;
-const REGEXP_INT = new RegExp(`^${INT}$`);
-const REGEXP_SEMVER = new RegExp(`^v?${SEMVER}$`);
-const REGEXP_SEMVER_STRICT = new RegExp(`^${SEMVER}$`);
-
-/**
- * is valid SemVer string
- * @param {string} version - version string
- * @param {boolean} [strict] - reject "v" prefixed
- * @returns {boolean} - result
- */
-const isValidSemVer = (version, strict = false) => {
-  if (!isString(version)) {
-    throw new TypeError(`Expected String but got ${getType(version)}`);
-  }
-  const reg = strict && REGEXP_SEMVER_STRICT || REGEXP_SEMVER;
-  return reg.test(version);
-};
-
-/**
- * parse version part
- * @param {string} part - version part
- * @param {boolean} [nonPosInt] - accept non positive integer
- * @returns {string|number} - parsed version part
- */
-const parseVersionPart = (part, nonPosInt = false) => {
-  if (!isString(part)) {
-    throw new TypeError(`Expected String but got ${getType(part)}.`);
-  }
-  if (!(nonPosInt || REGEXP_INT.test(part))) {
-    throw new Error(`${part} is not a stringified positive integer.`);
-  }
-  if (REGEXP_INT.test(part)) {
-    part = parseInt(part, BASE);
-    if (Number.isNaN(part)) {
-      throw new TypeError(`${part} is not a Number.`);
-    }
-    if (!Number.isSafeInteger(part)) {
-      throw new RangeError(`${part} exceeds ${Number.MAX_SAFE_INTEGER}.`);
-    }
-  }
-  return part;
-};
-
-/**
- * compare SemVer
- * @param {string} version - version string
- * @param {string} base - base version string to compare from
- * @param {boolean} [strict] - reject "v" prefixed
- * @returns {number}
- *   - -1 or negative number, if version is less than base version
- *     0, if version is equal to base version
- *     1 or positive number, if version is greater than base version
- */
-const compareSemVer = (version, base, strict = false) => {
-  if (!isString(version)) {
-    throw new TypeError(`Expected String but got ${getType(version)}`);
-  }
-  if (!isString(base)) {
-    throw new TypeError(`Expected String but got ${getType(base)}`);
-  }
-  if (!isValidSemVer(version, !!strict)) {
-    throw new Error(`${version} is not valid version string.`);
-  }
-  if (!isValidSemVer(base, !!strict)) {
-    throw new Error(`${base} is not valid version string.`);
-  }
-  let result;
-  if (version === base) {
-    result = 0;
-  } else {
-    const reg = strict && REGEXP_SEMVER_STRICT || REGEXP_SEMVER;
-    const [, vRel, vPre] = version.match(reg);
-    const [, bRel, bPre] = base.match(reg);
-    const [vMajor, vMinor, vPatch] = vRel.split(".").map(parseVersionPart);
-    const [bMajor, bMinor, bPatch] = bRel.split(".").map(parseVersionPart);
-    if (vMajor > bMajor) {
-      result = 1;
-    } else if (vMajor < bMajor) {
-      result = -1;
-    } else if (vMinor > bMinor) {
-      result = 1;
-    } else if (vMinor < bMinor) {
-      result = -1;
-    } else if (vPatch > bPatch) {
-      result = 1;
-    } else if (vPatch < bPatch) {
-      result = -1;
-    } else if (vPre === bPre) {
-      result = 0;
-    } else if (!vPre && bPre) {
-      result = 1;
-    } else if (vPre && !bPre) {
-      result = -1;
-    } else {
-      const vPreParts = vPre.split(".").map(part =>
-        parseVersionPart(part, true)
-      );
-      const bPreParts = bPre.split(".").map(part =>
-        parseVersionPart(part, true)
-      );
-      const l = Math.max(vPreParts.length, bPreParts.length);
-      let i = 0;
-      while (i < l) {
-        const vPart = vPreParts[i];
-        const bPart = bPreParts[i];
-        if (vPart && !bPart || isString(vPart) && Number.isInteger(bPart)) {
-          result = 1;
-        } else if (!vPart && bPart ||
-                   Number.isInteger(vPart) && isString(bPart)) {
-          result = -1;
-        } else if (vPart !== bPart && isString(vPart) && isString(bPart)) {
-          result = vPart.localeCompare(bPart);
-        } else if (Number.isInteger(vPart) && Number.isInteger(bPart)) {
-          if (vPart > bPart) {
-            result = 1;
-          } else if (vPart < bPart) {
-            result = -1;
-          }
-        }
-        if (Number.isInteger(result)) {
-          break;
-        }
-        i++;
-      }
-    }
-  }
-  if (!Number.isInteger(result)) {
-    throw new Error(`Failed to compare ${version} with ${base}.`);
-  }
-  return result;
-};
-
-/**
- * parse SemVer string
- * @param {string} version - version string
- * @param {boolean} [strict] - reject "v" prefixed
- * @returns {Object}
- *   - result which contains properties below
- *     version {string} - given version string
- *     matches {boolean} - matches SemVer format
- *     major {number|undefined} - major version
- *     minor {number|undefined} - minor version
- *     patch {number|undefined} - patch version
- *     pre {Array<string|number>|undefined} - pre release version in array
- *     build {Array<string|number>|undefined} - build ID in array
- */
-const parseSemVer = (version, strict = false) => {
-  if (!isString(version)) {
-    throw new TypeError(`Expected String but got ${getType(version)}`);
-  }
-  const matches = isValidSemVer(version, !!strict);
-  let major, minor, patch, pre, build;
-  if (matches) {
-    const reg = strict && REGEXP_SEMVER_STRICT || REGEXP_SEMVER;
-    const [, vRel, vPre, vBuild] = version.match(reg);
-    [major, minor, patch] = vRel.split(".").map(parseVersionPart);
-    if (vPre) {
-      pre = vPre.split(".").map(part => parseVersionPart(part, true));
-    }
-    if (vBuild) {
-      build = vBuild.split(".").map(part => parseVersionPart(part, true));
-    }
-  }
-  return {
-    version, matches, major, minor, patch, pre, build,
-  };
-};
-
 module.exports = {
@@ -192,3 +17,3 @@ compareSemVer,
   parseSemVer,
-  parseVersionPart,
+  promises,
 };

package.json

@@ -13,3 +13,3 @@ {
   "engines": {
-    "node": ">=8.9.0"
+    "node": ">=10.4.1"
   },
@@ -23,8 +23,8 @@ "main": "./index.js",
     "chai": "^4.2.0",
-    "eslint": "^5.7.0",
+    "eslint": "^5.12.0",
     "mocha": "^5.2.0",
     "nyc": "^13.1.0",
-    "sinon": "^7.0.0"
+    "sinon": "^7.2.2"
   },
-  "version": "2.0.7"
+  "version": "3.0.0-b.1"
 }

README.md

@@ -17,2 +17,21 @@ [![Build Status](https://travis-ci.org/asamuzaK/semverParser.svg?branch=master)](https://travis-ci.org/asamuzaK/semverParser)
 
+APIs can be used either synchronously or asynchronously.
+Async function returns Promise which resolves with the result.
+
+sync:
+```
+const {
+  compareSemVer, isValidSemVer, parseSemVer,
+} = require("semver-parser");
+```
+
+async:
+```
+const {
+  promises: {
+    compareSemVer, isValidSemVer, parseSemVer,
+  },
+} = require("semver-parser");
+```
+
 NOTE: [Is "v1.2.3" a semantic version?](https://github.com/mojombo/semver/blob/master/semver.md#is-v123-a-semantic-version "semver/semver.md at master · mojombo/semver")
@@ -19,0 +38,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19041

increased by14.38%

Number of package files

6

increased by20%

Lines of code

355

increased by21.99%

Number of lines in readme file

267

increased by7.66%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes