diff --git a/src/.editorconfig b/src/.editorconfig index 79c841685..d96d944b1 100644 --- a/src/.editorconfig +++ b/src/.editorconfig @@ -194,4 +194,12 @@ dotnet_naming_style.pascal_case.capitalization = pascal_case dotnet_naming_style.begins_with_i.required_prefix = I dotnet_naming_style.begins_with_i.required_suffix = dotnet_naming_style.begins_with_i.word_separator = -dotnet_naming_style.begins_with_i.capitalization = pascal_case \ No newline at end of file +dotnet_naming_style.begins_with_i.capitalization = pascal_case + +dotnet_diagnostic.CS1570.severity = warning +dotnet_diagnostic.CS1572.severity = warning +dotnet_diagnostic.CS1573.severity = warning +dotnet_diagnostic.CS1574.severity = warning +dotnet_diagnostic.CS1591.severity = warning +dotnet_diagnostic.CS1712.severity = warning +dotnet_diagnostic.CS1734.severity = warning diff --git a/src/Sarif/Baseline/ResultMatching/SarifLogResultMatcher.cs b/src/Sarif/Baseline/ResultMatching/SarifLogResultMatcher.cs index e9b7eb590..8bf4d50c5 100644 --- a/src/Sarif/Baseline/ResultMatching/SarifLogResultMatcher.cs +++ b/src/Sarif/Baseline/ResultMatching/SarifLogResultMatcher.cs @@ -36,7 +36,7 @@ public SarifLogResultMatcher( /// Helper function that accepts a single baseline and current SARIF log and matches them. /// /// Array of SARIF logs representing the baseline run - /// Array of SARIF logs representing the current run + /// Array of SARIF logs representing the current run /// A SARIF log with the merged set of results. public SarifLog Match(SarifLog previousLog, SarifLog currentLog) { diff --git a/src/Sarif/Baseline/V2/WhatComparer.cs b/src/Sarif/Baseline/V2/WhatComparer.cs index 40a0eba97..4daed909d 100644 --- a/src/Sarif/Baseline/V2/WhatComparer.cs +++ b/src/Sarif/Baseline/V2/WhatComparer.cs @@ -71,6 +71,7 @@ public static IEnumerable WhatProperties(this ExtractedResult res /// /// Match the 'What' properties of two ExtractedResults. /// + /// ExtractedResult to match /// ExtractedResult to match /// True if *any* 'What' property matches, False otherwise public static bool MatchesWhat(ExtractedResult left, ExtractedResult right, TrustMap trustMap = null) diff --git a/src/Sarif/Core/ArtifactLocation.cs b/src/Sarif/Core/ArtifactLocation.cs index cbbcf683b..7f4489e49 100644 --- a/src/Sarif/Core/ArtifactLocation.cs +++ b/src/Sarif/Core/ArtifactLocation.cs @@ -14,7 +14,6 @@ public partial class ArtifactLocation /// successfully reconstitute an absolute URI, it will return false /// and populate 'resolvedUri' with null. /// - /// The fileLocatio instance from which an absolute URI should be reconstructed, if possible. /// The original uri base id values associated with the tool run. /// The reconstructed absolute URI or null (if an absolute URI cannot be reconstructed). /// diff --git a/src/Sarif/Core/SarifLog.cs b/src/Sarif/Core/SarifLog.cs index d9dd7ebb8..465b9b23a 100644 --- a/src/Sarif/Core/SarifLog.cs +++ b/src/Sarif/Core/SarifLog.cs @@ -75,7 +75,7 @@ public void Save(string sarifFilePath) /// /// Write a SARIF log to a destination stream. /// - /// Stream to write SARIF to + /// Stream to write SARIF to public void Save(Stream stream) { using (StreamWriter streamWriter = new StreamWriter(stream)) diff --git a/src/Sarif/Core/StackFrame.cs b/src/Sarif/Core/StackFrame.cs index 5f9e000ca..42c2827e7 100644 --- a/src/Sarif/Core/StackFrame.cs +++ b/src/Sarif/Core/StackFrame.cs @@ -20,7 +20,7 @@ public partial class StackFrame /// /// Creates a SARIF StackFrame instance from a .NET StackFrame instance /// - /// + /// /// public static StackFrame Create(System.Diagnostics.StackFrame dotNetStackFrame) { diff --git a/src/Sarif/IAnalysisLogger.cs b/src/Sarif/IAnalysisLogger.cs index 4f5a5fe85..bd292c368 100644 --- a/src/Sarif/IAnalysisLogger.cs +++ b/src/Sarif/IAnalysisLogger.cs @@ -37,6 +37,7 @@ public interface IAnalysisLogger /// Log a simple message for display to users (which /// will not be persisted to log files) /// + /// /// void LogMessage(bool verbose, string message); } diff --git a/src/Sarif/IResultLogWriter.cs b/src/Sarif/IResultLogWriter.cs index bdb139e3a..75d54f40c 100644 --- a/src/Sarif/IResultLogWriter.cs +++ b/src/Sarif/IResultLogWriter.cs @@ -14,8 +14,7 @@ public interface IResultLogWriter /// results. A result might produce a new file object to be stored in run.files, /// for example, so run.Files will not be persisted on initialization. /// - /// A string that uniquely identifies a run. - /// A global identifier for a run that permits correlation with a larger automation process. + /// void Initialize(Run run); /// diff --git a/src/Sarif/Processors/Generic/IFoldAction.cs b/src/Sarif/Processors/Generic/IFoldAction.cs index d1dc1450f..6436f18fd 100644 --- a/src/Sarif/Processors/Generic/IFoldAction.cs +++ b/src/Sarif/Processors/Generic/IFoldAction.cs @@ -10,7 +10,7 @@ public interface IFoldAction : IActionWrapper /// /// Take an action on each sarif log, return the accumulated result. /// - /// List to fold over + /// Collection to fold over /// Accumulator to use. /// The accumulated result. T Fold(IEnumerable collection, T accumulator); diff --git a/src/Sarif/Query/Evaluators/EvaluatorFactory.cs b/src/Sarif/Query/Evaluators/EvaluatorFactory.cs index 525fea4bb..e9998fffc 100644 --- a/src/Sarif/Query/Evaluators/EvaluatorFactory.cs +++ b/src/Sarif/Query/Evaluators/EvaluatorFactory.cs @@ -18,7 +18,7 @@ public static class EvaluatorFactory /// /// int[] set; /// BitArray matches = new BitArray(set.Length); - // evaluator.Evaluate(set, matches); + /// evaluator.Evaluate(set, matches); /// /// Primitive type of array to build evaluator for /// Query term with comparison and constant to evaluate against array diff --git a/src/Sarif/Writers/ResultLogJsonWriter.cs b/src/Sarif/Writers/ResultLogJsonWriter.cs index 2cfc8e28c..73071fbb7 100644 --- a/src/Sarif/Writers/ResultLogJsonWriter.cs +++ b/src/Sarif/Writers/ResultLogJsonWriter.cs @@ -49,8 +49,7 @@ public ResultLogJsonWriter(JsonWriter jsonWriter) /// Initializes the SARIF log by emitting properties and other constructs /// sufficient to being populating a run with results. /// - /// A string that uniquely identifies a run. - /// A global identifier for a run that permits correlation with a larger automation process. + /// public void Initialize(Run run) { if (run == null) diff --git a/src/WorkItems/FilingClient.cs b/src/WorkItems/FilingClient.cs index 41ef66b3b..de194f531 100644 --- a/src/WorkItems/FilingClient.cs +++ b/src/WorkItems/FilingClient.cs @@ -58,7 +58,7 @@ public FilingClient() /// /// Asynchronously file work items for the specified results. /// - /// + /// /// Describes the work items to be filed. /// /// diff --git a/src/WorkItems/IVssConnection.cs b/src/WorkItems/IVssConnection.cs index cd36a6f7f..e23a2f42f 100644 --- a/src/WorkItems/IVssConnection.cs +++ b/src/WorkItems/IVssConnection.cs @@ -21,9 +21,8 @@ internal interface IVssConnection: IDisposable Task ConnectAsync(Uri accountUri, string personalAccessToken); /// - /// Interface abstraction for VssConnection.GetClientAsync + /// Interface abstraction for VssConnection.GetClientAsync /// - /// /// Task GetClientAsync(); } diff --git a/src/build.props b/src/build.props index 8ede46a6f..4cf9a34b4 100644 --- a/src/build.props +++ b/src/build.props @@ -4,6 +4,7 @@ netcoreapp2.1;net461 8.0 + true