ModuleDefinition class

Defines the complete configuration and metadata of an FKIT module.

Constructors

ModuleDefinition({required String name, required String displayName, required String description, required String version, required List<ModuleFile> files, required ModuleRequirements requirements, required Map<String, ModuleOption> options, required ModuleIntegration integration})
Creates a module definition.
const
ModuleDefinition.fromMap(Map map)
Creates a module definition from the provided map.
factory

Properties

description String
A description of the module and its purpose.
final
displayName String
The human-readable name of the module.
final
files List<ModuleFile>
The files generated by the module.
final
hasDevPackages bool
Whether the module defines development package dependencies.
no setter
hashCode int
The hash code for this object.
no setterinherited
hasOptions bool
Whether the module provides configurable options.
no setter
hasPackages bool
Whether the module defines runtime package dependencies.
no setter
integration ModuleIntegration
The project integration configuration of the module.
final
name String
The unique name of the module.
final
options Map<String, ModuleOption>
The configurable options supported by the module.
final
requirements ModuleRequirements
The package and code-generation requirements of the module.
final
requiresBuildRunner bool
Whether the module requires build runner execution.
no setter
requiresFlutterGen bool
Whether the module requires Flutter code generation.
no setter
requiresIntegration bool
Whether the module requires project integration.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
version String
The version of the module.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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