Fbp live directive diagnostics #80575
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Collections.Immutable; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using Microsoft.DotNet.FileBasedPrograms; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.FileBasedPrograms; | ||
|
|
||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| internal sealed class AppDirectiveDiagnosticAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| public const string DiagnosticId = "FileBasedPrograms"; | ||
|
|
||
| private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor( | ||
|
There was a problem hiding this comment. I'm getting this warning when I open this in VSCode (and didn't see it reported by CI, so just FYI):
|
||
| DiagnosticId, | ||
| title: DiagnosticId, | ||
| // TODO: we probably want to have a different diagnostic for each kind that the SDK package can produce | ||
| messageFormat: "{0}", | ||
| category: "Usage", | ||
| defaultSeverity: DiagnosticSeverity.Error, | ||
| isEnabledByDefault: true); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => [Rule]; | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.EnableConcurrentExecution(); | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); | ||
|
|
||
| context.RegisterCompilationStartAction(context => | ||
| { | ||
| context.RegisterSyntaxTreeAction(visitSyntaxTree); | ||
| }); | ||
|
|
||
| void visitSyntaxTree(SyntaxTreeAnalysisContext context) | ||
| { | ||
| var tree = context.Tree; | ||
| if (!tree.Options.Features.ContainsKey("FileBasedProgram")) | ||
| return; | ||
|
|
||
| var root = tree.GetRoot(context.CancellationToken); | ||
| if (!root.ContainsDirectives) | ||
| return; | ||
|
|
||
| // App directives are only valid when they appear before the first C# token | ||
| var rootLeadingTrivia = root.GetLeadingTrivia(); | ||
| var diagnosticBag = DiagnosticBag.Collect(out var diagnosticsBuilder); | ||
| AppDirectiveHelpers.FindLeadingDirectives( | ||
| new SourceFile(tree.FilePath, tree.GetText(context.CancellationToken)), | ||
| root.GetLeadingTrivia(), | ||
| diagnosticBag, | ||
| builder: null); | ||
|
|
||
| foreach (var diag in diagnosticsBuilder) | ||
| { | ||
| context.ReportDiagnostic(createDiagnostic(tree, diag)); | ||
| } | ||
|
|
||
| // The compiler already reports an error on all the directives past the first token in the file. | ||
| // Console.WriteLine("Hello World!"); | ||
| // #:property foo=bar // error CS9297: '#:' directives cannot be after first token in file | ||
| } | ||
|
|
||
| // TODO: should SimpleDiagnostics have IDs? message args? TextSpan? | ||
| // It feels unreasonable for users to suppress these. | ||
| // When these are present, the user cannot build/run, period. | ||
|
There was a problem hiding this comment. Yeah, currently we only have errors. We might want to add warnings in the future, but don't know about any candidates right now. There was a problem hiding this comment. Future candidate is |
||
| Diagnostic createDiagnostic(SyntaxTree syntaxTree, SimpleDiagnostic simpleDiagnostic) | ||
| { | ||
| return Diagnostic.Create( | ||
| Rule, | ||
| location: Location.Create(syntaxTree, simpleDiagnostic.Location.TextSpan), | ||
| simpleDiagnostic.Message); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess source packages can contain any sources, including resx and xlf, and if these strings need to be used inside SDK too, I don't see other option than having these in the package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll try creating a new resource file next to AppDirectiveHelpers for short term, and hopefully it is something we can just move to the source package when ready.
There is no real overhead to creating an additional resource file vs reusing existing one, I think?