Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer

A Roslyn analyzer with rules related to generation and consumption of enumerables and async enumerables in C#.
https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer

analyzer csharp dotnet enumeration linq nuget nuget-package performance roslyn-analyzer

Last synced: about 2 months ago
JSON representation

A Roslyn analyzer with rules related to generation and consumption of enumerables and async enumerables in C#.

Host: GitHub
URL: https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer
Owner: NetFabric
License: mit
Created: 2019-02-21T14:29:08.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-27T01:37:14.000Z (4 months ago)
Last Synced: 2024-07-22T20:06:26.517Z (about 2 months ago)
Topics: analyzer, csharp, dotnet, enumeration, linq, nuget, nuget-package, performance, roslyn-analyzer
Language: C#
Homepage:
Size: 298 KB
Stars: 42
Watchers: 5
Forks: 6
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-analyzers - NetFabric.Hyperlinq.Analyzer - Best practices for collection enumeration in C#. (Popular Analyzers / Miscellaneous)

README

        [![GitHub last commit (master)](https://img.shields.io/github/last-commit/NetFabric/NetFabric.Hyperlinq.Analyzer/master.svg?style=flat-square&logo=github)](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/commits/master)

[![Build (master)](https://img.shields.io/github/workflow/status/NetFabric/NetFabric.Hyperlinq.Analyzer/.NET%20Core/master.svg?style=flat-square&logo=github)](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/actions)

[![Coverage](https://img.shields.io/coveralls/github/NetFabric/NetFabric.Hyperlinq.Analyzer/master?style=flat-square&logo=coveralls)](https://coveralls.io/github/NetFabric/NetFabric.Hyperlinq.Analyzer)

[![NuGet Version](https://img.shields.io/nuget/v/NetFabric.Hyperlinq.Analyzer.svg?style=flat-square&logo=nuget)](https://www.nuget.org/packages/NetFabric.Hyperlinq.Analyzer/)

[![NuGet Downloads](https://img.shields.io/nuget/dt/NetFabric.Hyperlinq.Analyzer.svg?style=flat-square&logo=nuget)](https://www.nuget.org/packages/NetFabric.Hyperlinq.Analyzer/) 

[![Gitter](https://img.shields.io/gitter/room/netfabric/netfabric.hyperlinq.analyzer?style=flat-square&logo=gitter)](https://gitter.im/NetFabric/NetFabric.Hyperlinq.Analyzer)

# NetFabric.Hyperlinq.Analyzer

A [Roslyn Analyzer](https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview) that contains several rules to help improve enumeration performance when using C#.

**Note:** This analyzer is independent of [`NetFabric.Hyperlinq`](https://github.com/NetFabric/NetFabric.Hyperlinq). The rules may be useful when you only use `foreach`, `IEnumerable`, `IAsyncEnumerable`, `System.Linq` or `System.Linq.Async`.

Rule ID | Category | Severity | Notes

--------|----------|----------|-------

[HLQ001](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ001_AssignmentBoxing.md)  | Performance | Warning  | Assigment to interface causes boxing of enumerator 

[HLQ002](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ002_NullEnumerable.md)  | Compiler | Error | Enumerable cannot be `null`. 

[HLQ003](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ003_HighestLevelInterface.md)  | Performance | Warning  | Public methods should return highest admissible level interface. 

[HLQ004](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ004_RefEnumerationVariable.md)  | Performance | Warning  | The enumerator returns a reference to the item. 

[HLQ005](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ005_AvoidSingle.md)  | Performance | Warning  | Avoid use of `Single()` and `SingleOrDefault()`

[HLQ006](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ006_GetEnumeratorReturnType.md)  | Performance | Warning  | `GetEnumerator()` or `GetAsyncEnumerator()` should return a value type. 

[HLQ007](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ007_NonDisposableEnumerator.md)  | Performance |  Warning | Consider returning a non-disposable enumerator.

[HLQ008](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ008_ReadOnlyRefEnumerable.md)  | Performance |  Info | The enumerable is a value type. Consider making it `readonly`.

[HLQ009](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ009_RemoveOptionalMethods.md)  | Performance |  Info | Consider removing an empty optional enumerator method.

[HLQ011](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ011_ReadOnlyEnumeratorField.md)  | Compiler |  Error | Mutable value-type enumerators cannot be stored in a `readonly` field.

[HLQ012](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ012_UseCollectionsMarshalAsSpan.md)  | Performance |  Warning | Consider using `CollectionsMarshal.AsSpan()` when iterating a `List`.

[HLQ013](https://github.com/NetFabric/NetFabric.Hyperlinq.Analyzer/blob/master/docs/reference/HLQ013_UseForEachLoop.md)  | Performance |  Warning | Consider using `foreach` when iterating an array or a `Span`.

# Usage

## Visual Studio Marketplace

Install the [NetFabric.Hyperlinq.Analyzer](https://marketplace.visualstudio.com/items?itemName=NetFabric.NetFabricHyperlinqAnalyzer) extension from the Visual Studio Marketplace.

## Nuget package

Add the [NetFabric.Hyperlinq.Analyzer](https://www.nuget.org/packages/NetFabric.Hyperlinq.Analyzer/) package to your project using your favorite NuGet client.

If added manually to the `.csproj`, make sure to set `PrivateAssets` to `all` so that it's not added as a dependency. A [floating version](https://docs.microsoft.com/en-us/nuget/concepts/dependency-resolution#floating-versions) can be used to get the latest version. 

``` xml

  all

  runtime; build; native; contentfiles; analyzers

```

# References

- [Enumeration in .NET](https://blog.usejournal.com/enumeration-in-net-d5674921512e) by Antão Almada

- [NetFabric.Hyperlinq — Optimizing LINQ](https://medium.com/@antao.almada/netfabric-hyperlinq-optimizing-linq-348e02566cef) by Antão Almada

- [Unit testing a Roslyn Analyzer](https://medium.com/@antao.almada/unit-testing-a-roslyn-analyzer-b3da666f0252) by Antão Almada

## Credits

The following open-source projects are used to build and test this project:

- [.NET](https://github.com/dotnet)

- [coveralls](https://coveralls.io)

- [coverlet](https://github.com/tonerdo/coverlet)

- [ILRepack](https://github.com/gluck/il-repack)

- [ILRepack.MSBuild.Task](https://github.com/peters/ILRepack.MSBuild.Task)

- [NetFabric.CodeAnalysis](https://github.com/NetFabric/NetFabric.CodeAnalysis)

- [xUnit.net](https://xunit.net/)