afib_command library
AFib code used in the bin/xxx_afib.dart command for your project.
This code is separated out because it cannot reference flutter UI, or the command won't load properly. When creating an AFib command, you should import this library, not afib_flutter.
Classes
- AFArgs
- The set of arguments specified for an AFib command.
- AFBaseExtensionContext
- Root class for contexts that extend AFib at the earliest, 'base' phase.
- AFBaseTestID
- Base class for all test related ids
- AFBottomSheetID
- AFCodeBuffer
- An in-memory buffer containing code, used during code generation.
- AFCodeGenerator
- Primary API for code generation, accessible via AFCommandContext.generator
- AFCommand
- Parent for commands executed through the afib command line app.
- AFCommandAppExtensionContext
- The extension context used by the app itself to register commands.
- AFCommandArgumentsParsed
- Returned by AFCommandContext.parseArguments, the best way to access arguments from a command.
- AFCommandContext
- The primary runtime context passed to a command during execution.
- AFCommandGroup
- Utility which allows a command like 'generate' to have multiple subcommands.
- AFCommandLibraryExtensionContext
- Context for registering commands, and source templates
- AFCommandOutput
- Used to achieve nicely formatted output for commands.
- AFCommandOutputColumn
- Defines properties of a column in the command output.
- AFCommandRunner
- Provides the set of known commands in a given context, and the ability to run them.
- AFConfig
- Accessor for values in xxx_config.g.dart, accessible via AFibD.config.
- AFConfigEntries
- Constants used to specify values in xxx_config.g.dart
- AFConfigEntryDescription
- Used to define choices for a configuration value.
- AFConfigurationItem
- Superclass for all configuration definitions.
- AFConfigurationItemInt
- A configuration item that is an integer.
- AFConfigurationItemOption
- Superclass for various configuration items that offer a set of options.
- AFConfigurationItemOptionChoice
- Superclass for configuration definitions that offer a list of string values, for example 'debug', 'production', 'test'
- AFConfigurationItemString
- A configuration item that is a string value.
- AFConfigurationItemTrueFalse
- A configuration item that is a boolean value.
- AFCoreFileSourceTemplate
- Superclass for a source file template that is part of AFib's core (e.g. not for a project style)
- AFCoreSnippetSourceTemplate
- Superclass for a snippet of code which is inserted in a file, and is part of AFib's core (e.g. not from a project style)
-
AFDartParams<
AppState> - Application initialization parameters that do not depend on flutter.
- AFDialogID
- AFDocumentIDGenerator
- Utility for generating temporary ids for new objects.
- AFDrawerID
- AFDynamicSourceTemplate
- A source template in which the code is dynamically generated by other code.
- AFFileSourceTemplate
- Root class for source templates representing an entire file.
- AFFormFactorSize
- An attempt to create standardized sizes which can be used to differentiate rendering.
- AFFromStringTestID
- A test ID which can be constructed from a string.
- AFGenerateCommandSubcommand
- Superclass for generation subcommands.
- AFGeneratedFile
- A file that is in the process of being generated or modified.
- AFGenerateOverrideSubcommand
- The command which handles 'generate override'
- AFGenerateParentCommand
- The command that groups all the various 'generate' subcommands.
- AFGenerateQuerySubcommand
- The command that handles 'generate query...'
- AFGenerateStateSubcommand
- The class that handles 'generate state...'
- AFGenerateSubcommand
- The superclass for all the AFGenerateSubcommand variants.
- AFGenerateUISubcommand
- The class that handles 'generate ui...' commands.
- AFHelpCommand
- The command that handles 'help ...' commands.
- AFID
- AFIDWithTag
- AFItemWithNamespace
- AFLibraryID
- AFLibraryProgrammingInterfaceID
- AFMemberVariableTemplates
- Utility used to encapsulate handling of the --member-variables and --resolve-variables flags.
- AFPathSourceTemplate
- Superclass for source templates that have a path and id.
- AFProjectPaths
- AFProjectStyleSourceTemplate
- AFPrototypeID
- AFQueryID
- AFQueryTestID
- AFScreenID
- AFScreenTestID
- AFSnippetSourceTemplate
- A source template for a snippet of code which is inserted into a file.
- AFSourceTemplate
- A source of template source code.
- AFSourceTemplateID
- AFSourceTemplateInsertion
- Class for statically declared insertion points in source templates.
- AFSourceTemplateInsertions
- A mapping of AFSourceTemplateInsertion to values which should be inserted.
-
AFStandardIDMapRoot<
TSubclass, TModel> - The superclass used when --add-standard-root is specified on the command line.
- AFStatementID
- AFStateTestID
- AFThemeID
- AFTimeState
- AFib's built-in notion of time.
- AFTranslationID
- ID type which can be used to refer to translations specified in xxx_define_core.dart.
- AFUIControlSettings
- Summary of the generation logic used for various kinds of UI elements.
- AFUILibraryID
- AFUIPrototypeID
- AFUIQueryID
- AFUIScreenID
- AFUIScreenTestID
- AFUISourceTemplateID
- AFUIThemeID
- Identifiers for the fundamental theme
- AFUITranslationID
- AFUIWidgetID
- AFWidgetID
- AFWireframeID
- DeferredQueryT
- Anything that ends in "T" is a source template used in code generation.
- IsolateQueryT
- Any class that ends in "T" is a source template used in code generation.
- SimpleQueryT
- Any class that ends in "T" is a source template used in code generation.
Enums
- AFEnvironment
- Used in xxx_config.g.dart to specify the environment to run under.
- AFFormFactor
- You can override AFFunctionalTheme.deviceFormFactor to modify the meanings of these defintions.
- AFGeneratedFileAction
- AFOutputAlignment
- AFSourceTemplateRole
- AFTimeStateUpdateSpecificity
- Can be used to specify how frequently AFib pushes time updates into the state, and also to specify how frequently a specific UI element listens for those updates.
- AFTimeZone
- AFUIControlKind
- The types of UI elements that AFib supports.
Functions
-
afAppCommandMain(
{required AFArgs args, required AFDartParams paramsDart, required AFExtendBaseDelegate installBase, required AFExtendCommandsDelegate installCommand, required AFExtendBaseDelegate installBaseLibrary, required AFExtendCommandsLibraryDelegate installCommandLibrary}) → Future< void> - The function called from your bin/xxx_afib.dart file.
-
afBootstrapCommandMain(
AFDartParams paramsD, AFArgs args) → Future< void> - The function called from the afib_bootstrap command.
-
afCommandStartup(
Future< void> onRun()) → void - A wrapper which sets up AFib's global state for use in commands, prior to call the main AFib function.
-
afLibraryCommandMain(
{required AFDartParams paramsDart, required AFArgs args, required AFExtendBaseDelegate installBase, required AFExtendBaseDelegate installBaseLibrary, required AFExtendCommandsDelegate installCommand, required AFExtendCommandsLibraryDelegate installCommandLibrary}) → Future< void> - The main function called from the bin/xxx_afib.dart command of a library.
Exceptions / Errors
- AFCommandError
- If thrown within an AFib command, shows the usage for the command followed by the error message.
- AFException
- Thrown by AFib to indicate problems in runtime contexts.
- AFExceptionStopHere
- Used by AFib to stop a state test where it is.