cliguard 0.2.0 → 0.3.0

package/README.md

@@ -71,6 +71,25 @@ npx cliguard update ./bin/cli.js
 
 `cliguard check` exits `1` if it finds even one `BREAKING` change, and `0` otherwise - safe to drop straight into any CI pipeline.
 
+Pass `--json` to `check` for a machine-readable result instead of the emoji lines above - useful for a bot that comments on the PR, a dashboard, or any other script consuming the result instead of a human reading it:
+
+```sh
+npx cliguard check ./bin/cli.js --json
+```
+
+```json
+{
+  "ok": false,
+  "changes": [
+    { "type": "BREAKING", "path": "root -> build -> option[--target]", "message": "Option \"--target\" was removed." }
+  ],
+  "summary": { "breaking": 1, "additive": 0, "patch": 0 },
+  "suggestedBump": "major"
+}
+```
+
+`suggestedBump` is the semver bump this diff implies (`"major"`, `"minor"`, `"patch"`, or `null` if nothing changed) - a direct read of the same BREAKING/ADDITIVE/PATCH classification the emoji output already uses, so a release script never has to re-derive it.
+
 ## How changes get classified
 
 | | Removed | Added | Required flipped | Value type / default changed |
@@ -115,6 +134,13 @@ Extracting a contract runs the target entry file's own top-level code, the same
 
 The CLI and core diffing engine are, and will stay, free and open-source. Planned next: a hosted add-on for teams that want more than a CI exit code - a dashboard with the history of contract changes across releases, and Slack/webhook alerts the moment a breaking change lands. See [issue: Webhook reporter for SaaS integration](https://github.com/Bryandero98/cliguard/issues) for the first building block.
 
+## Support this project
+
+cliguard is free and will stay free. If it's saving you from a broken release, a small tip helps keep it going:
+
+- **Ko-fi:** [ko-fi.com/bryandero98](https://ko-fi.com/bryandero98)
+- **USDT (TRC20):** `TEG4Kk2qXYMQ4mHNd7dPhSPRyT14CGr2or` — double-check the network is set to **TRC20** before sending; a transfer on the wrong network can't be recovered.
+
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md).

package/dist/bin.js

@@ -42,28 +42,33 @@ program
     .option(...adapterOption)
     .action(async (entry, options) => {
     if ((0, storage_1.contractExists)()) {
-        console.warn(`El contrato ya existe. Usa "cliguard update" para sobrescribirlo.`);
+        console.warn(`A contract already exists. Run "cliguard update" to overwrite it.`);
         process.exit(1);
     }
     const contract = await resolveAdapter(options.adapter).extract(entry);
     (0, storage_1.writeContract)(contract);
-    console.log(`✅ Contrato de CLI inicializado con éxito en ${(0, storage_1.getContractDisplayPath)()}.`);
+    console.log(`✅ CLI contract initialized successfully at ${(0, storage_1.getContractDisplayPath)()}.`);
 });
 program
     .command("check")
     .description("Compare the current CLI surface against the committed contract")
     .argument("<entry>", "path to the target CLI's entry file")
     .option(...adapterOption)
+    .option("--json", "print a machine-readable JSON result instead of text", false)
     .action(async (entry, options) => {
     const oldContract = (0, storage_1.readContract)();
     const newContract = await resolveAdapter(options.adapter).extract(entry);
     const diff = diffEngine.compare(oldContract, newContract);
+    const hasBreaking = diff.some((entry) => entry.type === types_1.ChangeType.BREAKING);
+    if (options.json) {
+        console.log(JSON.stringify(toJsonResult(diff), null, 2));
+        process.exit(hasBreaking ? 1 : 0);
+    }
     if (diff.length === 0) {
-        console.log("✅ El contrato de la CLI está intacto.");
+        console.log("✅ CLI contract is intact.");
         process.exit(0);
     }
     printDiff(diff);
-    const hasBreaking = diff.some((entry) => entry.type === types_1.ChangeType.BREAKING);
     process.exit(hasBreaking ? 1 : 0);
 });
 program
@@ -74,8 +79,23 @@ program
     .action(async (entry, options) => {
     const contract = await resolveAdapter(options.adapter).extract(entry);
     (0, storage_1.writeContract)(contract);
-    console.log("🔄 Contrato de CLI actualizado con éxito.");
+    console.log("🔄 CLI contract updated successfully.");
 });
+function toJsonResult(diff) {
+    const summary = {
+        breaking: diff.filter((entry) => entry.type === types_1.ChangeType.BREAKING).length,
+        additive: diff.filter((entry) => entry.type === types_1.ChangeType.ADDITIVE).length,
+        patch: diff.filter((entry) => entry.type === types_1.ChangeType.PATCH).length,
+    };
+    const suggestedBump = summary.breaking > 0
+        ? "major"
+        : summary.additive > 0
+            ? "minor"
+            : summary.patch > 0
+                ? "patch"
+                : null;
+    return { ok: summary.breaking === 0, changes: diff, summary, suggestedBump };
+}
 function printDiff(diff) {
     for (const entry of diff) {
         console.log(`${emojiFor(entry.type)} [${entry.path}] ${entry.message}`);

package/package.json

@@ -1,8 +1,14 @@
 {
   "name": "cliguard",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Snapshot-tests your CLI's contract (commands, flags, defaults) so you never ship a breaking change by accident.",
-  "keywords": ["cli", "contract-testing", "snapshot-testing", "commander", "ci"],
+  "keywords": [
+    "cli",
+    "contract-testing",
+    "snapshot-testing",
+    "commander",
+    "ci"
+  ],
   "author": "Bryandero98",
   "license": "MIT",
   "homepage": "https://github.com/Bryandero98/cliguard",
@@ -13,10 +19,13 @@
   "bugs": {
     "url": "https://github.com/Bryandero98/cliguard/issues"
   },
+  "funding": "https://ko-fi.com/bryandero98",
   "bin": {
     "cliguard": "dist/bin.js"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "lint": "eslint src --ext .ts",