GraphQL.NET Analyzer Documentation
This documentation provides an overview of the analyzers that have been included
in GraphQL.NET and how to configure them using the .editorconfig file.
Introduction
Analyzers in GraphQL.NET are tools that help you identify and address potential issues or improvements in your GraphQL code. This documentation covers currently available analyzers and code fixes, along with the methods to configure them.
Configuration in .editorconfig
Certain analyzers and code fixes offer configuration options that control when the rule is applied and how the automatic code fix executes code adjustments. Refer to the specific documentation page for each analyzer to understand the available configuration options and their application methods.
Set rule severity
You can set the severity for analyzer rules in .editorconfig file with the
following syntax:
dotnet_diagnostic.<rule ID>.severity = <severity>For example
dotnet_diagnostic.GQL001.severity = noneNote: configuration keys are case insensitive
For more information about analyzers configuration see Code Analysis Configuration Overview
Included Analyzers
| Identifier | Name |
|---|---|
| GQL001 | Define the name in Field, Connection or ConnectionBuilder.Create method |
| GQL002 | Name method invocation can be removed |
| GQL003 | Different names defined by Field, Connection or ConnectionBuilder.Create and Name methods |
| GQL004 | Don't use obsolete Field methods |
| GQL005 | Illegal resolver usage |
| GQL006 | Can not match input field to the source field |
| GQL007 | Can not set source field |
| GQL008 | Don't use an obsolete Argument method |
| GQL009 | Use async resolver |
| GQL010 | Can not resolve input source type constructor |
| GQL011 | The type must not be convertible to IGraphType |
| GQL012 | Illegal method usage |
| GQL013 | OneOf fields must be nullable |
| GQL014 | OneOf fields must not have default value |
| GQL015 | Can't infer a Field name from expression |
| GQL016 | Require parameterless constructor |
| GQL017 | Could not find method |
| GQL018 | Parser method must be valid |
| GQL019 | Validator method must be valid |
| GQL020 | ValidateArguments method must be valid |