SetupTemplate class

A Template for setting up the project with the documentation_builder CLI. This template is used to create the necessary files and configurations The Template is processed by the SetupCommand:

  • read from github.com
  • parsed and rendered by the CliTemplateEngine
  • stored in the project that is been setup.

Constructors

SetupTemplate.new({required Uri input, required File output})

Properties

hashCode → int
The hash code for this object.
no setterinherited
input → Uri
final
isTextFile → Future<bool>
no setter
output → File
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source ↔ String
Explains where the template text came from. A source results in a text. We use the source to identify and cash Templates for performance.
getter/setter pairinherited
sourceTitle ↔ String
Explains where the template text came from. It is used in Errors and can be shorter then source
getter/setter pairinherited
text ↔ Future<String>
The text to be parsed by the TemplateEngine
getter/setter pairinherited-setter

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
Assuming that the text is the same for the same source so we can cash the Templates for performance
inherited