git-semver-tagger 1.9.23 → 1.9.25

package/README.md

@@ -31,12 +31,149 @@ tagger calculate-version # Now it should be available via NPM's path on your she
 
 The `calculate-version` command will generate a new version number based on all of the commits since the last tag, and output as a string.
 
+**Basic usage:**
+```bash
+tagger calculate-version
+```
+
+**Output:** `1.2.3-SNAPSHOT`
+
 ### Tag
 
 The `tag` command will create a tag with the given version and push it back to the repository.
 
 We recommend this command only is run after the build is validated. Use discernment to decide if it should happen before publication of artifacts, or afterward.
 
+**Basic usage:**
+```bash
+tagger tag --version 1.2.3 --release-branch main
+```
+
+## Structured Output
+
+Both commands support machine-readable JSON output for CI/CD pipelines and automation scripts via the `--format` flag.
+
+### Format Options
+
+- `--format=text` (default): Human-readable text output
+- `--format=json`: Structured JSON output
+
+### Calculate Version JSON Output
+
+**Example command:**
+```bash
+tagger calculate-version --format=json
+```
+
+**Success response:**
+```json
+{
+  "status": "success",
+  "data": {
+    "version": "1.2.3-SNAPSHOT",
+    "snapshot": true,
+    "snapshotReasons": [
+      "DIRTY",
+      "AHEAD"
+    ]
+  }
+}
+```
+
+**Error response:**
+```json
+{
+  "status": "error",
+  "error": "HEAD is detached (not pointing at any branch)",
+  "code": "CONFIGURATION_ERROR"
+}
+```
+
+**Fields:**
+- `status`: `"success"` or `"error"`
+- `data.version`: Calculated semantic version string
+- `data.snapshot`: Boolean indicating if this is a snapshot version
+- `data.snapshotReasons`: Array of reasons why this is a snapshot (e.g., `"DIRTY"`, `"AHEAD"`)
+- `error`: Human-readable error message (only in error responses)
+- `code`: Machine-readable error code (only in error responses)
+
+### Tag JSON Output
+
+**Example command:**
+```bash
+tagger tag --version 1.2.3 --release-branch main --format=json
+```
+
+**Success response:**
+```json
+{
+  "status": "success",
+  "data": {
+    "tag": "1.2.3"
+  }
+}
+```
+
+**Error response:**
+```json
+{
+  "status": "error",
+  "error": "Failed to create tag",
+  "code": "TAG_ERROR"
+}
+```
+
+**Fields:**
+- `status`: `"success"` or `"error"`
+- `data.tag`: The tag name that was created
+- `error`: Human-readable error message (only in error responses)
+- `code`: Machine-readable error code (only in error responses)
+
+### Error Codes
+
+- `CONFIGURATION_ERROR`: Invalid configuration or repository state (e.g., detached HEAD)
+- `TAG_ERROR`: Failed to create or push tag
+
+### CI Integration Examples
+
+**Extract version in GitHub Actions:**
+```yaml
+- name: Calculate version
+  id: version
+  run: |
+    VERSION=$(tagger calculate-version --format=json | jq -r '.data.version')
+    echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+- name: Use version
+  run: echo "Building version ${{ steps.version.outputs.version }}"
+```
+
+**Extract version in bash:**
+```bash
+# Get version
+VERSION=$(tagger calculate-version --format=json 2>/dev/null | jq -r '.data.version')
+
+# Check if snapshot
+IS_SNAPSHOT=$(tagger calculate-version --format=json 2>/dev/null | jq -r '.data.snapshot')
+
+if [ "$IS_SNAPSHOT" = "true" ]; then
+  echo "This is a snapshot build"
+fi
+```
+
+**Error handling:**
+```bash
+OUTPUT=$(tagger calculate-version --format=json 2>&1)
+STATUS=$(echo "$OUTPUT" | jq -r '.status')
+
+if [ "$STATUS" = "error" ]; then
+  ERROR_MSG=$(echo "$OUTPUT" | jq -r '.error')
+  ERROR_CODE=$(echo "$OUTPUT" | jq -r '.code')
+  echo "Error ($ERROR_CODE): $ERROR_MSG"
+  exit 1
+fi
+```
+
 ### Help
 
 For a full listing of the available options in the program, please use the built-in help command.

package/kotlin/clikt-clikt-mordant.js

@@ -66,10 +66,10 @@
     return new MordantHelpFormatter(it);
   }
   function installMordant$lambda$lambda_0(it) {
-    return MultiplatformSystem_instance.k1y(it);
+    return MultiplatformSystem_instance.l1y(it);
   }
   function installMordant$lambda$lambda_1(it) {
-    var tmp0_elvis_lhs = MultiplatformSystem_instance.m1y(it);
+    var tmp0_elvis_lhs = MultiplatformSystem_instance.n1y(it);
     var tmp;
     if (tmp0_elvis_lhs == null) {
       throw new FileNotFound(it);
@@ -79,14 +79,14 @@
     return tmp;
   }
   function installMordant$lambda$lambda_2(it) {
-    MultiplatformSystem_instance.l1y(it);
+    MultiplatformSystem_instance.m1y(it);
     return Unit_instance;
   }
   function installMordant$lambda$lambda_3(context, message, trailingNewline, err) {
     if (trailingNewline) {
-      get_terminal(context).k28(message, VOID, VOID, VOID, VOID, err);
+      get_terminal(context).l28(message, VOID, VOID, VOID, VOID, err);
     } else {
-      get_terminal(context).i28(message, VOID, VOID, VOID, VOID, err);
+      get_terminal(context).j28(message, VOID, VOID, VOID, VOID, err);
     }
     return Unit_instance;
   }
@@ -117,21 +117,21 @@
   }
   function MordantHelpFormatter$formatHelp$lambda(this$0, $error, $prolog, $epilog, $parameters, $programName) {
     return function ($this$verticalLayout) {
-      $this$verticalLayout.a25(1);
-      $this$verticalLayout.x24(this$0.p1i($error, $prolog, $epilog, $parameters, $programName));
+      $this$verticalLayout.b25(1);
+      $this$verticalLayout.y24(this$0.p1i($error, $prolog, $epilog, $parameters, $programName));
       return Unit_instance;
     };
   }
   function MordantHelpFormatter$renderUsage$lambda($prog, $usageParts) {
     return function ($this$definitionList) {
-      $this$definitionList.u28($prog, Text_init_$Create$($usageParts, Whitespace_NORMAL_getInstance()));
-      $this$definitionList.o28_1 = true;
-      $this$definitionList.r28(1);
+      $this$definitionList.v28($prog, Text_init_$Create$($usageParts, Whitespace_NORMAL_getInstance()));
+      $this$definitionList.p28_1 = true;
+      $this$definitionList.s28(1);
       return Unit_instance;
     };
   }
   function MordantHelpFormatter$renderProlog$lambda($this$withPadding) {
-    $this$withPadding.x26_1 = 2;
+    $this$withPadding.y26_1 = 2;
     return Unit_instance;
   }
   function MordantHelpFormatter$renderParameters$lambda(this$0, $parameters) {
@@ -139,31 +139,31 @@
       var _iterator__ex2g4s = this$0.c1k($parameters).r();
       while (_iterator__ex2g4s.s()) {
         var section = _iterator__ex2g4s.t();
-        $this$definitionList.u28(section.w1h_1, section.x1h_1);
+        $this$definitionList.v28(section.w1h_1, section.x1h_1);
       }
       return Unit_instance;
     };
   }
   function MordantHelpFormatter$renderOptionGroup$lambda($this$withPadding) {
-    $this$withPadding.u26_1 = 1;
-    $this$withPadding.x26_1 = 2;
-    $this$withPadding.w26_1 = 1;
+    $this$withPadding.v26_1 = 1;
+    $this$withPadding.y26_1 = 2;
+    $this$withPadding.x26_1 = 1;
     return Unit_instance;
   }
   function MordantHelpFormatter$renderOptionGroup$lambda_0($markdown, this$0, $options) {
     return function ($this$verticalLayout) {
-      $this$verticalLayout.z24($markdown);
-      $this$verticalLayout.z24(this$0.m1k($options));
+      $this$verticalLayout.a25($markdown);
+      $this$verticalLayout.a25(this$0.m1k($options));
       return Unit_instance;
     };
   }
   function MordantHelpFormatter$buildParameterList$lambda($rows, this$0) {
     return function ($this$definitionList) {
-      $this$definitionList.o28_1 = true;
+      $this$definitionList.p28_1 = true;
       var _iterator__ex2g4s = $rows.r();
       while (_iterator__ex2g4s.s()) {
         var row = _iterator__ex2g4s.t();
-        $this$definitionList.v28(this$0.h1l(row), this$0.i1l(row));
+        $this$definitionList.w28(this$0.i1l(row), this$0.j1l(row));
       }
       return Unit_instance;
     };
@@ -174,18 +174,18 @@
     showRequiredTag = showRequiredTag === VOID ? false : showRequiredTag;
     AbstractHelpFormatter.call(this, context, requiredOptionMarker, showDefaultValues, showRequiredTag);
   }
-  protoOf(MordantHelpFormatter).z29 = function () {
-    return get_terminal(this.d1i_1).t21_1;
+  protoOf(MordantHelpFormatter).a2a = function () {
+    return get_terminal(this.d1i_1).u21_1;
   };
   protoOf(MordantHelpFormatter).t1b = function (error, prolog, epilog, parameters, programName) {
     var widget = verticalLayout(MordantHelpFormatter$formatHelp$lambda(this, error, prolog, epilog, parameters, programName));
-    return get_terminal(this.d1i_1).l28(widget);
+    return get_terminal(this.d1i_1).m28(widget);
   };
   protoOf(MordantHelpFormatter).r1i = function (parameters, error) {
     return Text_init_$Create$(this.v1i(parameters, error));
   };
   protoOf(MordantHelpFormatter).q1i = function (parameters, programName) {
-    var title = this.a2a(this.o1i().c1l());
+    var title = this.b2a(this.o1i().d1l());
     var prog = title + ' ' + programName;
     var usageParts = this.z1i(parameters);
     var tmp;
@@ -198,11 +198,11 @@
     return tmp;
   };
   protoOf(MordantHelpFormatter).s1i = function (prolog) {
-    var tmp = this.b2a(prolog);
+    var tmp = this.c2a(prolog);
     return withPadding(tmp, false, MordantHelpFormatter$renderProlog$lambda);
   };
   protoOf(MordantHelpFormatter).u1i = function (epilog) {
-    return this.b2a(epilog);
+    return this.c2a(epilog);
   };
   protoOf(MordantHelpFormatter).t1i = function (parameters) {
     return definitionList(MordantHelpFormatter$renderParameters$lambda(this, parameters));
@@ -220,7 +220,7 @@
     var options = destination;
     if (help == null)
       return this.m1k(options);
-    var tmp = this.b2a(help);
+    var tmp = this.c2a(help);
     var markdown = withPadding(tmp, false, MordantHelpFormatter$renderOptionGroup$lambda);
     return verticalLayout(MordantHelpFormatter$renderOptionGroup$lambda_0(markdown, this, options));
   };
@@ -230,36 +230,36 @@
     return '<' + name.toLowerCase() + '>';
   };
   protoOf(MordantHelpFormatter).k1k = function (name) {
-    return this.z29().i21('danger').g1u(name);
+    return this.a2a().j21('danger').h1u(name);
   };
   protoOf(MordantHelpFormatter).t1k = function (name) {
-    return this.z29().i21('muted').g1u(name);
+    return this.a2a().j21('muted').h1u(name);
   };
   protoOf(MordantHelpFormatter).j1i = function (name) {
-    return this.z29().i21('info').g1u(name);
+    return this.a2a().j21('info').h1u(name);
   };
   protoOf(MordantHelpFormatter).m1i = function (name) {
-    return this.z29().i21('info').g1u(name);
+    return this.a2a().j21('info').h1u(name);
   };
   protoOf(MordantHelpFormatter).n1i = function (name) {
-    return this.z29().i21('info').g1u(name);
+    return this.a2a().j21('info').h1u(name);
   };
   protoOf(MordantHelpFormatter).b1k = function (title) {
-    return this.z29().i21('warning').g1u(title);
+    return this.a2a().j21('warning').h1u(title);
   };
-  protoOf(MordantHelpFormatter).a2a = function (title) {
-    return this.z29().i21('warning').g1u(title);
+  protoOf(MordantHelpFormatter).b2a = function (title) {
+    return this.a2a().j21('warning').h1u(title);
   };
   protoOf(MordantHelpFormatter).x1i = function (title) {
-    return this.z29().i21('danger').g1u(title);
+    return this.a2a().j21('danger').h1u(title);
   };
   protoOf(MordantHelpFormatter).c1j = function (parameter) {
-    return this.z29().i21('muted').g1u(parameter);
+    return this.a2a().j21('muted').h1u(parameter);
   };
   protoOf(MordantHelpFormatter).v1k = function (metavar) {
-    return this.z29().i21('warning').x1x(this.z29().i21('muted')).g1u(metavar);
+    return this.a2a().j21('warning').y1x(this.a2a().j21('muted')).h1u(metavar);
   };
-  protoOf(MordantHelpFormatter).h1l = function (row) {
+  protoOf(MordantHelpFormatter).i1l = function (row) {
     var tmp;
     // Inline function 'kotlin.text.isNullOrEmpty' call
     var this_0 = row.a1i_1;
@@ -281,13 +281,13 @@
     var termPrefix = tmp;
     return Text_init_$Create$(termPrefix + row.y1h_1, Whitespace_PRE_WRAP_getInstance());
   };
-  protoOf(MordantHelpFormatter).i1l = function (row) {
-    return isBlank(row.z1h_1) ? Text_init_$Create$('') : this.b2a(row.z1h_1);
+  protoOf(MordantHelpFormatter).j1l = function (row) {
+    return isBlank(row.z1h_1) ? Text_init_$Create$('') : this.c2a(row.z1h_1);
   };
   protoOf(MordantHelpFormatter).m1k = function (rows) {
     return definitionList(MordantHelpFormatter$buildParameterList$lambda(rows, this));
   };
-  protoOf(MordantHelpFormatter).b2a = function (text) {
+  protoOf(MordantHelpFormatter).c2a = function (text) {
     return Text_init_$Create$(replace(text, '\n\n', '\x85\x85'), Whitespace_NORMAL_getInstance());
   };
   //region block: exports