Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print tag mask (as integer) with colourlists command #17

Merged

Conversation

zluudg
Copy link
Contributor

@zluudg zluudg commented Dec 5, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced output format for the ColourlistsCmd command, now displaying an additional "Flags" column for improved information clarity.
  • Bug Fixes
    • Adjusted separator line to align with the new output format.

@zluudg zluudg requested a review from a team as a code owner December 5, 2024 08:48
Copy link

coderabbitai bot commented Dec 5, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package : could not load export data: no export data for "github.com/google/uuid""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package : could not load export data: no export data for "github.com/google/uuid""

Walkthrough

The changes in this pull request modify the ColourlistsCmd command within the cmd/colourlists.go file. The output format for the command is updated to include an additional column labeled "Flags," increasing the number of printed columns from four to five. This involves changes to the format string and the separator line. The processing of the "whitelist," "blacklist," and "greylist" entries is also adjusted to populate the new column appropriately.

Changes

File Change Summary
cmd/colourlists.go Updated output format string to include a new "Flags" column, modifying the separator line and adjusting fmt.Printf calls for "whitelist," "blacklist," and "greylist" processing.

Possibly related issues

🐰 In the land of code where rabbits play,
A new flag appears to brighten the day.
Five columns now dance in a row,
With masks and lists, watch the data flow!
Hopping through changes, we cheer with delight,
For every new feature makes coding feel right! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b75fc3f and e47bcd5.

📒 Files selected for processing (1)
  • cmd/colourlists.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cmd/colourlists.go

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
cmd/colourlists.go (1)

23-27: Consider optimizing column widths for better terminal compatibility

The current format uses 75 characters for the domain column, which may cause unnecessary line wrapping in standard terminals (typically 80-120 chars wide). Consider reducing column widths while maintaining readability.

-fmtstring := "%-75s|%-20s|%-20s|%-10s|%-10s\n"
+fmtstring := "%-45s|%-15s|%-15s|%-10s|%-10s\n"

 fmt.Printf(fmtstring, "Domain", "Source", "Src Fmt", "Colour", "Flags")
-fmt.Println(strings.Repeat("-", 135))
+fmt.Println(strings.Repeat("-", 95))
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 53d7be2 and b75fc3f.

📒 Files selected for processing (1)
  • cmd/colourlists.go (2 hunks)
🔇 Additional comments (2)
cmd/colourlists.go (2)

5-5: LGTM!

The addition of the strconv import is appropriate for converting the TagMask integer to string.


31-31: Document TagMask values and verify usage

While the implementation correctly displays the TagMask for greylist entries, it would be helpful to:

  1. Add comments documenting possible TagMask values and their meanings
  2. Consider formatting the TagMask in a more user-friendly way (e.g., binary format or named flags)

Let's check how TagMask is used elsewhere in the codebase:

Consider enhancing the output by:

  1. Adding a legend explaining the TagMask bits
  2. Using binary format (%b) or converting to named flags for better readability

Also applies to: 36-36, 41-41

cmd/colourlists.go Outdated Show resolved Hide resolved
@eest eest merged commit eae16d4 into dnstapir:main Dec 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants