httpx icon indicating copy to clipboard operation
httpx copied to clipboard

Added struct tags to Runner Options

Open l0nedigit opened this issue 8 months ago • 3 comments

To help converting between PD defined structs and personal project structures via pkg use, I added some struct tags to the runner Options struct for json & yaml.

Summary by CodeRabbit

  • Refactor
    • Improved data handling by enhancing compatibility with JSON and YAML formats. No changes to functionality or user experience.

l0nedigit avatar May 08 '25 15:05 l0nedigit

Walkthrough

The changes add JSON and YAML struct tags to all fields within the ScanOptions and Options structs in runner/options.go. These tags standardize field names for serialization and deserialization, using snake_case and the omitempty directive. No logic, structure, or functionality is altered.

Changes

File(s) Change Summary
runner/options.go Added JSON and YAML struct tags to all fields of ScanOptions and Options structs. No logic or structural changes.

Poem

A hop and a skip through the fields of code,
Now options wear tags in a neat, tidy mode.
With snake_case and omitempty, they serialize with grace,
JSON and YAML both find their place.
The structs stay the same, just dressed up anew—
A rabbit’s delight in a job well due! 🐇

[!TIP]

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 303d408e1657fc67277f83d4e41abc6e3dec793a and b1e4f622a792ba2f5fc2f37481524f9354f5ae0a.

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

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar May 08 '25 15:05 coderabbitai[bot]

Will double-check coder rabbit's responses at some point today....

l0nedigit avatar May 08 '25 16:05 l0nedigit

Thanks for your contribution @l0nedigit ! :)

GeorginaReeder avatar May 09 '25 10:05 GeorginaReeder

Thanks for the PR. Just curious, why do you need this change?

dogancanbakir avatar Jul 12 '25 05:07 dogancanbakir

When using httpx as a pkg, unmarshaling and marshaling objects into JSON/different struct types is much simpler when there are struct tags.

On Sat, Jul 12, 2025, 1:18 AM Dogan Can Bakir @.***> wrote:

dogancanbakir left a comment (projectdiscovery/httpx#2172) https://github.com/projectdiscovery/httpx/pull/2172#issuecomment-3064694921

Thanks for the PR. Just curious, why do you need this change?

— Reply to this email directly, view it on GitHub https://github.com/projectdiscovery/httpx/pull/2172#issuecomment-3064694921, or unsubscribe https://github.com/notifications/unsubscribe-auth/AF5GAE5NO4AWDCIAG2IUVK33ICLCVAVCNFSM6AAAAAB4W3LGG6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTANRUGY4TIOJSGE . You are receiving this because you were mentioned.Message ID: @.***>

l0nedigit avatar Jul 12 '25 13:07 l0nedigit

@l0nedigit Thanks a lot for your contribution! The clone function approach seems well-structured, efficient, and seems like a good fit for your needs with personal projects as well. I'm closing the PR as the proposed solution seems to cover external projects needs.

Mzack9999 avatar Sep 12 '25 13:09 Mzack9999