Remove the stack trace when the nuclei-ignore file does not exist

[nu11zy]

Proposed changes

Removed the stack trace when the .nuclei-ignore file didn't exist.

Before:

[ERR] Could not read nuclei-ignore file: open /Users/x/Library/Application Support/nuclei/.nuclei-ignore: no such file or directory
goroutine 1 [running]:
runtime/debug.Stack()
        /opt/homebrew/Cellar/go/1.25.0/libexec/src/runtime/debug/stack.go:26 +0x64
github.com/projectdiscovery/nuclei/v3/pkg/catalog/config.ReadIgnoreFile()
        /Users/x/_dev/nuclei/pkg/catalog/config/ignorefile.go:21 +0x90
github.com/projectdiscovery/nuclei/v3/internal/runner.(*Runner).RunEnumeration(0x14000b9b200)
        /Users/x/_dev/nuclei/internal/runner/runner.go:544 +0x2d4
main.main()
        /Users/x/_dev/nuclei/cmd/nuclei/main.go:223 +0x964
...

After:

[ERR] Could not read nuclei-ignore file: open /Users/x/Library/Application Support/nuclei/.nuclei-ignore: no such file or directory
...

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

• Bug Fixes
  • Missing ignore file is now handled gracefully: the system logs a concise error message (no stack trace) and continues with default behavior.
  • Reduces log noise and improves clarity when the file is absent; overall functionality and error-handling flow remain unchanged.

[coderabbitai]

Walkthrough

Removed the use of runtime/debug and stopped including a stack trace when ReadIgnoreFile logs errors; on read failures the function now logs only the error message and continues to return an empty IgnoreFile. No other control flow or exported APIs changed.

Changes

Cohort / File(s)	Summary
Ignore file logging pkg/catalog/config/ignorefile.go	Removed runtime/debug import and eliminated stack-trace output from ReadIgnoreFile error logging; error path now logs only the error message and returns an empty IgnoreFile. No other logic or exported declarations changed.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Caller
  participant CFG as ReadIgnoreFile
  participant OS as os.Open
  participant Log as logger

  Caller->>CFG: ReadIgnoreFile(path)
  CFG->>OS: Open(path)
  OS-->>CFG: file handle or error

  alt Success
    CFG-->>Caller: parsed IgnoreFile
  else Error reading file
    CFG->>Log: log error message (no stack trace)
    CFG-->>Caller: return empty IgnoreFile
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly and accurately summarizes the primary change in the PR: it communicates that stack traces are no longer printed when the ignore file is absent, which aligns with the modifications to ReadIgnoreFile and the logging behavior in the changeset. It is a single clear sentence focused on the main user-visible behavior.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

Poem

I nosed the path and found a sigh,
No laddered lines to pry the why.
Just a quiet log, no tangled trace—
I hop along with tidy grace. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 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 0318123 and 606acc4.

📒 Files selected for processing (1)

• pkg/catalog/config/ignorefile.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• pkg/catalog/config/ignorefile.go

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

pkg/catalog/config/ignorefile.go (3)

22-22: Downgrade log level for expected “file missing” case.

Missing .nuclei-ignore is a normal condition; consider logging at Info/Warning instead of Error to reduce noise.

Apply:

-            gologger.Error().Msgf("Could not read nuclei-ignore file: %s\n", err)
+            gologger.Info().Msgf("nuclei-ignore file not found: %v", err)

---

33-35: Treat empty file (EOF) as valid instead of an error.

If the ignore file exists but is empty, yaml.Decoder returns io.EOF; that shouldn’t be logged as an error.

Apply:

-    if err := yaml.NewDecoder(file).Decode(&ignore); err != nil {
-        gologger.Error().Msgf("Could not parse nuclei-ignore file: %s\n", err)
-        return IgnoreFile{}
-    }
+    dec := yaml.NewDecoder(file)
+    if err := dec.Decode(&ignore); err != nil {
+        // Allow empty file without logging an error
+        if errors.Is(err, io.EOF) {
+            return ignore
+        }
+        gologger.Error().Msgf("Could not parse nuclei-ignore file: %v", err)
+        return IgnoreFile{}
+    }

Add imports:

import (
    "io"
    "errors"
)

---

22-22: Remove explicit “\n” in Msgf calls.

gologger handles line endings; embedded newlines lead to extra blank lines in some outputs. Consider dropping them for consistency.

Apply:

-            gologger.Error().Msgf("Could not read nuclei-ignore file: %s\n", err)
+            gologger.Error().Msgf("Could not read nuclei-ignore file: %v", err)

-        gologger.Error().Msgf("Could not read nuclei-ignore file: %s\n%s\n", err, string(debug.Stack()))
+        gologger.Error().Msgf("Could not read nuclei-ignore file: %v\n%s", err, string(debug.Stack()))

Also applies to: 25-25

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 32dfeac and 0318123.

📒 Files selected for processing (1)

• pkg/catalog/config/ignorefile.go (1 hunks)

🔇 Additional comments (1)

pkg/catalog/config/ignorefile.go (1)

21-24: Targeted handling for os.IsNotExist looks good.

This cleanly removes the noisy stack trace for the common “file missing” case and still returns an empty IgnoreFile as before. Meets the PR objective.