Skip to content

Add NonAwaitableTypeAttribute for MA0042/MA0045#1153

Merged
meziantou merged 10 commits into
mainfrom
meziantou/async-exclusion-attributes
May 12, 2026
Merged

Add NonAwaitableTypeAttribute for MA0042/MA0045#1153
meziantou merged 10 commits into
mainfrom
meziantou/async-exclusion-attributes

Conversation

@meziantou
Copy link
Copy Markdown
Owner

@meziantou meziantou commented May 12, 2026

MA0042/MA0045 needed a clear attribute-based way to opt out of await and await using recommendations for specific types. The existing ExcludeFromBlockingCallAnalysisAttribute only targeted member-level blocking-call diagnostics and did not provide a dedicated type-level await exclusion model.

What changed

  • Added NonAwaitableTypeAttribute in Meziantou.Analyzer.Annotations (assembly-level, Type argument) and bumped the annotations package version.
  • Updated annotation symbol detection for all rules that use AwaitableTypes.
  • This keeps method/property exclusion (ExcludeFromBlockingCallAnalysisAttribute) and type-level await exclusion (NonAwaitableTypeAttribute) as separate concepts.

Fix #1152

meziantou and others added 10 commits May 12, 2026 13:33
Add a dedicated annotations attribute to configure MA0042/MA0045 await exclusions by type, wire it into await and await-using analysis, and update tests and docs accordingly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Limit NonAwaitableTypeAttribute matching to the declared type instead of its hierarchy, add regression tests for derived await/await-using cases, and document exact-type semantics.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Centralize NonAwaitableTypeAttribute parsing/matching in AwaitableTypes so rules sharing awaitable detection can reuse it, and update MA0042/MA0045 to consume the shared API.

Add regression coverage for MA0134 and MA0137 behavior with NonAwaitableTypeAttribute.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update MA0100, MA0134, MA0137, and MA0138 documentation to describe NonAwaitableTypeAttribute support and exact-type matching behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add test coverage for NonAwaitableTypeAttribute(typeof(T<>)) so open generic declarations are validated across MA0042, MA0134, and MA0137 behaviors.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Ensure each rule doc mentioning NonAwaitableTypeAttribute also references the Meziantou.Analyzer.Annotations README, following the MA0042 pattern.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adjust AwaitableTypes to evaluate only the provided type in IsNonAwaitableType, without unwrapping Task<T>/ValueTask<T>. Update rule tests to reflect task-wrapped types are no longer excluded by inner type annotations.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Inline ValueTask and ValueTask generic symbol lookups directly in the constructor branch and remove temporary locals.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@meziantou meziantou merged commit 299b684 into main May 12, 2026
13 checks passed
@meziantou meziantou deleted the meziantou/async-exclusion-attributes branch May 12, 2026 20:07
This was referenced May 12, 2026
IhateTrains pushed a commit to ParadoxGameConverters/ImperatorToCK3 that referenced this pull request May 13, 2026
Updated
[Meziantou.Analyzer](https://github.com/meziantou/Meziantou.Analyzer)
from 3.0.79 to 3.0.84.

<details>
<summary>Release notes</summary>

_Sourced from [Meziantou.Analyzer's
releases](https://github.com/meziantou/Meziantou.Analyzer/releases)._

## 3.0.84

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.84>

## What's Changed
* Ignore `[Experimental]` overloads in MA0040 cancellation-token
matching by @​Copilot in
meziantou/Meziantou.Analyzer#1157


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.83...3.0.84

## 3.0.83

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.83>

## What's Changed
* Add NonAsyncDisposableTypeAttribute for await using by @​meziantou in
meziantou/Meziantou.Analyzer#1154


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.82...3.0.83

## 3.0.82

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.82>

## What's Changed
* Add NonAwaitableTypeAttribute for MA0042/MA0045 by @​meziantou in
meziantou/Meziantou.Analyzer#1153


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.81...3.0.82

## 3.0.81

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.81>

## What's Changed
* Improve annotations documentation and rule references by @​meziantou
in meziantou/Meziantou.Analyzer#1151


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.80...3.0.81

## 3.0.80

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.80>

**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.79...3.0.80

Commits viewable in [compare
view](meziantou/Meziantou.Analyzer@3.0.79...3.0.84).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Meziantou.Analyzer&package-manager=nuget&previous-version=3.0.79&new-version=3.0.84)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ExcludeFromBlockingCallAnalysisAttribute not working as expected

1 participant