Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cezarypiatek/CSharpExtensions
A set of annotations and analyzers that add additional constraints to your codebase
https://github.com/cezarypiatek/CSharpExtensions
roslyn roslyn-analyzers
Last synced: about 2 months ago
JSON representation
A set of annotations and analyzers that add additional constraints to your codebase
- Host: GitHub
- URL: https://github.com/cezarypiatek/CSharpExtensions
- Owner: cezarypiatek
- License: mit
- Created: 2020-03-01T09:36:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-20T09:33:54.000Z (5 months ago)
- Last Synced: 2024-07-20T22:42:34.954Z (2 months ago)
- Topics: roslyn, roslyn-analyzers
- Language: C#
- Homepage:
- Size: 614 KB
- Stars: 122
- Watchers: 8
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# CSharpExtensions
Nuget packge: https://www.nuget.org/packages/SmartAnalyzers.CSharpExtensions.Annotations/
Articles that explain implemented concepts:
- [Immutable types in C# with Roslyn](https://cezarypiatek.github.io/post/immutable-types-with-roslyn/)
- [Improving non-nullable reference types handling](https://cezarypiatek.github.io/post/better-non-nullable-handling/)
- [Twin types - properties synchronization without inheritance](https://cezarypiatek.github.io/post/csharp-twin-types/)
- [Pure functions and unused return values](https://cezarypiatek.github.io/post/pure-functions-and-unused-return-value/)
## Analyzers
|Rule|Description| Related attributes|Documentation|
|----|-----------|-------------------|-------------|
|CSE001|Required properties initialization| `[InitRequired]`, `[InitRequiredForNotNull]` | [link](https://cezarypiatek.github.io/post/immutable-types-with-roslyn/#convenient-initialization) |
|CSE002|InitOnly member modification |`[InitOnly]`, `[InitOnlyOptional]`| [link](https://cezarypiatek.github.io/post/immutable-types-with-roslyn/#full-immutability) |
|CSE003|Type should have the same fields as twin type| `[TwinType]` | [link](https://cezarypiatek.github.io/post/csharp-twin-types/#the-solution-extending-c-rules-with-custom-analyzer)|
|CSE004| Member with InitOnlyOptional requires default value| `[InitOnlyOptional]` ||
|CSE005| Return value unused | | [link](https://cezarypiatek.github.io/post/pure-functions-and-unused-return-value/)|
|CSE006| Expression too complex | | |
|CSE007| Return disposable value unused | | Same as `SE005` but tracks only `IDisposable` and `IAsyncDisposable` values |
|CSE008| Return async result unused | | Same as `SE005` but tracks only `IAsyncResult` (`Task`, `ValueTask`) values |
|CSE009| Task variable not awaited | | Check if task stored in a variable is awaited |
## Configuration
Add `CSharpExtensions.json` file with custom configuration:
```json
{
"CSE005": {
"IgnoredReturnTypes": [
"Microsoft.Extensions.DependencyInjection.IServiceCollection",
"Microsoft.Extensions.Configuration.IConfigurationBuilder",
"Microsoft.Extensions.Logging.ILoggingBuilder"
]
}
}
```
Include config file as `AdditionalFile` in `csproj`:
```xml
```
## Migrating from Constructors to Initialization Blocks
**Step 1:** Configure `CSharpExtensions` to report `CSE001` even when constructor invocation is present
```json
{
"CSE001": {
"SkipWhenConstructorUsed": false
}
}
```
**Step 2:** Execute `"Try to move initialization from constructor to init block"` CodeFix for `CSE001` occurrences.
## Init-related attributes vs [init keyword](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/init) (C# 9+ feature)
|Feature | Required in init block | Can be modified outside init block| Application level|
|----|----|---|---|
| `init` keyword | NO | NO| Property|
|`[InitRequired]`| YES | YES | Property. Class|
|`[InitOnly]`| YES | NO | Property. Class|
|`[InitOnlyOptional]`| NO | NO | Property. Class|
|`[InitRequiredForNotNull]`| YES for non-null references and not `Nullable` | YES | assembly|