Skip to content

feat: support json output#1510

Merged
HerringtonDarkholme merged 1 commit intomainfrom
tracing
Oct 6, 2024
Merged

feat: support json output#1510
HerringtonDarkholme merged 1 commit intomainfrom
tracing

Conversation

@HerringtonDarkholme
Copy link
Copy Markdown
Member

@HerringtonDarkholme HerringtonDarkholme commented Oct 6, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Enhanced statistics reporting with flexible output options (JSON or formatted string).
    • Introduced new structs for tracking file and rule statistics.

  • Bug Fixes

    • Improved handling of output formatting based on user-defined configurations.

  • Documentation

    • Updated test cases to reflect changes in the statistics reporting methods.

@HerringtonDarkholme HerringtonDarkholme added this pull request to the merge queue Oct 6, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 6, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the RunWithInferredLang, RunWithSpecificLang, ScanWithConfig, and ScanWithRule structs, specifically updating their consume_items methods to include a conditional parameter for printing statistics based on JSON output. Additionally, it enhances the SummaryStats struct in tracing.rs by introducing new FileStats and RuleStats structs, which improve statistics tracking and output formatting options. The changes primarily focus on adjusting how statistics are printed and enhancing the overall output functionality.

Changes

File Path Change Summary
crates/cli/src/run.rs Updated consume_items methods in RunWithInferredLang and RunWithSpecificLang to include a boolean for JSON output in the print method call on stats.
crates/cli/src/scan.rs Modified consume_items methods in ScanWithConfig and ScanWithRule to add a JSON output parameter to the print method. Updated run_with_config for clearer printer selection based on output format.
crates/cli/src/utils/tracing.rs Introduced FileStats and RuleStats structs. Updated SummaryStats to include file_stats and modified print methods to accept a boolean for JSON output.

Possibly related PRs

  • feat: add tracing to cli argument #1509: The changes in this PR modify the RunWithInferredLang and RunWithSpecificLang structs in run.rs, specifically updating the consume_items method to include enhanced statistics tracking, which aligns with the modifications made in the main PR regarding the print method on the stats object.

Poem

🐇 In the meadow where the stats do play,
A new print emerges, brightening the day.
With JSON whispers, the data flows,
Each number dances, as the output glows.
So hop along, dear friends, rejoice,
For clearer stats give us a voice! 🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Merged via the queue into main with commit 7e5ba88 Oct 6, 2024
@HerringtonDarkholme HerringtonDarkholme deleted the tracing branch October 6, 2024 04:46
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.60%. Comparing base (119816e) to head (3d309a7).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1510      +/-   ##
==========================================
+ Coverage   72.59%   72.60%   +0.01%     
==========================================
  Files          87       87              
  Lines        5947     5951       +4     
==========================================
+ Hits         4317     4321       +4     
  Misses       1630     1630

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

This was referenced Oct 21, 2024
Merged
Merged
This was referenced Nov 4, 2024
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@HerringtonDarkholme