Skip to content

feat: add EnableMatcherStatus function to configure matcher status in… #6191

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

egru
Copy link

@egru egru commented Apr 23, 2025

Proposed changes

added matcherstatus flag for NucleiSDKOptions

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • New Features
    • Introduced an option to enable matcher status in the SDK configuration.

@auto-assign auto-assign bot requested a review from dwisiswant0 April 23, 2025 20:21
Copy link
Contributor

coderabbitai bot commented Apr 23, 2025

Walkthrough

A new function, EnableMatcherStatus, has been introduced in the codebase. This function provides a configuration option for the NucleiEngine by setting its internal MatcherStatus flag to true. The function follows a closure pattern, returning a function that modifies the engine's options without error handling or additional logic.

Changes

File(s) Change Summary
lib/config.go Added the EnableMatcherStatus function to provide a configuration option for NucleiEngine.

Poem

A tweak in the code, a hop in the grass,
MatcherStatus enabled—now nothing will pass!
With closures and options, the engine’s in tune,
Rabbits rejoice, for new features bloom soon.
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

Copy link
Contributor

@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

🧹 Nitpick comments (1)
lib/config.go (1)

466-473: Add documentation and unit tests for the new option
The EnableMatcherStatus function correctly follows the existing SDK option pattern, but we currently lack any tests or user‐facing documentation for this new flag. Consider:

  1. Adding a unit test (e.g. in sdk_config_test.go) to assert that e.opts.MatcherStatus is set to true.
  2. Updating CLI docs or README.md to document the matcher-status flag and its behavior.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24311cc and bd53c14.

📒 Files selected for processing (1)
  • lib/config.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
lib/config.go (1)
lib/sdk.go (2)
  • NucleiSDKOptions (33-33)
  • NucleiEngine (55-88)

@GeorginaReeder
Copy link

Thanks for your contribution @egru :)

As a token of appreciation for your valuable contribution, you can grab some cool PD Stickers from here http://nux.gg/stickers.

We also have a Discord server, which you’re more than welcome to join. It's a great place to connect with fellow contributors and stay updated with the latest developments!

@egru
Copy link
Author

egru commented Apr 24, 2025

I can't pass up stickers!

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