AnalysisRule class abstract
Describes an AbstractAnalysisRule which reports exactly one type of diagnostic (one DiagnosticCode).
- Inheritance
-
- Object
- AbstractAnalysisRule
- AnalysisRule
Constructors
- AnalysisRule.new({required String name, required String description, RuleState state = const RuleState.stable()})
Properties
- canUseParsedResult → bool
-
Indicates whether this analysis rule can work with just the parsed
information or if it requires a resolved unit.
no setterinherited
- description → String
-
Short description suitable for display in console output and IDEs.
finalinherited
- diagnosticCode → DiagnosticCode
-
The code to report for a violation.
no setter
-
diagnosticCodes
→ List<
DiagnosticCode> -
The diagnostic codes associated with this analysis rule.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
-
incompatibleRules
→ List<
String> -
A list of incompatible rule names.
no setterinherited
- name → String
-
The rule name.
finalinherited
- pubspecVisitor → PubspecVisitor?
-
A visitor that visits a
Pubspec
to perform analysis.no setterinherited - reporter ← DiagnosticReporter
-
Sets the DiagnosticReporter for the CompilationUnit currently being
visited.
no getterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → RuleState
-
The state of this analysis rule.
finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerNodeProcessors(
RuleVisitorRegistry registry, RuleContext context) → void -
Registers node processors in the given
registry
.inherited -
reportAtNode(
AstNode? node, {List< Object> arguments = const [], List<DiagnosticMessage> ? contextMessages}) → void -
Reports a diagnostic at
node
with messagearguments
andcontextMessages
. -
reportAtOffset(
int offset, int length, {List< Object> arguments = const [], List<DiagnosticMessage> ? contextMessages}) → void -
Reports a diagnostic at
offset
, withlength
, with messagearguments
andcontextMessages
. -
reportAtPubNode(
PubspecNode node, {List< Object> arguments = const [], List<DiagnosticMessage> contextMessages = const []}) → void -
Reports a diagnostic at Pubspec
node
, with messagearguments
andcontextMessages
. -
reportAtToken(
Token token, {List< Object> arguments = const [], List<DiagnosticMessage> ? contextMessages}) → void -
Reports a diagnostic at
token
, with messagearguments
andcontextMessages
. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited