Add outputing for queries

[neilnaveen]

• This allows us to integrate minefield with the scorecard collector
• This output, which is a newline seperated list of node names can be used by the scorecard collector to create scorecard data

Summary by CodeRabbit

• New Features

  • Introduced a --save-query command-line flag across various packages, allowing users to specify a file path for saving query results.
  • Added functionality to create and write to a file with the names of nodes processed during queries.

• Bug Fixes

  • Enhanced error handling for file creation to ensure any issues are reported to users.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new field saveQuery in the options struct across multiple packages, allowing users to specify a file path for saving query results. The AddFlags method is updated to include a --save-query command-line flag for this purpose. In the Run method, logic is added to create a file if the saveQuery field is not empty, enabling the writing of processed node names to the specified file. Error handling for file operations is also enhanced, ensuring that any issues are reported without affecting existing functionalities.

Changes

File Path	Change Summary
cmd/leaderboard/allKeys/keys.go	Added saveQuery string to options, updated AddFlags with --save-query, and modified Run for file handling.
cmd/leaderboard/custom/custom.go	Added saveQuery string to options, updated AddFlags with --save-query, and modified Run for file handling.
cmd/query/custom/custom.go	Added saveQuery string to options, updated AddFlags with --save-query, and modified Run for file handling.
cmd/query/globsearch/globsearch.go	Added saveQuery string to options, updated AddFlags with --save-query, and modified Run for file handling.

Possibly related PRs

• Add functionality to inspect nodes #104: The changes in this PR involve the addition of a saveQuery field and related file handling in the cmd/query/custom/custom.go file, which is directly related to the similar changes made in the cmd/leaderboard/allKeys/keys.go file of the main PR. Both PRs introduce functionality for saving query results to a file using a command-line flag.

Suggested reviewers

• naveensrinivasan

Poem

In the forest where queries play,
A rabbit found a new way,
With saveQuery in the mix,
Results saved, a clever fix!
Hop and write, the nodes align,
In files they dance, oh how they shine! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.