dotnet/runtime

Analyzer for STAThread attribute applied to async Main

Open

#78.502 geöffnet am 17. Nov. 2022

Auf GitHub ansehen
 (3 Kommentare) (7 Reaktionen) (0 zugewiesene Personen)C# (5.445 Forks)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Repository-Metriken

Stars
 (17.886 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12T 11h) (661 gemergte PRs in 30 T)

Beschreibung

Describe the problem you are trying to solve

When the [STAThread] attribute is applied to an async Main method, it does not have the intended effect (the main thread of the application is not created with the single-threaded apartment state). Since this gotcha seems to be fairly common (see e.g. https://github.com/dotnet/roslyn/issues/22112 and the issues linked to it), users should be made aware of it.

Describe suggestions on how to achieve the rule

I'm not certain if a code fix is necessary, but it could remove [STAThread] from the async Main method and then do one of the following:

  1. Add Thread.CurrentThread.SetApartmentState(ApartmentState.STA); at the start of the async Main method.
  2. Rename the async Main method to MainAsync and then add [STAThread] static void Main() => MainAsync().GetAwaiter().GetResult();.

Contributor Guide

Research-Richtung
Erkunden Sie die bestehende Roslyn Analyzer Infrastruktur in dotnet/runtime (siehe Analyzer in src/libraries/System.Runtime.Analyzers). Verstehen Sie, wie ein Diagnose Analyzer implementiert wird, der STAThread auf asynchronem Main erkennt. Berücksichtigen Sie die beiden möglichen Codekorrekturen, die im Issue beschrieben sind. Überprüfen Sie das verknüpfte Issue dotnet/roslyn#22112 für zusätzlichen Kontext. Testen Sie den Analyzer mit Beispiel Methoden für asynchrones Main.
Tech Stack
csharp
Domain
toolingdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Roslyn analyzer basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60