PR #7: Command Cleanup & Documentation

[shivasurya]

Summary

Final PR in the output standardization stack. Removes deprecated query and analyze commands and adds comprehensive documentation for all output formats, verbosity levels, and exit codes.

Changes

Deprecated Commands Removed

• cmd/query.go - Removed entirely
• cmd/query_test.go - Removed entirely
• cmd/analyze.go - Removed entirely
• main_test.go - Updated to remove references to deprecated commands

BREAKING CHANGE: No backward compatibility provided per requirements.

Documentation Updates

README.md

• Usage Examples: Scan and CI command examples
• Output Formats: Text, JSON, CSV, SARIF examples with real output
• Verbosity Levels: Table showing default/verbose/debug behavior
• Exit Codes: Table and examples for exit code 0, 1, 2

docs/CLI.md (New)

• Command Reference: Complete flag documentation for all commands
• Output Format Reference: JSON schema, CSV columns, SARIF features
• Exit Code Reference: Detailed exit code behavior and --fail-on syntax

Verification Tests

• cmd/command_cleanup_test.go: Integration tests verifying:
  • query command returns "unknown command"
  • analyze command returns "unknown command"
  • Help text no longer mentions removed commands

Test Results

All tests passing ✅

$ gradle testGo
ok  	.../cmd	0.343s

$ ./build/go/pathfinder query
Error: unknown command "query" for "pathfinder"

$ ./build/go/pathfinder analyze
Error: unknown command "analyze" for "pathfinder"

$ ./build/go/pathfinder --help | grep -E "(query|analyze)"
# (no output - commands not shown)

Documentation Examples

Scan Command

pathfinder scan --rules rules/ --project /path/to/project
pathfinder scan --rules rules/ --project . --verbose
pathfinder scan --rules rules/ --project . --fail-on=critical,high

CI Command

pathfinder ci --rules rules/ --project . --output json > results.json
pathfinder ci --rules rules/ --project . --output sarif > results.sarif
pathfinder ci --rules rules/ --project . --output csv --fail-on=critical

Exit Code Behavior

# Default: always exit 0
pathfinder scan --rules rules/ --project .
echo $?  # 0 even with findings

# Fail on critical or high
pathfinder scan --rules rules/ --project . --fail-on=critical,high
echo $?  # 1 if critical/high found, 0 otherwise

Migration Notes

Breaking Changes

• query command removed: Use scan command instead
• analyze command removed: Use scan or ci command instead
• No migration path provided per requirements

Non-Breaking

• All existing scan and ci commands continue to work
• Documentation is backwards compatible

Checklist

• query command removed
• analyze command removed
• main_test.go updated
• Verification tests added
• README.md updated with comprehensive docs
• docs/CLI.md created
• All tests passing
• Linter passing
• Binary builds successfully
• Help text verified

Stacked PRs

This PR stacks on top of:

• PR Update build.yml #6: Exit Code Standardization (PR #6: Exit Code Standardization & --fail-on Flag #396)

This is the final PR in the output standardization feature stack.

Verification

Commands removed successfully:

$ ./build/go/pathfinder query
Error: unknown command "query" for "pathfinder"

$ ./build/go/pathfinder analyze
Error: unknown command "analyze" for "pathfinder"

Valid commands work:

$ ./build/go/pathfinder scan --help
# Shows scan command help

$ ./build/go/pathfinder ci --help
# Shows ci command help

🤖 Generated with Claude Code

[safedep]

SafeDep Report Summary

No dependency changes detected. Nothing to scan.

_{This report is generated by SafeDep Github App}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.70%. Comparing base (0e246ee) to head (4d2c8ec).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #397      +/-   ##
==========================================
+ Coverage   79.76%   80.70%   +0.94%     
==========================================
  Files          79       77       -2     
  Lines        7846     7736     -110     
==========================================
- Hits         6258     6243      -15     
+ Misses       1343     1248      -95     
  Partials      245      245              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[shivasurya]

• PR #7: Command Cleanup & Documentation #397 👈 (View in Graphite)
• PR #6: Exit Code Standardization & --fail-on Flag #396
• PR #5: Enhanced SARIF Formatter with Code Flows #395
• PR #4: Add JSON and CSV Output Formatters for CI Mode #394
• PR #3: Text Formatter for Scan Command #393
• PR #2: Structured Logging System #392
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[shivasurya]

Merge activity

• Nov 22, 12:38 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Nov 22, 12:47 AM UTC: Graphite rebased this pull request as part of a merge.
• Nov 22, 12:48 AM UTC: @shivasurya merged this pull request with Graphite.