@lerna/describe-ref - npm Package Compare versions

Comparing version 3.16.5 to 4.0.0

CHANGELOG.md

@@ -6,2 +6,33 @@ # Change Log
 
+# [4.0.0](https://github.com/lerna/lerna/compare/v3.22.1...v4.0.0) (2021-02-10)
+
+
+### Code Refactoring
+
+* **describe-ref:** Add JSDoc types, remove test-only export ([e5cf30c](https://github.com/lerna/lerna/commit/e5cf30cb66f9b85f13afb475ea0c9e59c8fabba3))
+
+
+### Features
+
+* Drop support for Node v6.x & v8.x ([ff4bb4d](https://github.com/lerna/lerna/commit/ff4bb4da215555e3bb136f5af09b5cbc631e57bb))
+* Expose named export ([c1303f1](https://github.com/lerna/lerna/commit/c1303f13adc4cf15f96ff25889b52149f8224c0e))
+* Remove default export ([e2f1ec3](https://github.com/lerna/lerna/commit/e2f1ec3dd049d2a89880029908a2aa7c66f15082))
+
+
+### BREAKING CHANGES
+
+* The default export has been removed, please use a named export instead.
+* **describe-ref:** The test-only 'parse()' export has been removed.
+* Node v6.x & v8.x are no longer supported. Please upgrade to the latest LTS release.
+
+Here's the gnarly one-liner I used to make these changes:
+```
+npx lerna exec --concurrency 1 --stream -- 'json -I -f package.json -e '"'"'this.engines=this.engines||{};this.engines.node=">= 10.18.0"'"'"
+```
+(requires `npm i -g json` beforehand)
+
+
+
+
+
 ## [3.16.5](https://github.com/lerna/lerna/compare/v3.16.4...v3.16.5) (2019-10-07)
@@ -8,0 +39,0 @@

lib/describe-ref.js

@@ -6,6 +6,32 @@ "use strict";
 
-module.exports = describeRef;
-module.exports.parse = parse;
-module.exports.sync = sync;
+module.exports.describeRef = describeRef;
+module.exports.describeRefSync = describeRefSync;
 
+/**
+ * @typedef {object} DescribeRefOptions
+ * @property {string} [cwd] Defaults to `process.cwd()`
+ * @property {string} [match] Glob passed to `--match` flag
+ */
+
+/**
+ * @typedef {object} DescribeRefFallbackResult When annotated release tags are missing
+ * @property {boolean} isDirty
+ * @property {string} refCount
+ * @property {string} sha
+ */
+
+/**
+ * @typedef {object} DescribeRefDetailedResult When annotated release tags are present
+ * @property {string} lastTagName
+ * @property {string} lastVersion
+ * @property {boolean} isDirty
+ * @property {string} refCount
+ * @property {string} sha
+ */
+
+/**
+ * Build `git describe` args.
+ * @param {DescribeRefOptions} options
+ * @param {boolean} [includeMergedTags]
+ */
 function getArgs(options, includeMergedTags) {
@@ -30,3 +56,3 @@ let args = [
     // we want to consider all tags, also from merged branches
-    args = args.filter(arg => arg !== "--first-parent");
+    args = args.filter((arg) => arg !== "--first-parent");
   }
@@ -37,2 +63,7 @@
 
+/**
+ * @param {DescribeRefOptions} [options]
+ * @param {boolean} [includeMergedTags]
+ * @returns {Promise<DescribeRefFallbackResult|DescribeRefDetailedResult>}
+ */
 function describeRef(options = {}, includeMergedTags) {
@@ -42,3 +73,3 @@ const promise = childProcess.exec("git", getArgs(options, includeMergedTags), options);
   return promise.then(({ stdout }) => {
-    const result = parse(stdout, options);
+    const result = parse(stdout, options.cwd);
 
@@ -52,5 +83,9 @@ log.verbose("git-describe", "%j => %j", options && options.match, stdout);
 
-function sync(options = {}, includeMergedTags) {
+/**
+ * @param {DescribeRefOptions} [options]
+ * @param {boolean} [includeMergedTags]
+ */
+function describeRefSync(options = {}, includeMergedTags) {
   const stdout = childProcess.execSync("git", getArgs(options, includeMergedTags), options);
-  const result = parse(stdout, options);
+  const result = parse(stdout, options.cwd);
 
@@ -63,3 +98,9 @@ // only called by collect-updates with no matcher
 
-function parse(stdout, options = {}) {
+/**
+ * Parse git output and return relevant metadata.
+ * @param {string} stdout Result of `git describe`
+ * @param {string} [cwd] Defaults to `process.cwd()`
+ * @returns {DescribeRefFallbackResult|DescribeRefDetailedResult}
+ */
+function parse(stdout, cwd) {
   const minimalShaRegex = /^([0-9a-f]{7,40})(-dirty)?$/;
@@ -72,3 +113,3 @@ // when git describe fails to locate tags, it returns only the minimal sha
     // count number of commits since beginning of time
-    const refCount = childProcess.execSync("git", ["rev-list", "--count", sha], options);
+    const refCount = childProcess.execSync("git", ["rev-list", "--count", sha], { cwd });
 
@@ -75,0 +116,0 @@ return { refCount, sha, isDirty: Boolean(isDirty) };

package.json

 {
   "name": "@lerna/describe-ref",
-  "version": "3.16.5",
+  "version": "4.0.0",
   "description": "Parse git describe output for lerna-related tags",
@@ -19,3 +19,3 @@ "keywords": [
   "engines": {
-    "node": ">= 6.9.0"
+    "node": ">= 10.18.0"
   },
@@ -34,6 +34,6 @@ "publishConfig": {
   "dependencies": {
-    "@lerna/child-process": "3.16.5",
+    "@lerna/child-process": "4.0.0",
     "npmlog": "^4.1.2"
   },
-  "gitHead": "f0574092a2db90142b3a27ec1a4941cddbdcdf62"
+  "gitHead": "4582c476e07dddddd6b2e3ab6e7f52c1f9eed59a"
 }

README.md

@@ -8,3 +8,3 @@ # `@lerna/describe-ref`
 ```js
-const describe = require("@lerna/describe-ref");
+const { describe } = require("@lerna/describe-ref");
 
@@ -11,0 +11,0 @@ (async () => {

No alert changes

Improved metrics

Total package byte prevSize

10248

increased by29.82%

Lines of code

95

increased by66.67%

Dependency changes

• + Added@lerna/child-process@4.0.0(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcross-spawn@7.0.3(transitive)

• + Addedexeca@5.1.1(transitive)

• + Addedget-stream@6.0.1(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedhuman-signals@2.1.0(transitive)

• + Addedis-stream@2.0.1(transitive)

• + Addedmerge-stream@2.0.0(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addednpm-run-path@4.0.1(transitive)

• + Addedonetime@5.1.2(transitive)

• + Addedpath-key@3.1.1(transitive)

• + Addedshebang-command@2.0.0(transitive)

• + Addedshebang-regex@3.0.0(transitive)

• + Addedstrip-final-newline@2.0.0(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedwhich@2.0.2(transitive)

• - Removed@lerna/child-process@3.16.5(transitive)

• - Removedansi-styles@3.2.1(transitive)

• - Removedchalk@2.4.2(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedcross-spawn@6.0.5(transitive)

• - Removedend-of-stream@1.4.4(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedexeca@1.0.0(transitive)

• - Removedget-stream@4.1.0(transitive)

• - Removedhas-flag@3.0.0(transitive)

• - Removedis-stream@1.1.0(transitive)

• - Removednice-try@1.0.5(transitive)

• - Removednpm-run-path@2.0.2(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedp-finally@1.0.0(transitive)

• - Removedpath-key@2.0.1(transitive)

• - Removedpump@3.0.0(transitive)

• - Removedsemver@5.7.2(transitive)

• - Removedshebang-command@1.2.0(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedstrip-eof@1.0.0(transitive)

• - Removedsupports-color@5.5.0(transitive)

• - Removedwhich@1.3.1(transitive)

• - Removedwrappy@1.0.2(transitive)

• Updated@lerna/child-process@4.0.0