Skip to content

Commit 24bff53

Browse files
sharwellsharwell
committed
Usability improvements for the workaround
* Rename Roslyn7446WorkaroundAnalyzer to SA0000Roslyn7446Workaround * Allow users to configure the behavior of SA0000Roslyn7446Workaround * Improve the title and description of SA0000Roslyn7446Workaround * Disable the rule by default for improved performance
1 parent 0340bbd commit 24bff53

5 files changed

Lines changed: 254 additions & 11 deletions

File tree

‎StyleCop.Analyzers/StyleCop.Analyzers/AnalyzerCategory.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,10 @@ internal static class AnalyzerCategory
4242
/// Category definition for spacing rules.
4343
/// </summary>
4444
internal const string SpacingRules = "StyleCop.CSharp.SpacingRules";
45+
46+
/// <summary>
47+
/// Category definition for special purpose rules.
48+
/// </summary>
49+
internal const string SpecialRules = "StyleCop.CSharp.SpecialRules";
4550
}
4651
}

StyleCop.Analyzers/StyleCop.Analyzers/Roslyn7446WorkaroundAnalyzer.cs renamed to StyleCop.Analyzers/StyleCop.Analyzers/SpecialRules/SA0000Roslyn7446Workaround.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
22
// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
33

4-
namespace StyleCop.Analyzers
4+
namespace StyleCop.Analyzers.SpecialRules
55
{
66
using System;
77
using System.Collections.Immutable;
@@ -10,25 +10,25 @@ namespace StyleCop.Analyzers
1010
using Microsoft.CodeAnalysis.Diagnostics;
1111

1212
[DiagnosticAnalyzer(LanguageNames.CSharp)]
13-
internal sealed class Roslyn7446WorkaroundAnalyzer : DiagnosticAnalyzer
13+
internal sealed class SA0000Roslyn7446Workaround : DiagnosticAnalyzer
1414
{
1515
/// <summary>
16-
/// The ID for diagnostics produced by the <see cref="Roslyn7446WorkaroundAnalyzer"/> analyzer.
16+
/// The ID for diagnostics produced by the <see cref="SA0000Roslyn7446Workaround"/> analyzer.
1717
/// </summary>
18-
public const string DiagnosticId = "Roslyn7446WorkaroundAnalyzer";
19-
private const string Title = "Roslyn Bug 7446 Workaround";
20-
private const string MessageFormat = "Roslyn Bug 7446 Workaround";
21-
private const string Description = "Roslyn Bug 7446 Workaround";
22-
private const string HelpLink = "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Roslyn7446WorkaroundAnalyzer.md";
18+
public const string DiagnosticId = "SA0000";
19+
private static readonly LocalizableString Title = new LocalizableResourceString(nameof(SpecialResources.SA0000Title), SpecialResources.ResourceManager, typeof(SpecialResources));
20+
private static readonly LocalizableString MessageFormat = new LocalizableResourceString(nameof(SpecialResources.SA0000MessageFormat), SpecialResources.ResourceManager, typeof(SpecialResources));
21+
private static readonly LocalizableString Description = new LocalizableResourceString(nameof(SpecialResources.SA0000Description), SpecialResources.ResourceManager, typeof(SpecialResources));
22+
private static readonly string HelpLink = "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA0000Roslyn7446Workaround.md";
2323

2424
private static readonly DiagnosticDescriptor Descriptor =
25-
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.SpacingRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink, WellKnownDiagnosticTags.NotConfigurable);
25+
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.SpecialRules, DiagnosticSeverity.Info, AnalyzerConstants.DisabledByDefault, Description, HelpLink);
2626

2727
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
2828

2929
private static readonly bool CallGetDeclarationDiagnostics;
3030

31-
static Roslyn7446WorkaroundAnalyzer()
31+
static SA0000Roslyn7446Workaround()
3232
{
3333
// dotnet/roslyn#7446 was fixed for Roslyn 1.2
3434
CallGetDeclarationDiagnostics = typeof(AdditionalText).GetTypeInfo().Assembly.GetName().Version < new Version(1, 2, 0, 0);

‎StyleCop.Analyzers/StyleCop.Analyzers/SpecialRules/SpecialResources.Designer.cs‎

Lines changed: 93 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎StyleCop.Analyzers/StyleCop.Analyzers/SpecialRules/SpecialResources.resx‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="SA0000Description" xml:space="preserve">
121+
<value>Visual Studio 2015 Update 1 contains a bug which can cause diagnostics to occasionally not display in the Errors window. When this occurs, it is impossible to use the code fixes to address style violations reported during a build. This analyzer works around the bug (dotnet/roslyn#7446).
122+
123+
When this analyzer is enabled, all diagnostics will eventually be reported in the Error window, but the performance of the analyzers is reduced. The rule is disabled for maximum performance, but can be enabled if users notice errors appearing during a build but not while editing, and they wish to use the code fixes to correct them.
124+
125+
Note that some situations are not affected by the bug:
126+
127+
* When building a project, all relevant warnings are reported even if this rule is disabled.
128+
* The various Fix All operations work properly for the selected scope, even if only a subset of the violations are appearing in the Errors window.</value>
129+
</data>
130+
<data name="SA0000MessageFormat" xml:space="preserve">
131+
<value>n/a</value>
132+
</data>
133+
<data name="SA0000Title" xml:space="preserve">
134+
<value>Workaround incomplete diagnostics in Visual Studio 2015 Update 1</value>
135+
</data>
136+
</root>

‎StyleCop.Analyzers/StyleCop.Analyzers/StyleCop.Analyzers.csproj‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@
268268
<Compile Include="ReadabilityRules\SA1133DoNotCombineAttributes.cs" />
269269
<Compile Include="ReadabilityRules\SA1134AttributesMustNotShareLine.cs" />
270270
<Compile Include="ReadabilityRules\SX1101DoNotPrefixLocalMembersWithThis.cs" />
271-
<Compile Include="Roslyn7446WorkaroundAnalyzer.cs" />
272271
<Compile Include="Settings\ObjectModel\DocumentationSettings.cs" />
273272
<Compile Include="Settings\ObjectModel\EndOfFileHandling.cs" />
274273
<Compile Include="Settings\ObjectModel\FileNamingConvention.cs" />
@@ -323,6 +322,12 @@
323322
<DependentUpon>SpacingResources.resx</DependentUpon>
324323
</Compile>
325324
<Compile Include="SpacingRules\TokenSpacingProperties.cs" />
325+
<Compile Include="SpecialRules\SA0000Roslyn7446Workaround.cs" />
326+
<Compile Include="SpecialRules\SpecialResources.Designer.cs">
327+
<AutoGen>True</AutoGen>
328+
<DesignTime>True</DesignTime>
329+
<DependentUpon>SpecialResources.resx</DependentUpon>
330+
</Compile>
326331
</ItemGroup>
327332
<ItemGroup>
328333
<None Include="..\..\build\keys\StyleCopAnalyzers.dev.snk">
@@ -424,6 +429,10 @@
424429
<Generator>ResXFileCodeGenerator</Generator>
425430
<LastGenOutput>SpacingResources.Designer.cs</LastGenOutput>
426431
</EmbeddedResource>
432+
<EmbeddedResource Include="SpecialRules\SpecialResources.resx">
433+
<Generator>ResXFileCodeGenerator</Generator>
434+
<LastGenOutput>SpecialResources.Designer.cs</LastGenOutput>
435+
</EmbeddedResource>
427436
</ItemGroup>
428437
<Import Project="$(MSBuildExtensionsPath32)\Microsoft\Portable\$(TargetFrameworkVersion)\Microsoft.Portable.CSharp.targets" />
429438
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">

0 commit comments

Comments
 (0)