FormatCommand class
Formats Dart source code across project modules.
The FormatCommand applies consistent code formatting to Dart files
using the dart format tool. It supports targeting specific apps,
features, or pages, or formatting the entire project.
Usage
Format entire project:
morpheme format
Format specific app:
morpheme format --apps-name my_app
Format specific feature:
morpheme format --feature-name user_profile
Format specific page:
morpheme format --page-name login_page --feature-name auth
Options
--apps-name, -a: Target specific app for formatting--feature-name, -f: Target specific feature for formatting--page-name, -p: Target specific page for formatting
Scope Rules
- Page scope requires feature to be specified
- Feature scope can be within an app or at project level
- App scope formats the entire app including its features
Dependencies
- Uses ModularHelper for multi-package formatting
- Requires dart format tool (included with Dart SDK)
Exceptions
Throws ArgumentError if page is specified without feature.
Throws FileSystemException if target paths don't exist.
Throws ProcessException if dart format fails.
Constructors
- FormatCommand()
- Creates a new instance of FormatCommand.
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 setteroverride
- description → String
-
A description of this command, included in usage.
no setteroverride
- globalResults → ArgResults?
-
The parsed global argument results.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
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 getpackage").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
- usage → String
-
Generates a string displaying usage information for this command.
no setterinherited
-
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(
) → 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