Add analyzer "Lookup Must Not Return List Type"#9553
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Roslyn analyzer to enforce that members annotated with [Lookup] do not return list-like types, aligning with Hot Chocolate best practices and the analyzer roadmap in issue #8072.
Changes:
- Introduce analyzer HC0114: “Lookup Must Not Return List Type” (error) for methods/properties decorated with
[Lookup]. - Update the existing Lookup must return nullable type analyzer to avoid double-reporting when the return type is a list.
- Add analyzer tests + snapshot baselines covering list/array/IEnumerable and
Task<List<T>>return types.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/HotChocolate/Core/src/Types.Analyzers/LookupReturnsListTypeAnalyzer.cs | New analyzer that reports HC0114 when [Lookup] returns array or supported list-like types. |
| src/HotChocolate/Core/src/Types.Analyzers/LookupReturnsNonNullableTypeAnalyzer.cs | Skips list/array return types to avoid overlapping diagnostics with the new analyzer. |
| src/HotChocolate/Core/src/Types.Analyzers/Errors.cs | Adds the HC0114 diagnostic descriptor. |
| src/HotChocolate/Core/test/Types.Analyzers.Tests/TestHelper.cs | Registers the new analyzer in the test analyzer set. |
| src/HotChocolate/Core/test/Types.Analyzers.Tests/LookupReturnsListTypeAnalyzerTests.cs | New unit tests validating HC0114 triggers and non-trigger scenarios. |
| src/HotChocolate/Core/test/Types.Analyzers.Tests/snapshots/*.md | Snapshot outputs verifying generated sources and analyzer diagnostics for the new rule. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced May 1, 2026
Open
This was referenced May 9, 2026
This was referenced May 16, 2026
Closed
This was referenced May 20, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of the changes (Less than 80 chars)
#8072