Skip to content

Increase severity of some rules and fix instances #1305

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

Merged
merged 2 commits into from
Feb 24, 2022
Merged

Increase severity of some rules and fix instances #1305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9cd5d8
Increase severity of some rules and fix instances
Evangelink Feb 17, 2022
72fab2a
Revert static changes to public API + address review feedback
Evangelink Feb 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,20 +87,34 @@ dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:warning
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
# CA1805: Do not initialize unnecessarily
dotnet_diagnostic.CA1805.severity = warning
# IDE0063: Use simple 'using' statement
dotnet_diagnostic.IDE0063.severity = warning
# IDE0057: Use range operator
dotnet_diagnostic.IDE0057.severity = warning
# IDE0075: Simplify conditional expression
dotnet_diagnostic.IDE0075.severity = warning
# IDE0071: Simplify interpolation
dotnet_diagnostic.IDE0071.severity = warning
# CA1829: Use Length/Count property instead of Count() when available
dotnet_diagnostic.CA1829.severity = warning
# CA1827: Do not use Count() or LongCount() when Any() can be used
dotnet_diagnostic.CA1827.severity = warning
###############################
# Naming Conventions #
###############################
# Name all constant fields using PascalCase
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.required_modifiers = const
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# Static fields should have s_ prefix
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
dotnet_naming_symbols.static_fields.applicable_kinds = field
dotnet_naming_symbols.static_fields.required_modifiers = static
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
Expand All @@ -109,11 +123,15 @@ dotnet_naming_style.static_prefix_style.capitalization = camel_case
# Internal and private fields should be _camelCase
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
# IDE1006: Naming Styles
dotnet_diagnostic.IDE1006.severity = warning
# IDE0090: Use 'new(...)'
dotnet_diagnostic.IDE0090.severity = warning
###############################
# C# Coding Conventions #
###############################
Expand Down
10 changes: 4 additions & 6 deletions src/coverlet.collector/DataCollection/CoverletCoverageCollector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,13 @@ private void OnSessionEnd(object sender, SessionEndEventArgs e)
// Get coverage reports
IEnumerable<(string report, string fileName)> coverageReports = _coverageManager?.GetCoverageReports();

if (coverageReports != null && coverageReports.Count() > 0)
if (coverageReports != null && coverageReports.Any())
{
// Send result attachments to test platform.
using (var attachmentManager = new AttachmentManager(_dataSink, _dataCollectionContext, _logger, _eqtTrace, _countDownEventFactory.Create(coverageReports.Count(), TimeSpan.FromSeconds(30))))
using var attachmentManager = new AttachmentManager(_dataSink, _dataCollectionContext, _logger, _eqtTrace, _countDownEventFactory.Create(coverageReports.Count(), TimeSpan.FromSeconds(30)));
foreach ((string report, string fileName) in coverageReports)
{
foreach ((string report, string fileName) in coverageReports)
{
attachmentManager.SendCoverageReport(report, fileName);
}
attachmentManager.SendCoverageReport(report, fileName);
}
}
else
Expand Down
30 changes: 15 additions & 15 deletions src/coverlet.collector/DataCollection/CoverletSettingsParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public CoverletSettings Parse(XmlElement configurationElement, IEnumerable<strin
/// </summary>
/// <param name="testModules">Test modules</param>
/// <returns>Test module</returns>
private string ParseTestModule(IEnumerable<string> testModules)
private static string ParseTestModule(IEnumerable<string> testModules)
{
// Validate if at least one source present.
if (testModules == null || !testModules.Any())
Expand All @@ -86,7 +86,7 @@ private string ParseTestModule(IEnumerable<string> testModules)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Report formats</returns>
private string[] ParseReportFormats(XmlElement configurationElement)
private static string[] ParseReportFormats(XmlElement configurationElement)
{
string[] formats = Array.Empty<string>();
if (configurationElement != null)
Expand All @@ -103,7 +103,7 @@ private string[] ParseReportFormats(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Filters to include</returns>
private string[] ParseIncludeFilters(XmlElement configurationElement)
private static string[] ParseIncludeFilters(XmlElement configurationElement)
{
XmlElement includeFiltersElement = configurationElement[CoverletConstants.IncludeFiltersElementName];
return SplitElement(includeFiltersElement);
Expand All @@ -114,7 +114,7 @@ private string[] ParseIncludeFilters(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Directories to include</returns>
private string[] ParseIncludeDirectories(XmlElement configurationElement)
private static string[] ParseIncludeDirectories(XmlElement configurationElement)
{
XmlElement includeDirectoriesElement = configurationElement[CoverletConstants.IncludeDirectoriesElementName];
return SplitElement(includeDirectoriesElement);
Expand All @@ -125,7 +125,7 @@ private string[] ParseIncludeDirectories(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Filters to exclude</returns>
private string[] ParseExcludeFilters(XmlElement configurationElement)
private static string[] ParseExcludeFilters(XmlElement configurationElement)
{
var excludeFilters = new List<string> { CoverletConstants.DefaultExcludeFilter };

Expand All @@ -147,7 +147,7 @@ private string[] ParseExcludeFilters(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Source files to exclude</returns>
private string[] ParseExcludeSourceFiles(XmlElement configurationElement)
private static string[] ParseExcludeSourceFiles(XmlElement configurationElement)
{
XmlElement excludeSourceFilesElement = configurationElement[CoverletConstants.ExcludeSourceFilesElementName];
return SplitElement(excludeSourceFilesElement);
Expand All @@ -158,7 +158,7 @@ private string[] ParseExcludeSourceFiles(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Attributes to exclude</returns>
private string[] ParseExcludeAttributes(XmlElement configurationElement)
private static string[] ParseExcludeAttributes(XmlElement configurationElement)
{
XmlElement excludeAttributesElement = configurationElement[CoverletConstants.ExcludeAttributesElementName];
return SplitElement(excludeAttributesElement);
Expand All @@ -169,7 +169,7 @@ private string[] ParseExcludeAttributes(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Merge with attribute</returns>
private string ParseMergeWith(XmlElement configurationElement)
private static string ParseMergeWith(XmlElement configurationElement)
{
XmlElement mergeWithElement = configurationElement[CoverletConstants.MergeWithElementName];
return mergeWithElement?.InnerText;
Expand All @@ -180,7 +180,7 @@ private string ParseMergeWith(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Use source link flag</returns>
private bool ParseUseSourceLink(XmlElement configurationElement)
private static bool ParseUseSourceLink(XmlElement configurationElement)
{
XmlElement useSourceLinkElement = configurationElement[CoverletConstants.UseSourceLinkElementName];
bool.TryParse(useSourceLinkElement?.InnerText, out bool useSourceLink);
Expand All @@ -192,7 +192,7 @@ private bool ParseUseSourceLink(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Single hit flag</returns>
private bool ParseSingleHit(XmlElement configurationElement)
private static bool ParseSingleHit(XmlElement configurationElement)
{
XmlElement singleHitElement = configurationElement[CoverletConstants.SingleHitElementName];
bool.TryParse(singleHitElement?.InnerText, out bool singleHit);
Expand All @@ -204,7 +204,7 @@ private bool ParseSingleHit(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>ParseDeterministicReport flag</returns>
private bool ParseDeterministicReport(XmlElement configurationElement)
private static bool ParseDeterministicReport(XmlElement configurationElement)
{
XmlElement deterministicReportElement = configurationElement[CoverletConstants.DeterministicReport];
bool.TryParse(deterministicReportElement?.InnerText, out bool deterministicReport);
Expand All @@ -216,7 +216,7 @@ private bool ParseDeterministicReport(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Include Test Assembly Flag</returns>
private bool ParseIncludeTestAssembly(XmlElement configurationElement)
private static bool ParseIncludeTestAssembly(XmlElement configurationElement)
{
XmlElement includeTestAssemblyElement = configurationElement[CoverletConstants.IncludeTestAssemblyElementName];
bool.TryParse(includeTestAssemblyElement?.InnerText, out bool includeTestAssembly);
Expand All @@ -228,7 +228,7 @@ private bool ParseIncludeTestAssembly(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>Include Test Assembly Flag</returns>
private bool ParseSkipAutoProps(XmlElement configurationElement)
private static bool ParseSkipAutoProps(XmlElement configurationElement)
{
XmlElement skipAutoPropsElement = configurationElement[CoverletConstants.SkipAutoProps];
bool.TryParse(skipAutoPropsElement?.InnerText, out bool skipAutoProps);
Expand All @@ -240,7 +240,7 @@ private bool ParseSkipAutoProps(XmlElement configurationElement)
/// </summary>
/// <param name="configurationElement">Configuration element</param>
/// <returns>DoesNotReturn attributes</returns>
private string[] ParseDoesNotReturnAttributes(XmlElement configurationElement)
private static string[] ParseDoesNotReturnAttributes(XmlElement configurationElement)
{
XmlElement doesNotReturnAttributesElement = configurationElement[CoverletConstants.DoesNotReturnAttributesElementName];
return SplitElement(doesNotReturnAttributesElement);
Expand All @@ -251,7 +251,7 @@ private string[] ParseDoesNotReturnAttributes(XmlElement configurationElement)
/// </summary>
/// <param name="element">The element to split</param>
/// <returns>An array of the values in the element</returns>
private string[] SplitElement(XmlElement element)
private static string[] SplitElement(XmlElement element)
{
return element?.InnerText?.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Where(value => !string.IsNullOrWhiteSpace(value)).Select(value => value.Trim()).ToArray();
}
Expand Down
2 changes: 1 addition & 1 deletion src/coverlet.collector/InProcDataCollection/CoverletInProcDataCollector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Coverlet.Collector.DataCollection
public class CoverletInProcDataCollector : InProcDataCollection
{
private TestPlatformEqtTrace _eqtTrace;
private bool _enableExceptionLog = false;
private bool _enableExceptionLog;

private void AttachDebugger()
{
Expand Down
5 changes: 3 additions & 2 deletions src/coverlet.console/Logging/ConsoleLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ namespace Coverlet.Console.Logging
{
class ConsoleLogger : ILogger
{
private static readonly object _sync = new object();
private static readonly object s_sync = new();

public LogLevel Level { get; set; } = LogLevel.Normal;

public void LogError(string message) => Log(LogLevel.Quiet, message, ConsoleColor.Red);
Expand All @@ -26,7 +27,7 @@ private void Log(LogLevel level, string message, ConsoleColor color)
{
if (level < Level) return;

lock (_sync)
lock (s_sync)
{
ConsoleColor currentForegroundColor;
if (color != (currentForegroundColor = ForegroundColor))
Expand Down
2 changes: 1 addition & 1 deletion src/coverlet.core/Coverage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ private bool BranchInCompilerGeneratedClass(string methodName)
return false;
}

private Method GetMethodWithSameLineInSameDocument(Classes documentClasses, string compilerGeneratedClassName, int branchLine)
private static Method GetMethodWithSameLineInSameDocument(Classes documentClasses, string compilerGeneratedClassName, int branchLine)
{
foreach (KeyValuePair<string, Methods> @class in documentClasses)
{
Expand Down
Loading