WIP: Add tracing instrumentation to diffguard-domain and diffguard-diff

[EffortlessSteven]

Closes #566

Summary

Add structured tracing instrumentation to and crates using . Library consumers (including ) will now have visibility into internal operations like rule compilation, language detection, rule evaluation, override resolution, and diff parsing.

ADR

• ADR: Included in commit (docs(adr): add tracing instrumentation ADR and specs)

Specs

• Specs: Included in commit (tracing instrumentation specification)

What Changed

Cargo.toml changes

• (workspace): Added to workspace dependencies
• : Added
• : Added

Source files modified

• : Added tracing calls to :
  • at entry
  • when binary file detected
  • when submodule detected
  • when deleted file skipped
  • when mode-only change detected
  • when hunk header parsed
  • if hunk header parse fails
  • at exit

Test Results (so far)

• cargo fmt: clean
• cargo clippy -p diffguard-domain -p diffguard-diff: clean
• cargo test -p diffguard-domain -p diffguard-diff: tests passing

Friction Encountered

• Filesystem view inconsistency between tools during build phase
• Spurious empty files with colon-separated names found during verification

Notes

• Draft PR — not ready for review until GREEN tests confirmed
• Only instrumentation was successfully committed; domain crate instrumentation requires follow-up

[gemini-code-assist]

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

[coderabbitai]

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 2 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 8 minutes and 2 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: dabcd987-debb-4feb-8634-10e8c2af6daf

📥 Commits

Reviewing files that changed from the base of the PR and between e3e741c and 0c49127.

📒 Files selected for processing (6)

• Cargo.toml
• StringSyntax::CStyle
• StringSyntax::CStyle,
• crates/diffguard-diff/Cargo.toml
• crates/diffguard-diff/src/unified.rs
• crates/diffguard-domain/Cargo.toml

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/work-8df09c1b/diffguard-domain-and-diffguard-diff-are-

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[EffortlessSteven]

Doc Writer Update

Documentation work completed for this PR:

Files Documented

diffguard-domain/src/evaluate.rs

• Added docstrings to , , structs with field-level documentation
• Documented , , and

diffguard-domain/src/rules.rs

• Documented struct with comprehensive field-level documentation
• Added docstring to method explaining include/exclude/language filtering
• Enhanced with argument/return documentation and usage examples

diffguard-domain/src/preprocess.rs

• Documented builder methods (, , , )
• Added comprehensive docstrings to , , ,
• Explained stateful multi-line comment/string tracking behavior

diffguard-diff/src/unified.rs

• Added docstring to explaining git's quoted path escape sequences
• Documented explaining git's output format handling

Test Results

All tests pass (42 domain + 62 diff tests), plus 2 new doc-tests passing.

Commit

• docs: add comprehensive docstrings to diffguard-domain and diffguard-diff