Added version check due to upcoming breaking API

Visual Studio 2017 Update 3 will be incompatible with previous versions,
because of breaking changes in its IOperation API.

Author: Bart Koelman

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer.csproj

@@ -47,6 +47,7 @@
     <Compile Include="Extensions\OperationExtensions.cs" />
     <Compile Include="Extensions\SymbolExtensions.cs" />
     <Compile Include="Extensions\SyntaxNodeAnalysisContextExtensions.cs" />
+    <Compile Include="GuidelineAnalyzer.cs" />
     <Compile Include="IdentifierName.cs" />
     <Compile Include="Extensions\TypeSymbolExtensions.cs" />
     <Compile Include="Guard.cs" />

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer.nuspec

@@ -9,8 +9,8 @@
     <licenseUrl>http://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
     <projectUrl>https://github.com/bkoelman/CSharpGuidelinesAnalyzer</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <description>Reports diagnostics for C# coding guidelines that are not already covered by Resharper. Requires Visual Studio 2017 or 2015 with at least Update 2.</description>
-    <releaseNotes>First stable version; includes support for Visual Studio 2017.</releaseNotes>
+    <description>Reports diagnostics for C# coding guidelines that are not already covered by Resharper. Works with Visual Studio 2015 Update 2 - Visual Studio 2017 Update 2.</description>
+    <releaseNotes>Added version-based upgrade message, due to upcoming breaking changes in compiler API.</releaseNotes>
     <copyright>Apache License, Version 2.0</copyright>
     <language>en-us</language>
     <tags>csharp c# coding guidelines analyzer</tags>

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/GuidelineAnalyzer.cs

@@ -0,0 +1,92 @@
+using System;
+using System.Reflection;
+using System.Threading;
+using JetBrains.Annotations;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace CSharpGuidelinesAnalyzer
+{
+    public abstract class GuidelineAnalyzer : DiagnosticAnalyzer
+    {
+        [NotNull]
+        private static readonly CompilerVersionCompatibilityValidator VersionValidator =
+            new CompilerVersionCompatibilityValidator();
+
+        protected GuidelineAnalyzer()
+        {
+            if (!VersionValidator.IsCompatible())
+            {
+                throw new Exception(VersionValidator.GetMessage());
+            }
+        }
+
+        private sealed class CompilerVersionCompatibilityValidator
+        {
+            [NotNull]
+            private static readonly Version MinVersion = new Version(1, 2, 0, 0);
+
+            [NotNull]
+            private static readonly Version MaxVersion = new Version(2, 2, 0, 0);
+
+            private const string BaseMessage = "This analyzer package requires Visual Studio 2015 Update 2 - 2017 Update 2.";
+
+            [NotNull]
+            private static readonly Lazy<VisualStudioVersionStatus> VersionStatusLazy;
+
+            static CompilerVersionCompatibilityValidator()
+            {
+                VersionStatusLazy = new Lazy<VisualStudioVersionStatus>(GetVersionStatus, LazyThreadSafetyMode.PublicationOnly);
+            }
+
+            private static VisualStudioVersionStatus GetVersionStatus()
+            {
+                Version version = GetCompilerVersion();
+
+                return version < MinVersion
+                    ? VisualStudioVersionStatus.TooLow
+                    : version > MaxVersion
+                        ? VisualStudioVersionStatus.TooHigh
+                        : VisualStudioVersionStatus.Ok;
+            }
+
+            [NotNull]
+            private static Version GetCompilerVersion()
+            {
+                return typeof(Compilation).GetTypeInfo().Assembly.GetName().Version;
+            }
+
+            public bool IsCompatible()
+            {
+                return VersionStatusLazy.Value == VisualStudioVersionStatus.Ok;
+            }
+
+            [CanBeNull]
+            public string GetMessage()
+            {
+                switch (VersionStatusLazy.Value)
+                {
+                    case VisualStudioVersionStatus.TooLow:
+                    {
+                        return BaseMessage + " Please upgrade to a newer version of Visual Studio.";
+                    }
+                    case VisualStudioVersionStatus.TooHigh:
+                    {
+                        return BaseMessage + " Please upgrade to a newer version of CSharpGuidelinesAnalyzer.";
+                    }
+                    default:
+                    {
+                        return null;
+                    }
+                }
+            }
+
+            private enum VisualStudioVersionStatus
+            {
+                Ok,
+                TooLow,
+                TooHigh
+            }
+        }
+    }
+}

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/ClassDesign/AvoidStaticClassesAnalyzer.cs

@@ -10,7 +10,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.ClassDesign
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class AvoidStaticClassesAnalyzer : DiagnosticAnalyzer
+    public sealed class AvoidStaticClassesAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV1008";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/ClassDesign/DoNotHideInheritedMembersAnalyzer.cs

@@ -7,7 +7,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.ClassDesign
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class DoNotHideInheritedMembersAnalyzer : DiagnosticAnalyzer
+    public sealed class DoNotHideInheritedMembersAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV1010";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/ClassDesign/MembersShouldDoASingleThingAnalyzer.cs

@@ -8,7 +8,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.ClassDesign
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class MembersShouldDoASingleThingAnalyzer : DiagnosticAnalyzer
+    public sealed class MembersShouldDoASingleThingAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV1115";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/ClassDesign/TypesShouldHaveASinglePurposeAnalyzer.cs

@@ -8,7 +8,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.ClassDesign
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class TypesShouldHaveASinglePurposeAnalyzer : DiagnosticAnalyzer
+    public sealed class TypesShouldHaveASinglePurposeAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV1000";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/Documentation/AvoidInlineCommentsAnalyzer.cs

@@ -8,7 +8,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.Documentation
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class AvoidInlineCommentsAnalyzer : DiagnosticAnalyzer
+    public sealed class AvoidInlineCommentsAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV2310";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/Documentation/AvoidToDoCommentsAnalyzer.cs

@@ -9,7 +9,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.Documentation
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class AvoidToDoCommentsAnalyzer : DiagnosticAnalyzer
+    public sealed class AvoidToDoCommentsAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV2318";
 

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/Documentation/DocumentAllInternalMembersAnalyzer.cs

@@ -11,7 +11,7 @@
 namespace CSharpGuidelinesAnalyzer.Rules.Documentation
 {
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
-    public sealed class DocumentAllInternalMembersAnalyzer : DiagnosticAnalyzer
+    public sealed class DocumentAllInternalMembersAnalyzer : GuidelineAnalyzer
     {
         public const string DiagnosticId = "AV2305";