AnalyzeTool class
A dart_dev tool that runs the dartanalyzer
or dart analyze
on the current project.
If the useDartAnalyze
flag is not specified it will default to dartanalyzer
.
To use this tool in your project, include it in the dart_dev config in
tool/dart_dev/config.dart
:
import 'package:dart_dev/dart_dev.dart';
final config = {
'analyze': AnalyzeTool() ..useDartAnalyze = true,
};
This will make it available via the dart_dev
command-line app like so:
dart run dart_dev analyze
This tool can be configured by modifying any of its fields: // tool/dart_dev/config.dart import 'package:dart_dev/dart_dev.dart';
final config = {
'analyze': AnalyzeTool()
..analyzerArgs = ['--fatal-infos']
..include = [Glob('.'), Glob('other/**.dart')],
..useDartAnalyze = true
};
It is also possible to run this tool directly in a dart script: AnalyzeTool().run();
Constructors
Properties
-
analyzerArgs
↔ List<
String> ? -
The args to pass to the
dartanalyzer
ordart analyze
process run by this tool.getter/setter pair - argParser → ArgParser
-
The argument parser for this tool, if needed.
final
- description ↔ String?
-
This tool's description (which is included in the help/usage output) can
be overridden by setting this field to a non-null value.
getter/setter pairoverride
- hashCode → int
-
The hash code for this object.
no setterinherited
-
This field determines whether or not this tool is hidden from the
help/usage output when running as a part of a command-line app.
getter/setter pairinherited
-
include
↔ List<
Glob> ? -
The globs to include as entry points to run static analysis on.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useDartAnalyze ↔ bool?
-
The default tool for analysis will be
dartanalyzer
unless opted in here to utilizedart analyze
.getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
run(
[DevToolExecutionContext? context]) → FutureOr< int?> -
Runs this tool and returns (either synchronously or asynchronously) an
int which will be treated as the exit code (i.e. non-zero means failure).
override
-
toCommand(
String name) → Command< int> -
Converts this tool to a
Command
that can be added directly to aCommandRunner
, therefore making it executable from the command-line.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited