FileTask class abstract interface

A task that is run multiple times, once for every matching file.

For this task, all staged files are filtered based on canProcess and then each file is processed via call.

Use this kind of task in case your task does something atomically on a per file basis, like formatting a file or checking file permissions. If the task needs other files, like linting, which pulls in other files and thus is not atomic, do not use this kind of task, use RepoTask instead.

Please note that tasks are executed on a per-file basis, meaning if there are multiple tasks that can process a file, all are called on the file in the same order they have been added to Hooks. Only then will the next file be processed in the same manner. All FileTasks are always run before any RepoTask.

Inheritance

Constructors

FileTask()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
taskName String
Returns the user-visible name of the task.
no setterinherited

Methods

call(RepoEntry entry) Future<TaskResult>
Executes the task on the given entry.
canProcess(RepoEntry entry) bool
Checks if a RepoEntry can be processed by this task.
inherited
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