-
Notifications
You must be signed in to change notification settings - Fork 105
GCI95 [Team CSHARP][2025] - Add documentation #399
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
StanleySweet
wants to merge
1
commit into
green-code-initiative:main
Choose a base branch
from
StanleySweet:add-is-instead-of-as-rule-reference
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "title": "Use 'is' operator instead of 'as' operator and null check", | ||
| "type": "CODE_SMELL", | ||
| "status": "ready", | ||
| "remediation": { | ||
| "func": "Constant/Issue", | ||
| "constantCost": "1min" | ||
| }, | ||
| "tags": [ | ||
| "roslynator", | ||
| "readability", | ||
| "simplification", | ||
| "performance" | ||
| ], | ||
| "defaultSeverity": "Minor" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| Using the `as` operator followed by a null check is more verbose and can be simplified using the `is` operator with pattern matching. | ||
|
|
||
| When using the `is` pattern, the type check and cast happen in one concise statement, improving readability and reducing boilerplate. | ||
|
|
||
| Therefore, using `is` with pattern matching will simplify code and improve maintainability. | ||
|
|
||
| == Non compliant Code Example | ||
|
|
||
| [source,csharp] | ||
| ---- | ||
| var myObj = obj as MyType; | ||
| if (myObj != null) | ||
| { | ||
| myObj.DoSomething(); | ||
| } | ||
| ---- | ||
|
|
||
| == Compliant Code Example | ||
|
|
||
| [source,csharp] | ||
| ---- | ||
| if (obj is MyType myObj) | ||
| { | ||
| myObj.DoSomething(); | ||
| } | ||
| ---- | ||
|
|
||
| [source,csharp] | ||
| ---- | ||
| var anotherObj = maybeObj as AnotherType; | ||
| if (anotherObj != null) | ||
| { | ||
| Console.WriteLine(anotherObj.Value); | ||
| } | ||
| ---- | ||
|
|
||
| == Compliant Code Example | ||
|
|
||
| [source,csharp] | ||
| ---- | ||
| if (maybeObj is AnotherType anotherObj) | ||
| { | ||
| Console.WriteLine(anotherObj.Value); | ||
| } | ||
| ---- | ||
|
|
||
| == Additional Notes | ||
|
|
||
| - Pattern matching avoids redundant null checks. | ||
| - It ensures the cast object is both non-null and of the expected type. | ||
| - It promotes safer and more modern C# practices introduced in C# 7.0 and later. | ||
| - Also in [certain cases](https://gist.github.com/StanleySweet/cf6a62ddb1db27c4229804f8a706f323) the assembly is better with is less instructions usually means more performance and less energy consumption. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please add some references to prove this rule ? web pages ou local performance tests ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. I've added links to the relevant documentation in the rules.json as well as additional notes in this document. The rule was provided from https://github.com/green-code-initiative/creedengo-csharp/blob/main/Rules%20to%20work%20on.md