Update code to use 'var' where type is explicit. #2817
Conversation
michaelcfanning
requested review from
suvamM,
shaopeng-gh,
scottoneil-ms,
rwoll,
yongyan-gh,
LingZhou-gh,
EasyRhinoMSFT and
cfaucon
as code owners
| @@ -50,7 +50,7 @@ public override void Convert(Stream input, IResultLogWriter output, OptionallyEm | |||
|
|
|||
| LogicalLocations.Clear(); | |||
|
|
|||
| XmlReaderSettings settings = new XmlReaderSettings | |||
| var settings = new XmlReaderSettings | |||
There was a problem hiding this comment.
I see csharp_style_var_when_type_is_apparent = true:error in the .editor config (
Line 80 in 29f145e
While this PR is a great cleanup, unless it's enforced in the PR check (https://github.com/microsoft/sarif-sdk/pull/2817/checks), the inconsistent style is going to creep back in.
This is likely due to EnforceCodeStyleInBuild missing in csproj/props: https://learn.microsoft.com/en-us/community/content/how-to-enforce-dotnet-format-using-editorconfig-github-actions
Consider fixing that in this PR, too.
| @@ -94,7 +94,7 @@ function Invoke-DotNetBuild($solutionFileRelativePath) { | |||
| Write-Information "Building $solutionFileRelativePath..." | |||
|
|
|||
| $solutionFilePath = Join-Path $SourceRoot $solutionFileRelativePath | |||
| & dotnet build $solutionFilePath --configuration $Configuration --verbosity $BuildVerbosity --no-incremental -bl -p:WarningsAsErrors="MSB3277" | |||
| & dotnet build $solutionFilePath --configuration $Configuration --verbosity $BuildVerbosity --no-incremental -bl -p:WarningsAsErrors="MSB3277" /p:EnforceCodeStyleInBuild=true | |||
There was a problem hiding this comment.
Internet query informed me that EnforceCodeStyleInBuild as expressed in csproj files only works within the IDE. For CLI builds you need to explicitly set this property (which appears to be a bit of a hammer, i.e., it will be applied everywhere. Fortunately that's what we want).
| @@ -297,6 +297,7 @@ csharp_style_prefer_local_over_anonymous_function = true:suggestion | |||
| dotnet_diagnostic.SA1602.severity = suggestion | |||
| dotnet_diagnostic.SA1307.severity = silent | |||
| csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion | |||
| csharp_style_prefer_primary_constructors = true:suggestion | |||
| @@ -51,7 +51,7 @@ public LineInfo(int startOffset, int lineNumber) | |||
| /// <returns>true if the objects are considered equal, false if they are not.</returns> | |||
| public override bool Equals(object obj) | |||
| { | |||
| LineInfo? other = obj as LineInfo?; | |||
There was a problem hiding this comment.
|
|
||
| <Import Project="ToDotNet\ToDotNet.targets" /> | ||
|
|
||
| <!-- Disabling the automatic code generation. This code emit is generating |
There was a problem hiding this comment.
Everyone: please note this change. The SARIF OM has been stable for years now. We don't need to keep updating it. We can't enforce stringent style guidelines on that code if the autogen keeps overwriting changes again (and I don't feel like investing in fixing the JSchema codegen for these style issues, though that would be nice if someone did it).
| @@ -1,7 +1,9 @@ | |||
| // Copyright (c) Microsoft. All rights reserved. | |||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | |||
|
|
|||
| #if DEBUG | |||
No behavioral changes, hence no release notes.
This change also disables automated SARIF object model generation: this code is stable and the autogenerator emit doesn't conform currently to our style guidelines. To enforce them we therefore need to check in and update a stable copy.
Finally, we now enforce strict adherence to the guidelines by elevating problems to errors via CLI build.