View Source Rewrite.Filetype behaviour (rewrite v0.10.5)

The behaviour for filetypes.

An implementation of the filetype behaviour extends a source. For an example, see Rewrite.Source.Ex.

Summary

Types

extension()

key()

opts()

t()

updates()

value()

Callbacks

extensions()

Returns a list of file type extensions for which the module is responsible.

fetch(source, key)

Fetches the value for a specific key for the given source.

fetch(source, key, version)

Fetches the value for a specific key in a source for the given version.

from_string(string)

Returns a Rewrite.Source with a filetype from the given string.

from_string(string, path)

Returns a Rewrite.Source with a filetype from the given string and path.

from_string(strong, path, options)

Returns a Rewrite.Source with a filetype form the given, string and options.

handle_update(source, key)

This function is called when the content or path of the source is updated.

handle_update(source, key, value)

This function is called when the source is updated by a key that is handled by the current filetype.

read!(path)

Returns a Rewrite.Source with a filetype from a file.

read!(path, options)

Returns a Rewrite.Source with a filetype from a file.

undo(source)

This function is called after an undo of the source.

Types

extension()

@type extension() :: String.t()

key()

@type key() :: atom()

opts()

@type opts() :: keyword()

t()

@type t() :: map()

updates()

@type updates() :: keyword()

value()

@type value() :: any()

Callbacks

extensions()

@callback extensions() :: [extension()] | :any

Returns a list of file type extensions for which the module is responsible.

fetch(source, key)

@callback fetch(source :: Rewrite.Source.t(), key :: key()) :: value()

Fetches the value for a specific key for the given source.

If source contains the given key then its value is returned in the shape of {:ok, value}. If source doesn't contain key, :error is returned.

fetch(source, key, version)

@callback fetch(
  source :: Rewrite.Source.t(),
  key :: key(),
  version :: Rewrite.Source.version()
) :: value()

Fetches the value for a specific key in a source for the given version.

If source contains the given key then its value is returned in the shape of {:ok, value}. If source doesn't contain key, :error is returned.

from_string(string)

@callback from_string(string :: Rewrite.Source.content()) :: Rewrite.Source.t()

Returns a Rewrite.Source with a filetype from the given string.

from_string(string, path)

@callback from_string(string :: Rewrite.Source.content(), path :: Path.t() | nil) ::
  Rewrite.Source.t()

Returns a Rewrite.Source with a filetype from the given string and path.

from_string(strong, path, options)

@callback from_string(
  strong :: Rewrite.Source.content(),
  path :: Path.t() | nil,
  options :: opts()
) ::
  Rewrite.Source.t()

Returns a Rewrite.Source with a filetype form the given, string and options.

handle_update(source, key)

@callback handle_update(source :: Rewrite.Source.t(), key :: key()) :: t()

This function is called when the content or path of the source is updated.

Returns a %Source{} with an updated filetype.

handle_update(source, key, value)

@callback handle_update(source :: Rewrite.Source.t(), key :: key(), value :: value()) ::
  updates()

This function is called when the source is updated by a key that is handled by the current filetype.

Returns a keyword with the keys :content and :filetype to update the source.

read!(path)

@callback read!(path :: Path.t()) :: Rewrite.Source.t()

Returns a Rewrite.Source with a filetype from a file.

read!(path, options)

@callback read!(path :: Path.t(), options :: opts()) :: Rewrite.Source.t()

Returns a Rewrite.Source with a filetype from a file.

undo(source)

@callback undo(source :: Rewrite.Source.t()) :: Rewrite.Source.t()

This function is called after an undo of the source.