cbpr-usage-rules 0.1.3__tar.gz → 0.2.0__tar.gz

{cbpr_usage_rules-0.1.3 → cbpr_usage_rules-0.2.0}/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0]
+
+### Added
+- `--format {text,compact,json}` CLI option. The new `compact` format prints one
+  finding per line, compiler/linter-style (`file:line: severity [rule] message | at
+  xpath`) with a stable `VALID:`/`INVALID:` summary line — easy for tools and coding
+  agents to parse. `--json` is now an alias for `--format json`; the default rich
+  text output is unchanged.
+
 ## [0.1.3]
 
 ### Changed

{cbpr_usage_rules-0.1.3/src/cbpr_usage_rules.egg-info → cbpr_usage_rules-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cbpr-usage-rules
-Version: 0.1.3
+Version: 0.2.0
 Summary: Validate ISO 20022 CBPR+ XML messages against SWIFT usage (business) rules.
 Author: Pete Houghton
 License: MIT License
@@ -112,8 +112,11 @@ result = cbpr_rules.validate_string(xml_text, year=2026)
 # Human-readable (default). Exit code is non-zero if there are violations.
 cbpr-validate payment.xml --year 2025
 
-# JSON output
-cbpr-validate payment.xml --year 2025 --json
+# Compact, one finding per line (compiler-style) — for tools and coding agents
+cbpr-validate payment.xml --year 2025 --format compact
+
+# JSON output (full machine-readable result)
+cbpr-validate payment.xml --year 2025 --json   # same as --format json
 
 # Read from stdin
 cat payment.xml | cbpr-validate --year 2026
@@ -127,6 +130,20 @@ cbpr-validate payment.xml --year 2025 --xsd pacs.008.001.08.xsd
 
 Each reported violation shows the rule, **why** this instance failed (`Problem:`),
 the **offending XML** from your file (`Found:`), and its line + xpath (`At:`).
+
+**For tools and coding agents**, prefer `--format compact` (one finding per line,
+parseable like a compiler/linter) or `--json` (the full structured result):
+
+```text
+$ cbpr-validate payment.xml --year 2025 --format compact
+payment.xml:7: violation [pacs.008:R2] From vs Instructing Agent: ABCDGB2LXXX != GGGGGB2LXXX | at /AppHdr/Fr/FIId/FinInstnId/BICFI
+payment.xml:63: violation [pacs.008:VAL-IBAN] invalid IBAN: 'GB29NWBK60161331926818' | at /Document/.../DbtrAcct/Id/IBAN
+INVALID: 5 violations (87 rules)
+```
+
+Each line is `file:line: severity [rule] message | at xpath`, and the final
+`VALID:` / `INVALID:` line is a stable summary to grep for. With `--xsd`, schema
+errors appear as `schema-error` lines and are counted in the summary.
 Advisory rules are summarised as a count by default; pass `--advisory` to list them.
 
 ---

{cbpr_usage_rules-0.1.3 → cbpr_usage_rules-0.2.0}/README.md

@@ -57,8 +57,11 @@ result = cbpr_rules.validate_string(xml_text, year=2026)
 # Human-readable (default). Exit code is non-zero if there are violations.
 cbpr-validate payment.xml --year 2025
 
-# JSON output
-cbpr-validate payment.xml --year 2025 --json
+# Compact, one finding per line (compiler-style) — for tools and coding agents
+cbpr-validate payment.xml --year 2025 --format compact
+
+# JSON output (full machine-readable result)
+cbpr-validate payment.xml --year 2025 --json   # same as --format json
 
 # Read from stdin
 cat payment.xml | cbpr-validate --year 2026
@@ -72,6 +75,20 @@ cbpr-validate payment.xml --year 2025 --xsd pacs.008.001.08.xsd
 
 Each reported violation shows the rule, **why** this instance failed (`Problem:`),
 the **offending XML** from your file (`Found:`), and its line + xpath (`At:`).
+
+**For tools and coding agents**, prefer `--format compact` (one finding per line,
+parseable like a compiler/linter) or `--json` (the full structured result):
+
+```text
+$ cbpr-validate payment.xml --year 2025 --format compact
+payment.xml:7: violation [pacs.008:R2] From vs Instructing Agent: ABCDGB2LXXX != GGGGGB2LXXX | at /AppHdr/Fr/FIId/FinInstnId/BICFI
+payment.xml:63: violation [pacs.008:VAL-IBAN] invalid IBAN: 'GB29NWBK60161331926818' | at /Document/.../DbtrAcct/Id/IBAN
+INVALID: 5 violations (87 rules)
+```
+
+Each line is `file:line: severity [rule] message | at xpath`, and the final
+`VALID:` / `INVALID:` line is a stable summary to grep for. With `--xsd`, schema
+errors appear as `schema-error` lines and are counted in the summary.
 Advisory rules are summarised as a count by default; pass `--advisory` to list them.
 
 ---

{cbpr_usage_rules-0.1.3 → cbpr_usage_rules-0.2.0}/src/cbpr_rules/__init__.py

@@ -4,7 +4,7 @@ This package is AI generated. See the README for details and caveats.
 """
 from __future__ import annotations
 
-__version__ = "0.1.3"
+__version__ = "0.2.0"
 
 from .models import Rule, Severity, Violation
 from .engine import validate_file, validate_string, list_rules, available

{cbpr_usage_rules-0.1.3 → cbpr_usage_rules-0.2.0}/src/cbpr_rules/cli.py

@@ -26,7 +26,18 @@ def _build_parser() -> argparse.ArgumentParser:
         help="Message type override, e.g. pacs.008 or pacs.008_stp "
         "(auto-detected from the Document namespace if omitted).",
     )
-    p.add_argument("--json", action="store_true", help="Emit JSON instead of text.")
+    p.add_argument(
+        "--format",
+        choices=("text", "compact", "json"),
+        default="text",
+        help="Output format: text (rich, default), compact (one finding per line, "
+        "compiler-style — for tools/agents), or json (full machine-readable).",
+    )
+    p.add_argument(
+        "--json",
+        action="store_true",
+        help="Alias for --format json.",
+    )
     p.add_argument(
         "--xsd",
         action="append",
@@ -125,6 +136,43 @@ def _format_text(result: dict, show_advisory: bool = False) -> str:
     return "\n".join(lines)
 
 
+def _format_compact(result: dict, source: str) -> str:
+    """One finding per line, compiler/linter-style, for tools and coding agents.
+
+    ``<source>:<line>: <severity> [<rule>] <message> | at <xpath>`` per violation,
+    followed by a single greppable ``VALID:``/``INVALID:`` summary line. Advisory
+    (non-enforced) rules are omitted; use --json or text --advisory for those.
+    """
+    lines: List[str] = []
+    for v in result["violations"]:
+        line = v["line"] if v["line"] is not None else "?"
+        message = " ".join((v.get("detail") or v["description"] or "").split())
+        suffix = f" | at {v['xpath']}" if v.get("xpath") else ""
+        lines.append(f"{source}:{line}: {v['severity']} [{v['rule_number']}] {message}{suffix}")
+
+    xsd = result.get("xsd")
+    schema_errors = 0
+    if xsd is not None:
+        for s in xsd["schemas"]:
+            if s.get("load_error"):
+                schema_errors += 1
+                lines.append(f"{s['file']}: schema-error could not load schema: {s['load_error']}")
+            for e in s["errors"]:
+                schema_errors += 1
+                eline = e["line"] if e.get("line") is not None else "?"
+                msg = " ".join((e.get("message") or "").split())
+                lines.append(f"{s['file']}:{eline}: schema-error {msg}")
+
+    n = len(result["violations"])
+    verdict = "VALID" if result["valid"] else "INVALID"
+    parts = [f"{n} violation{'s' if n != 1 else ''}"]
+    if xsd is not None:
+        parts.append(f"{schema_errors} schema error{'s' if schema_errors != 1 else ''}")
+    summary = f"{verdict}: {', '.join(parts)} ({result['rules_evaluated']} rules)"
+    lines.append(summary)
+    return "\n".join(lines)
+
+
 def main(argv: Optional[List[str]] = None) -> int:
     args = _build_parser().parse_args(argv)
 
@@ -153,6 +201,7 @@ def main(argv: Optional[List[str]] = None) -> int:
         print("error: --year is required to validate", file=sys.stderr)
         return 2
 
+    source = args.file or "<stdin>"
     try:
         if args.file:
             result = validate_file(args.file, args.year, args.msgtype, xsd=args.xsd)
@@ -163,8 +212,11 @@ def main(argv: Optional[List[str]] = None) -> int:
         print(f"error: {exc}", file=sys.stderr)
         return 2
 
-    if args.json:
+    fmt = "json" if args.json else args.format
+    if fmt == "json":
         print(json.dumps(result, indent=2))
+    elif fmt == "compact":
+        print(_format_compact(result, source))
     else:
         print(_format_text(result, show_advisory=args.advisory))
 

{cbpr_usage_rules-0.1.3 → cbpr_usage_rules-0.2.0/src/cbpr_usage_rules.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cbpr-usage-rules
-Version: 0.1.3
+Version: 0.2.0
 Summary: Validate ISO 20022 CBPR+ XML messages against SWIFT usage (business) rules.
 Author: Pete Houghton
 License: MIT License
@@ -112,8 +112,11 @@ result = cbpr_rules.validate_string(xml_text, year=2026)
 # Human-readable (default). Exit code is non-zero if there are violations.
 cbpr-validate payment.xml --year 2025
 
-# JSON output
-cbpr-validate payment.xml --year 2025 --json
+# Compact, one finding per line (compiler-style) — for tools and coding agents
+cbpr-validate payment.xml --year 2025 --format compact
+
+# JSON output (full machine-readable result)
+cbpr-validate payment.xml --year 2025 --json   # same as --format json
 
 # Read from stdin
 cat payment.xml | cbpr-validate --year 2026
@@ -127,6 +130,20 @@ cbpr-validate payment.xml --year 2025 --xsd pacs.008.001.08.xsd
 
 Each reported violation shows the rule, **why** this instance failed (`Problem:`),
 the **offending XML** from your file (`Found:`), and its line + xpath (`At:`).
+
+**For tools and coding agents**, prefer `--format compact` (one finding per line,
+parseable like a compiler/linter) or `--json` (the full structured result):
+
+```text
+$ cbpr-validate payment.xml --year 2025 --format compact
+payment.xml:7: violation [pacs.008:R2] From vs Instructing Agent: ABCDGB2LXXX != GGGGGB2LXXX | at /AppHdr/Fr/FIId/FinInstnId/BICFI
+payment.xml:63: violation [pacs.008:VAL-IBAN] invalid IBAN: 'GB29NWBK60161331926818' | at /Document/.../DbtrAcct/Id/IBAN
+INVALID: 5 violations (87 rules)
+```
+
+Each line is `file:line: severity [rule] message | at xpath`, and the final
+`VALID:` / `INVALID:` line is a stable summary to grep for. With `--xsd`, schema
+errors appear as `schema-error` lines and are counted in the summary.
 Advisory rules are summarised as a count by default; pass `--advisory` to list them.
 
 ---