FormatCommand class

Formats the Code for all Flutter/Dart packages in the repository

You can specify the line length per package in the pubspec.yaml. When not specified the default line length of 80 is used.

name: my_package

format:
  line_length: 120
Inheritance

Constructors

FormatCommand({List<String> excludeGlob = const [], int defaultLineLength = 80, bool formatGenerated = true})

Properties

aliases List<String>
Alternate names for this command.
no setterinherited
argParser ArgParser
The argument parser for this command.
no setterinherited
argResults ArgResults?
The parsed argument results for this command.
no setterinherited
category String
The command's category.
no setterinherited
defaultLineLength int
The default line length to be used when format.line_length is not specified in pubspec.yaml.
final
description String
A description of this command, included in usage.
no setteroverride
excludeGlob List<String>
glob patterns of packages whose files should not be formatted.
final
formatGenerated bool
Set to false to not format generated files (.g.dart, or .freezed.dart)
final
foundFormatError bool
getter/setter pair
globalResults ArgResults?
The parsed global argument results.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hidden bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
name String
The name of this command.
no setteroverride
parent Command?
The command's parent command, if this is a subcommand.
no setterinherited
runner CommandRunner?
The command runner for this command.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subcommands Map<String, Command>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases List<String>
Alternate non-functional names for this command.
no setterinherited
summary String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
unformattedFiles List<String>
getter/setter pair
usage String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command command) → void
Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void
Prints the usage information for this command.
inherited
run() Future<void>
Runs this command.
override
toString() String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

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