BaseLintRule class abstract

Abstract base class for custom lint rules that use analyzers.

This class provides a common implementation for integrating analyzers with custom lint rules, reducing code duplication across rule implementations.

Subclasses should:

1. Extend this class
2. Implement the analyzer getter
3. Create their own LintCode in the constructor

Implementers

• AvoidStaticColors
• AvoidStaticTypography
• AvoidTestTimeouts
• DocumentFakeParameters
• DocumentInterface
• ForbidForcedUnwrapping
• NoDirectInstantiation
• NoInternalMethodDocs
• NoOptionalOperatorsInTests
• PreferFakeOverMockRule
• PrivateSubject
• SealedOverDynamic
• SpecificExceptionTypes
• TestFileMutationCoverage
• TodoWithStoryLinks

Constructors

BaseLintRule(LintCode code, {bool testOnly = false, bool bothFiles = false})

Properties

analyzer → BaseAnalyzer

no setter

code → LintCode

The LintCode that this LintRule may emit.

final, inherited

enabledByDefault → bool

Whether the lint rule is on or off by default in an empty analysis_options.yaml

no setter, inherited

filesToAnalyze → List<String>

A list of glob patterns matching the files that run cares about.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getFixes() → List<Fix>

Obtains the list of Fix associated with this LintRule.

inherited

isEnabled(CustomLintConfigs configs) → bool

Checks whether this lint rule is enabled in a configuration file.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

run(CustomLintResolver resolver, ErrorReporter reporter, CustomLintContext context) → void

Emits lints for a given file.

startUp(CustomLintResolver resolver, CustomLintContext context) → Future<void>

Emits lints for a given file.

inherited

testAnalyzeAndRun(File file) → Future<List<AnalysisError>>

Analyze a Dart file and runs this assist in test mode.

inherited

testRun(ResolvedUnitResult result, {Pubspec? pubspec}) → Future<List<AnalysisError>>

Runs this assist in test mode.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

createLintCode(BaseAnalyzer analyzer) → LintCode