Skip to content

SimpleLayout - Implicit operator with NotNullIfNotNull #5982

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.

Sign up for GitHub

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

Jump to bottom
Merged
snakefoot merged 1 commit into from
Aug 31, 2025
Merged

SimpleLayout - Implicit operator with NotNullIfNotNull #5982

snakefoot merged 1 commit into from
Aug 31, 2025

Conversation

@snakefoot
Copy link
Contributor

@snakefoot snakefoot commented Aug 31, 2025 •
edited
Loading

Similar to #5977

@coderabbitai
Copy link

coderabbitai bot commented Aug 31, 2025 •
edited
Loading

Walkthrough

Adds a conditional NotNullIfNotNull return-value attribute to the implicit string-to-SimpleLayout? operator in SimpleLayout. The attribute is compiled only for NETSTANDARD2_1_OR_GREATER or NETCOREAPP3_0_OR_GREATER. No runtime behavior changes.

Changes

Cohort / File(s) Summary
Nullability annotations
src/NLog/Layouts/SimpleLayout.cs		 Added conditional [return: System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof(text))] to the implicit string -> SimpleLayout? operator; gated by `NETSTANDARD2_1_OR_GREATER

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nudge a note where nulls may roam,
A tiny tag to guide them home.
If text is there, I’ll match its fate—
If not, I fade, default can wait.
Ears perked high, I hop with glee—
Small tweaks for safer API. 🐇

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@snakefoot snakefoot added this to the 6.0.4 milestone Aug 31, 2025
@snakefoot snakefoot added the enhancement Improvement on existing feature label Aug 31, 2025
coderabbitai[bot]
coderabbitai bot reviewed Aug 31, 2025
View reviewed changes
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

🧹 Nitpick comments (1)
src/NLog/Layouts/SimpleLayout.cs (1)

191-194: Optional: accept nullable input to match behavior (string? or [AllowNull])

The operator handles null inputs but the parameter type is non-nullable. Consider annotating the parameter as nullable to align NRT flow for callers (or keep as-is if consistency with other APIs is preferred).

-        public static implicit operator SimpleLayout?([Localizable(false)] string text)
+        public static implicit operator SimpleLayout?([Localizable(false)] string? text)

If you prefer attributes over string?, you could alternatively add [System.Diagnostics.CodeAnalysis.AllowNull] to text under the same compile guards.

📜 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 94cdd4a and c804fbd.

📒 Files selected for processing (1)
  • src/NLog/Layouts/SimpleLayout.cs (1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
src/NLog/Layouts/SimpleLayout.cs (1)
src/NLog/Layouts/LayoutParser.cs (1)
  • System (508-548)
🔇 Additional comments (1)
src/NLog/Layouts/SimpleLayout.cs (1)

191-194: LGTM: correct NotNullIfNotNull usage and target guards

Return-attribute matches the actual behavior, and the conditional compile symbols look right. Fully qualified attribute avoids extra using.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 31, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@snakefoot snakefoot merged commit 5397b53 into NLog:dev Aug 31, 2025
6 checks passed
This was referenced Sep 11, 2025
Merged
Merged
Merged
Merged
Closed
Closed
Merged
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Sep 12, 2025
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

enhancement Improvement on existing feature size/XS

Projects

None yet

Milestone

6.0.4

Development

Successfully merging this pull request may close these issues.

1 participant

@snakefoot