Add missing [Generator] attribute analyzer and code fix

src/Microsoft.CodeAnalysis.Analyzers/Core/AnalyzerReleases.Unshipped.md

@@ -5,3 +5,4 @@
 Rule ID | Category | Severity | Notes
 --------|----------|----------|-------
 RS1034 | MicrosoftCodeAnalysisPerformance | Warning | PreferIsKindAnalyzer
+RS1035 | MicrosoftCodeAnalysisCorrectness | Warning | SourceGeneratorAttributeAnalyzer

src/Microsoft.CodeAnalysis.Analyzers/Core/CodeAnalysisDiagnosticsResources.resx

@@ -529,4 +529,21 @@
   <data name="PreferIsKindFix" xml:space="preserve">
     <value>Use 'IsKind' instead of 'Kind'</value>
   </data>
+  <data name="MissingSourceGeneratorAttributeDescription" xml:space="preserve">
+    <value>'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</value>
+  </data>
+  <data name="MissingSourceGeneratorAttributeMessage" xml:space="preserve">
+    <value>Missing 'Generator' attribute</value>
+  </data>
+  <data name="MissingSourceGeneratorAttributeTitle" xml:space="preserve">
+    <value>Missing 'Generator' Attribute</value>
+  </data>
+  <data name="AddGeneratorAttribute_1" xml:space="preserve">
+    <value>Apply Generator attribute for '{0}'.</value>
+    <comment>"Generator" is a named type and should not be changed</comment>
+  </data>
+  <data name="AddGeneratorAttribute_2" xml:space="preserve">
+    <value>Apply Generator attribute for both '{0}' and '{1}'.</value>
+    <comment>"Generator" is a type name and should not be changed</comment>
+  </data>
 </root>

src/Microsoft.CodeAnalysis.Analyzers/Core/DiagnosticIds.cs

@@ -38,6 +38,7 @@ internal static class DiagnosticIds
         public const string DefineDiagnosticMessageCorrectlyRuleId = "RS1032";
         public const string DefineDiagnosticDescriptionCorrectlyRuleId = "RS1033";
         public const string PreferIsKindRuleId = "RS1034";
+        public const string MissingSourceGeneratorAttributeId = "RS1035";
 
         // Release tracking analyzer IDs
         public const string DeclareDiagnosticIdInAnalyzerReleaseRuleId = "RS2000";

src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/Fixers/SourceGeneratorAttributeAnalyzerFix.cs

@@ -0,0 +1,109 @@
+// Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System.Collections.Immutable;
+using System.Composition;
+using System.Globalization;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Analyzer.Utilities;
+using Microsoft.CodeAnalysis.CodeActions;
+using Microsoft.CodeAnalysis.CodeFixes;
+using Microsoft.CodeAnalysis.Editing;
+
+namespace Microsoft.CodeAnalysis.Analyzers.MetaAnalyzers.Fixers
+{
+    [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic, Name = nameof(SourceGeneratorAttributeAnalyzerFix))]
+    [Shared]
+    public sealed class SourceGeneratorAttributeAnalyzerFix : CodeFixProvider
+    {
+        public override ImmutableArray<string> FixableDiagnosticIds => ImmutableArray.Create(
+            DiagnosticIds.MissingSourceGeneratorAttributeId);
+
+        public override async Task RegisterCodeFixesAsync(CodeFixContext context)
+        {
+            var document = context.Document;
+            var root = await document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
+            var node = root.FindNode(context.Span);
+
+            if (node is null)
+            {
+                return;
+            }
+
+            foreach (var diagnostic in context.Diagnostics)
+            {
+                AddFix(
+                    string.Format(CultureInfo.CurrentCulture, CodeAnalysisDiagnosticsResources.AddGeneratorAttribute_1, LanguageNames.CSharp),
+                    context, document, node, diagnostic, LanguageNames.CSharp);
+
+                AddFix(
+                    string.Format(CultureInfo.CurrentCulture, CodeAnalysisDiagnosticsResources.AddGeneratorAttribute_1, LanguageNames.VisualBasic),
+                    context, document, node, diagnostic, LanguageNames.VisualBasic);
+
+                AddFix(
+                    string.Format(CultureInfo.CurrentCulture, CodeAnalysisDiagnosticsResources.AddGeneratorAttribute_2, LanguageNames.CSharp, LanguageNames.VisualBasic),
+                    context, document, node, diagnostic, LanguageNames.CSharp, LanguageNames.VisualBasic);
+            }
+        }
+
+        private static void AddFix(string title, CodeFixContext context, Document document, SyntaxNode node, Diagnostic diagnostic, params string[] languageNames)
+        {
+            var codeAction = CodeAction.Create(
+                title,
+                (cancellationToken) => FixDocumentAsync(document, node, languageNames, cancellationToken),
+                equivalenceKey: nameof(SourceGeneratorAttributeAnalyzerFix));
+
+            context.RegisterCodeFix(codeAction, diagnostic);
+        }
+
+        public override FixAllProvider GetFixAllProvider() => null;
+
+        private static async Task<Document> FixDocumentAsync(Document document, SyntaxNode node, string[] languageNames, CancellationToken cancellationToken)
+        {
+            var editor = await DocumentEditor.CreateAsync(document, cancellationToken).ConfigureAwait(false);
+            var generator = editor.Generator;
+
+            SyntaxNode? generatorAttribute;
+
+            if (languageNames.Length == 1 && languageNames[0] == LanguageNames.CSharp)
+            {
+                // CSharp is the only language, which is the default paramterless 
+                // constructor for the Generator attribute
+                generatorAttribute = generator.Attribute(WellKnownTypeNames.MicrosoftCodeAnalysisGeneratorAttribute);
+            }
+            else
+            {
+                // For cases where the language is VB or VB and CSharp, add 
+                // an argument to signify that
+                var languageNamesFullName = typeof(LanguageNames).FullName;
+                var splitLanguageNames = languageNamesFullName.Split('.');
+
+                var baseLanguageNameExpression = generator.IdentifierName(splitLanguageNames[0]);
+                foreach (var identifier in splitLanguageNames.Skip(1))
+                {
+                    baseLanguageNameExpression = generator.MemberAccessExpression(baseLanguageNameExpression, identifier);
+                }
+
+                var arguments = new SyntaxNode[languageNames.Length];
+                for (var i = 0; i < languageNames.Length; i++)
+                {
+                    RoslynDebug.Assert(languageNames[i] == LanguageNames.CSharp || languageNames[i] == LanguageNames.VisualBasic);
+
+                    var language = languageNames[i] == LanguageNames.CSharp
+                        ? nameof(LanguageNames.CSharp)
+                        : nameof(LanguageNames.VisualBasic);
+
+                    var finalExpression = generator.MemberAccessExpression(baseLanguageNameExpression, language);
+                    arguments[i] = finalExpression;
+                }
+
+                generatorAttribute = generator.Attribute(WellKnownTypeNames.MicrosoftCodeAnalysisGeneratorAttribute, arguments);
+            }
+
+            editor.ReplaceNode(node, generator.AddAttributes(node, generatorAttribute));
+
+            return editor.GetChangedDocument();
+        }
+    }
+}

src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/SourceGeneratorAttributeAnalyzer.cs

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System.Collections.Immutable;
+using System.Linq;
+using Analyzer.Utilities;
+using Analyzer.Utilities.Extensions;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace Microsoft.CodeAnalysis.Analyzers.MetaAnalyzers
+{
+    [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
+    public sealed class SourceGeneratorAttributeAnalyzer : DiagnosticAnalyzer
+    {
+        private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(CodeAnalysisDiagnosticsResources.MissingSourceGeneratorAttributeTitle), CodeAnalysisDiagnosticsResources.ResourceManager, typeof(CodeAnalysisDiagnosticsResources));
+        private static readonly LocalizableString s_localizableMessage = new LocalizableResourceString(nameof(CodeAnalysisDiagnosticsResources.MissingSourceGeneratorAttributeTitle), CodeAnalysisDiagnosticsResources.ResourceManager, typeof(CodeAnalysisDiagnosticsResources));
+        private static readonly LocalizableString s_localizableDescription = new LocalizableResourceString(nameof(CodeAnalysisDiagnosticsResources.MissingSourceGeneratorAttributeDescription), CodeAnalysisDiagnosticsResources.ResourceManager, typeof(CodeAnalysisDiagnosticsResources));
+
+        public static readonly DiagnosticDescriptor DiagnosticRule = new(
+            DiagnosticIds.MissingSourceGeneratorAttributeId,
+            s_localizableTitle,
+            s_localizableMessage,
+            DiagnosticCategory.MicrosoftCodeAnalysisCorrectness,
+            DiagnosticSeverity.Warning,
+            description: s_localizableDescription,
+            isEnabledByDefault: true);
+
+        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(DiagnosticRule);
+
+        public override void Initialize(AnalysisContext context)
+        {
+            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
+            context.EnableConcurrentExecution();
+
+            context.RegisterCompilationStartAction(context =>
+            {
+                if (context.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisISourceGenerator, out var sourceGenerator) &&
+                    context.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisGeneratorAttribute, out var generatorAttribute))
+                {
+                    context.RegisterSymbolAction(c => AnalyzeSymbol(c, sourceGenerator, generatorAttribute), SymbolKind.NamedType);
+                }
+            });
+        }
+
+        private static void AnalyzeSymbol(SymbolAnalysisContext c, INamedTypeSymbol sourceGenerator, INamedTypeSymbol generatorAttribute)
+        {
+            var symbol = (INamedTypeSymbol)c.Symbol;
+
+            if (symbol.IsAbstract || symbol.IsAnonymousType)
+            {
+                return;
+            }
+
+            if (!symbol.AllInterfaces.Contains(sourceGenerator))
+            {
+                return;
+            }
+
+            if (symbol.GetApplicableAttributes(null).Any(a => a.AttributeClass.Equals(generatorAttribute, SymbolEqualityComparer.Default)))
+            {
+                return;
+            }
+
+            c.ReportDiagnostic(symbol.CreateDiagnostic(DiagnosticRule, symbol.Name));
+        }
+    }
+}

src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.cs.xlf

@@ -7,6 +7,16 @@
         <target state="translated">Přidat položku pravidla k nevydanému souboru verze</target>
         <note />
       </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_1">
+        <source>Apply Generator attribute for '{0}'.</source>
+        <target state="new">Apply Generator attribute for '{0}'.</target>
+        <note>"Generator" is a named type and should not be changed</note>
+      </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_2">
+        <source>Apply Generator attribute for both '{0}' and '{1}'.</source>
+        <target state="new">Apply Generator attribute for both '{0}' and '{1}'.</target>
+        <note>"Generator" is a type name and should not be changed</note>
+      </trans-unit>
       <trans-unit id="ClassIsNotDiagnosticAnalyzerMessage">
         <source>Inherit type '{0}' from DiagnosticAnalyzer or remove the DiagnosticAnalyzerAttribute(s)</source>
         <target state="translated">Zděďte typ {0} z DiagnosticAnalyzer, nebo odeberte atributy DiagnosticAnalyzerAttribute.</target>
@@ -232,6 +242,21 @@
         <target state="translated">Použijte atribut DiagnosticAnalyzer jak pro {0}, tak i pro {1}.</target>
         <note />
       </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeDescription">
+        <source>'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</source>
+        <target state="new">'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeMessage">
+        <source>Missing 'Generator' attribute</source>
+        <target state="new">Missing 'Generator' attribute</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeTitle">
+        <source>Missing 'Generator' Attribute</source>
+        <target state="new">Missing 'Generator' Attribute</target>
+        <note />
+      </trans-unit>
       <trans-unit id="MissingSymbolKindArgumentToRegisterActionMessage">
         <source>Specify at least one SymbolKind of interest when registering a symbol analyzer action</source>
         <target state="translated">Při registraci akce analyzátoru symbolů zadejte minimálně jeden požadovaný SymbolKind.</target>

src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.de.xlf

@@ -7,6 +7,16 @@
         <target state="translated">Regeleintrag der nicht veröffentlichten Releasedatei hinzufügen</target>
         <note />
       </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_1">
+        <source>Apply Generator attribute for '{0}'.</source>
+        <target state="new">Apply Generator attribute for '{0}'.</target>
+        <note>"Generator" is a named type and should not be changed</note>
+      </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_2">
+        <source>Apply Generator attribute for both '{0}' and '{1}'.</source>
+        <target state="new">Apply Generator attribute for both '{0}' and '{1}'.</target>
+        <note>"Generator" is a type name and should not be changed</note>
+      </trans-unit>
       <trans-unit id="ClassIsNotDiagnosticAnalyzerMessage">
         <source>Inherit type '{0}' from DiagnosticAnalyzer or remove the DiagnosticAnalyzerAttribute(s)</source>
         <target state="translated">Übernehmen Sie den Typ "{0}" von DiagnosticAnalyzer, oder entfernen Sie DiagnosticAnalyzerAttribute(s).</target>
@@ -232,6 +242,21 @@
         <target state="translated">Wenden Sie das DiagnosticAnalyzer-Attribut sowohl für "{0}" als auch für "{1}" an.</target>
         <note />
       </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeDescription">
+        <source>'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</source>
+        <target state="new">'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeMessage">
+        <source>Missing 'Generator' attribute</source>
+        <target state="new">Missing 'Generator' attribute</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeTitle">
+        <source>Missing 'Generator' Attribute</source>
+        <target state="new">Missing 'Generator' Attribute</target>
+        <note />
+      </trans-unit>
       <trans-unit id="MissingSymbolKindArgumentToRegisterActionMessage">
         <source>Specify at least one SymbolKind of interest when registering a symbol analyzer action</source>
         <target state="translated">Geben Sie bei der Registrierung einer Symbolanalyseaktion mindestens einen relevanten SymbolKind-Wert an.</target>

src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.es.xlf

@@ -7,6 +7,16 @@
         <target state="translated">Agregar una entrada de regla a un archivo de versión no incluido</target>
         <note />
       </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_1">
+        <source>Apply Generator attribute for '{0}'.</source>
+        <target state="new">Apply Generator attribute for '{0}'.</target>
+        <note>"Generator" is a named type and should not be changed</note>
+      </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_2">
+        <source>Apply Generator attribute for both '{0}' and '{1}'.</source>
+        <target state="new">Apply Generator attribute for both '{0}' and '{1}'.</target>
+        <note>"Generator" is a type name and should not be changed</note>
+      </trans-unit>
       <trans-unit id="ClassIsNotDiagnosticAnalyzerMessage">
         <source>Inherit type '{0}' from DiagnosticAnalyzer or remove the DiagnosticAnalyzerAttribute(s)</source>
         <target state="translated">Herede el tipo "{0}" de DiagnosticAnalyzer o quite los elementos DiagnosticAnalyzerAttribute.</target>
@@ -232,6 +242,21 @@
         <target state="translated">Aplique el atributo DiagnosticAnalyzer para “{0}” y “{1}”.</target>
         <note />
       </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeDescription">
+        <source>'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</source>
+        <target state="new">'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeMessage">
+        <source>Missing 'Generator' attribute</source>
+        <target state="new">Missing 'Generator' attribute</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeTitle">
+        <source>Missing 'Generator' Attribute</source>
+        <target state="new">Missing 'Generator' Attribute</target>
+        <note />
+      </trans-unit>
       <trans-unit id="MissingSymbolKindArgumentToRegisterActionMessage">
         <source>Specify at least one SymbolKind of interest when registering a symbol analyzer action</source>
         <target state="translated">Especifique al menos un elemento SymbolKind de interés al registrar una acción del analizador de símbolos.</target>

src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.fr.xlf

@@ -7,6 +7,16 @@
         <target state="translated">Ajouter une entrée de règle au fichier de version non fourni</target>
         <note />
       </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_1">
+        <source>Apply Generator attribute for '{0}'.</source>
+        <target state="new">Apply Generator attribute for '{0}'.</target>
+        <note>"Generator" is a named type and should not be changed</note>
+      </trans-unit>
+      <trans-unit id="AddGeneratorAttribute_2">
+        <source>Apply Generator attribute for both '{0}' and '{1}'.</source>
+        <target state="new">Apply Generator attribute for both '{0}' and '{1}'.</target>
+        <note>"Generator" is a type name and should not be changed</note>
+      </trans-unit>
       <trans-unit id="ClassIsNotDiagnosticAnalyzerMessage">
         <source>Inherit type '{0}' from DiagnosticAnalyzer or remove the DiagnosticAnalyzerAttribute(s)</source>
         <target state="translated">Effectuez un héritage de type '{0}' à partir de DiagnosticAnalyzer, ou supprimez les instances de DiagnosticAnalyzerAttribute</target>
@@ -232,6 +242,21 @@
         <target state="translated">Appliquez l'attribut DiagnosticAnalyzer pour '{0}' et '{1}'.</target>
         <note />
       </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeDescription">
+        <source>'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</source>
+        <target state="new">'{0}' implements 'ISourceGenerator' but does not have the 'Generator' attribute.</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeMessage">
+        <source>Missing 'Generator' attribute</source>
+        <target state="new">Missing 'Generator' attribute</target>
+        <note />
+      </trans-unit>
+      <trans-unit id="MissingSourceGeneratorAttributeTitle">
+        <source>Missing 'Generator' Attribute</source>
+        <target state="new">Missing 'Generator' Attribute</target>
+        <note />
+      </trans-unit>
       <trans-unit id="MissingSymbolKindArgumentToRegisterActionMessage">
         <source>Specify at least one SymbolKind of interest when registering a symbol analyzer action</source>
         <target state="translated">Spécifiez au moins un SymbolKind d'intérêt au moment d'inscrire une action d'analyseur de symbole</target>