ToolDefinition class

Defines the attributes of a tool in the options file, corresponding to the 'tools' keyword in the options file, and populated by the ToolConfiguration class.

Implementers

Constructors

ToolDefinition(List<String> command, List<String> setupCommand, String description)
ToolDefinition.fromCommand(List<String> command, List<String> setupCommand, String description, ResourceProvider resourceProvider)
Creates a ToolDefinition or subclass that is appropriate for the command given.
factory

Properties

command List<String>
A list containing the command and options to be run for this tool. The first argument in the command is the tool executable, and will have its path evaluated relative to the dartdoc_options.yaml location. Must not be an empty list, or be null.
final
description String
A description of the defined tool. Must not be null.
final
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
setupCommand List<String>
A list containing the command and options to setup phase for this tool. The first argument in the command is the tool executable, and will have its path evaluated relative to the dartdoc_options.yaml location. May be null or empty, in which case it will be ignored at setup time.
final
setupComplete bool
If set, then the setup command has been run once for this tool definition.
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Methods

isDartExecutable(String executable) bool
Returns true if the given executable path has an extension recognized as a Dart extension (e.g. '.dart' or '.snapshot').