Packages

rewrite

1.1.1
1.3.0 1.2.0 1.1.2 1.1.1 1.1.0 1.0.1 1.0.0 0.10.5 0.10.4 0.10.3 0.10.2 0.10.1 0.10.0 0.9.1 0.9.0 0.8.0 0.7.1 0.7.0 0.7.0-rc.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.2 0.4.1 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0

An API for rewriting sources in an Elixir project. Powered by sourceror.

HexDocs

Current section

Files

Jump to
Readme
31 Versions
3 Dependencies
Dependants
Files
Activity
rewrite lib rewrite hook.ex
Raw

lib/rewrite/hook.ex 

defmodule Rewrite.Hook do

  @moduledoc """

  A `behaviour` for hooking into the `Rewrite` processes.



  The callback `c:handle/2` is called by `Rewrite` with an `t:action/0` and the 

  current `%Rewrite{}`. The return value is either `:ok` or `{:ok, rewrite}`.



  > #### Warning {: .warning}

  > If the `%Rewrite{}` project is updated inside the hook, the hook will be 

  > called again.



  ## Actions



    * `:new` - invoked when a new `%Rewrite{}` is created.



    * `{:added, paths}` - invoked when new sources were added. `paths` is the a 

      list of `t:Path.t()`.



    * `{:updated, path}` - invoked when a source was updated. `path` contains 

      the path of the updated source. Also called when a source was succesfull 

      formatted.



  """



  @type action :: atom() | {atom(), Path.t() | [Path.t()]}



  @callback handle(action(), rewrite :: Rewrite.t()) :: :ok | {:ok, Rewrite.t()}

end