cortex v0.6.0 Cortex.Controller.Stage behaviour View Source

Behaviour for stages that run when files change.

Link to this section Summary

The type of the results to all stage commands

Returns a boolean for whether or not an error should cancel the rest of the pipeline.

Invoked any time a file is changed by the file watcher.

Run this stage on all possible files

result() :: :ok | {:error, any()}

The type of the results to all stage commands

cancel_on_error?() :: boolean()

Returns a boolean for whether or not an error should cancel the rest of the pipeline.

file_changed(atom(), Path.t(), Cortex.Controller.focus()) :: result()

Invoked any time a file is changed by the file watcher.

The first argument is the type of the file (:lib, :test, or :unknown), and the second is the path of the file.

run_all() :: result()

Run this stage on all possible files