View Source Recode.Task behaviour (Recode v0.7.2)

The behaviour for a recode task.

Summary

Types

category()
config()
message()
task()

Callbacks

__attributes__()
init(config)

Sets a callback to check and manipulate config before any recode task runs.

run(source, opts)

Applies a task with the given source and opts.

Functions

category(task)

Returns the category for the given task.

checker?(task)

Returns true if the given task provides a check for sources.

corrector?(task)

Returns true if the given task provides a correction functionality for sources.

shortdoc(task)

Returns the shortdoc for the given task.

Types

Link to this type

category()

View Source 
@type category() :: atom()
Link to this type

config()

View Source 
@type config() :: keyword()
Link to this type

message()

View Source 
@type message() :: String.t()
Link to this type

task()

View Source 
@type task() :: module()

Callbacks

Link to this callback

__attributes__()

View Source 
@callback __attributes__() :: any()
Link to this callback

init(config)

View Source (optional) 
@callback init(config()) :: {:ok, config()} | {:error, message()}

Sets a callback to check and manipulate config before any recode task runs.

When init returns an error tuple, the mix recode task raises an exception with the returned message.

Link to this callback

run(source, opts)

View Source 
@callback run(source :: Rewrite.Source.t(), opts :: Keyword.t()) :: Rewrite.Source.t()

Applies a task with the given source and opts.

Functions

Link to this function

category(task)

View Source 
@spec category(task()) :: category()

Returns the category for the given task.

Link to this function

checker?(task)

View Source 
@spec checker?(task()) :: boolean()

Returns true if the given task provides a check for sources.

Link to this function

corrector?(task)

View Source 
@spec corrector?(task()) :: boolean()

Returns true if the given task provides a correction functionality for sources.

Link to this function

shortdoc(task)

View Source 
@spec shortdoc(task()) :: String.t() | nil

Returns the shortdoc for the given task.

Returns nil if @shortdoc is not available for the task.