rspec/rules/S6669/why-dotnet.adoc

21 lines
798 B
Plaintext
Raw Normal View History

== Why is this an issue?
Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate.
This rule checks that the logger field or property name matches a provided regular expression.
The default regex will consider compliant the followings:
* `logger`
* ``++_logger++``
* `Logger`
* ``++_Logger++``
* `log`
* ``++_log++``
The rule supports the most popular logging frameworks:
* Nuget package - https://www.nuget.org/packages/Microsoft.Extensions.Logging[Microsoft.Extensions.Logging]
* Nuget package - https://www.nuget.org/packages/Serilog[Serilog]
* Nuget package - https://www.nuget.org/packages/Castle.Core[Castle.Core]
* Nuget package - https://www.nuget.org/packages/NLog[NLog]
* Nuget package - https://www.nuget.org/packages/log4net[log4net]