GenerateModuleCommand class

elementary_tools generate module command

Inheritance

• Object
• Command<void>
• TemplateGeneratorCommand
• GenerateModuleCommand

Constructors

GenerateModuleCommand()

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

The argument parser for this command.

no setter, override

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

category → String

The command's category.

no setter, inherited

description → String

A description of this command, included in usage.

no setter, override

files ↔ Map<String, File>

Maps template names to files

getter/setter pair

fileSuffixes → List<String>

no setter, inherited

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hidden → bool

Whether or not this command should be hidden from help listings.

no setter, inherited

invocation → String

A single-line template for how to invoke this command (e.g. "pub get package").

no setter, inherited

name → String

The name of this command.

no setter, override

parent → Command<void>?

The command's parent command, if this is a subcommand.

no setter, inherited

runner → CommandRunner<void>?

The command runner for this command.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subcommands → Map<String, Command<void>>

An unmodifiable view of all sublevel commands of this command.

no setter, inherited

suggestionAliases → List<String>

Alternate non-functional names for this command.

no setter, inherited

summary → String

A short description of this command, included in parent's CommandRunner.usage.

no setter, inherited

takesArguments → bool

Whether or not this command takes positional arguments in addition to options.

no setter, override

templateNames → List<String>

no setter, inherited

templates ↔ Map<String, String>

Maps template names to contents

getter/setter pair, inherited

templatesDirectoryPath ↔ String

getter/setter pair, inherited

templateToFilenameMap → Map<String, String>

Maps template names to target suffixes

no setter, override

usage → String

Generates a string displaying usage information for this command.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addSubcommand(Command<void> command) → void

Adds Command as a subcommand of this.

inherited

checkTargetFilesExistance(Iterable<File> files) → Future<void>

Checks that all target files does not exist

inherited

copyTemplatesToScriptPath(String defaultTemplateDirPath) → Future<void>

Copy templates to default directory

inherited

defaultTemplateDirectoryPath() → Future<String>

Gets default template directory path

inherited

fillTemplates() → Future<void>

Fills templates map with <templateName, fileContent> pairs

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

readTemplateFile(String filename) → Future<String>

Reads template file

inherited

run() → Future<void>

Runs this command.

override

simpleTemplateToFileMap(Directory targetDirectory, String fileNameBase) → Map<String, File>

Maps every template to a filename in a simple way

inherited

snakeToCamelCase(String snake) → String

Converts snake_case string to CamelCase

inherited

toString() → String

A string representation of this object.

inherited

usageException(String message) → Never

Throws a UsageException with message.

inherited

writeFile({required String content, required File file}) → Future<String>

Creates file and writes content

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

isSubdirNeededFlag → const String

nameOption → const String

pathOption → const String