Serum.Plugin behaviour (serum v1.5.1) View Source

A behaviour that all Serum plugin module must implement.

This module allows experienced Serum users and developers to make their own Serum plugins which can extend the functionality of Serum.

A Serum plugin can...

Alter contents of input or output files,
Execute arbitrary codes during some stages of site building,
And optionally provide extra Mix tasks that extends Serum.

For Plugin Developers

In order for a Serum plugin to work, you must implement at least these four callbacks:

name/0
version/0
elixir/0
serum/0
description/0
implements/0

Also there are a number of other callbacks you can optionally implement. Read the rest of the documentation for this module to see which callbacks you can implement and what each callback should do.

For Plugin Users

To enable Serum plugins, add a plugins key to your serum.exs(if it does not exist), and put names of Serum plugin modules there.

%{
  plugins: [
    Awesome.Serum.Plugin,
    Great.Serum.Plugin
  ]
}

You can also restrict some plugins to run only in specific Mix environments. For example, if plugins are configured like the code below, only Awesome.Serum.Plugin plugin will be loaded when MIX_ENV is set to prod.

%{
  plugins: [
    Awesome.Serum.Plugin,
    {Great.Serum.Plugin, only: :dev},
    {Another.Serum.Plugin, only: [:dev, :test]}
  ]
}

The order of plugins is important, as Serum will call plugins one by one, from the first item to the last one. Therefore these two configurations below may produce different results.

Configuration 1:

%{
  plugins: [
    Awesome.Serum.Plugin,
    Another.Serum.Plugin
  ]
}

Configuration 2:

%{
  plugins: [
    Another.Serum.Plugin,
    Awesome.Serum.Plugin
  ]
}

Link to this section Summary

Types

plugin_options()

spec()

t()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

Callbacks

build_failed(src, dest, result)

Called if the build process has failed for some reason.

build_failed(src, dest, result, args)

build_started(src, dest)

Called right after the build process has started. Some necessary OTP applications or processes should be started here.

build_started(src, dest, args)

build_succeeded(src, dest)

Called if the whole build process has finished successfully.

build_succeeded(src, dest, args)

description()

Returns the short description of the plugin.

elixir()

Returns the version requirement of Elixir.

finalizing(src, dest)

Called right before Serum exits, whether the build has succeeded or not.

finalizing(src, dest, args)

implements()

Returns a list of optional callbacks which the plugin implements.

name()

Returns the name of the plugin.

processed_list(list)

Called after Serum has processed each input file and produced the resulting struct.

processed_list(list, args)

processed_page(page)

Called after Serum has processed each input file and produced the resulting struct.

processed_page(page, args)

processed_pages(pages)

Called after Serum has successfully processed all pages.

processed_pages(pages, args)

processed_post(post)

Called after Serum has processed each input file and produced the resulting struct.

processed_post(post, args)

processed_posts(posts)

Called after Serum has successfully processed all blog posts.

processed_posts(posts, args)

processed_template(template)

Called after Serum has processed each input file and produced the resulting struct.

processed_template(template, args)

processing_page(file)

Called before Serum processes each input file.

processing_page(file, args)

processing_post(file)

Called before Serum processes each input file.

processing_post(file, args)

processing_template(file)

Called before Serum processes each input file.

processing_template(file, args)

reading_pages(files)

Called before reading input files.

reading_pages(files, args)

reading_posts(files)

Called before reading input files.

reading_posts(files, args)

reading_templates(files)

Called before reading input files.

reading_templates(files, args)

rendered_fragment(frag)

Called after producing a HTML fragment for each page.

rendered_fragment(frag, args)

rendered_page(file)

Called when Serum has rendered a full page and it's about to write to an output file.

rendered_page(file, args)

rendering_fragment(html, metadata)

Called while each fragment is being constructed.

rendering_fragment(html, metadata, args)

serum()

Returns the version requirement of Serum.

version()

Returns the version of the plugin.

wrote_file(file)

Called after writing each output to a file.

wrote_file(file, args)

Link to this section Types

plugin_options()

Specs

plugin_options() :: [only: atom() | [atom()], args: term()]

spec()

Specs

spec() :: atom() | {atom(), plugin_options()}

t()

Specs

t() :: %Serum.Plugin{
  args: term(),
  description: binary(),
  implements: [atom()],
  module: atom(),
  name: binary(),
  version: binary()
}

Link to this section Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this section Callbacks

build_failed(src, dest, result)

(optional)

Specs

build_failed(
  src :: binary(),
  dest :: binary(),
  result :: Serum.Result.t() | Serum.Result.t(term())
) :: Serum.Result.t()

Called if the build process has failed for some reason.

build_failed(src, dest, result, args)

(optional)

Specs

build_failed(
  src :: binary(),
  dest :: binary(),
  result :: Serum.Result.t() | Serum.Result.t(term()),
  args :: term()
) :: Serum.Result.t()

build_started(src, dest)

(optional)

Specs

build_started(src :: binary(), dest :: binary()) :: Serum.Result.t()

Called right after the build process has started. Some necessary OTP applications or processes should be started here.

build_started(src, dest, args)

(optional)

Specs

build_started(src :: binary(), dest :: binary(), args :: term()) ::
  Serum.Result.t()

build_succeeded(src, dest)

(optional)

Specs

build_succeeded(src :: binary(), dest :: binary()) :: Serum.Result.t()

Called if the whole build process has finished successfully.

build_succeeded(src, dest, args)

(optional)

Specs

build_succeeded(src :: binary(), dest :: binary(), args :: term()) ::
  Serum.Result.t()

description()

Specs

description() :: binary()

Returns the short description of the plugin.

You must implement this callback, or the plugin may fail.

elixir()

Specs

elixir() :: binary()

Returns the version requirement of Elixir.

Refer to this document for the string format.

You must implement this callback, or the plugin may fail.

finalizing(src, dest)

(optional)

Specs

finalizing(src :: binary(), dest :: binary()) :: Serum.Result.t()

Called right before Serum exits, whether the build has succeeded or not.

This is the place where you should clean up any temporary resources created in build_started/2 callback.

finalizing(src, dest, args)

(optional)

Specs

finalizing(src :: binary(), dest :: binary(), args :: term()) ::
  Serum.Result.t()

implements()

Specs

implements() :: [atom() | {atom(), integer()}]

Returns a list of optional callbacks which the plugin implements.

Each list item can be in one of two forms:

{callback_name, arity}
callback_name - This is deprecated and left for compatibility. New Serum plugins must use the above format.

For example, if your plugin implements build_started/2 and finalizing/2, you must implement this callback so that it returns [build_started: 2, finalizing: 2].

You must implement this callback, or the plugin may fail.

name()

Specs

name() :: binary()

Returns the name of the plugin.

You must implement this callback, or the plugin may fail.

processed_list(list)

(optional)

Specs

processed_list(list :: Serum.PostList.t()) :: Serum.Result.t(Serum.PostList.t())

Called after Serum has processed each input file and produced the resulting struct.

Plugins can alter the processed contents and metadata here.

processed_list(list, args)

(optional)

Specs

processed_list(list :: Serum.PostList.t(), args :: term()) ::
  Serum.Result.t(Serum.PostList.t())

processed_page(page)

(optional)

Specs

processed_page(page :: Serum.Page.t()) :: Serum.Result.t(Serum.Page.t())

Called after Serum has processed each input file and produced the resulting struct.

Plugins can alter the processed contents and metadata here.

processed_page(page, args)

(optional)

Specs

processed_page(page :: Serum.Page.t(), args :: term()) ::
  Serum.Result.t(Serum.Page.t())

processed_pages(pages)

(optional)

Specs

processed_pages(pages :: [Serum.Page.t()]) :: Serum.Result.t([Serum.Page.t()])

Called after Serum has successfully processed all pages.

processed_pages(pages, args)

(optional)

Specs

processed_pages(pages :: [Serum.Page.t()], args :: term()) ::
  Serum.Result.t([Serum.Page.t()])

processed_post(post)

(optional)

Specs

processed_post(post :: Serum.Post.t()) :: Serum.Result.t(Serum.Post.t())

Called after Serum has processed each input file and produced the resulting struct.

Plugins can alter the processed contents and metadata here.

processed_post(post, args)

(optional)

Specs

processed_post(post :: Serum.Post.t(), args :: term()) ::
  Serum.Result.t(Serum.Post.t())

processed_posts(posts)

(optional)

Specs

processed_posts(posts :: [Serum.Post.t()]) :: Serum.Result.t([Serum.Post.t()])

Called after Serum has successfully processed all blog posts.

processed_posts(posts, args)

(optional)

Specs

processed_posts(posts :: [Serum.Post.t()], args :: term()) ::
  Serum.Result.t([Serum.Post.t()])

processed_template(template)

(optional)

Specs

processed_template(template :: Serum.Template.t()) ::
  Serum.Result.t(Serum.Template.t())

Called after Serum has processed each input file and produced the resulting struct.

Plugins can alter the AST and its metadata here.

processed_template(template, args)

(optional)

Specs

processed_template(template :: Serum.Template.t(), args :: term()) ::
  Serum.Result.t(Serum.Template.t())

processing_page(file)

(optional)

Specs

processing_page(file :: Serum.File.t()) :: Serum.Result.t(Serum.File.t())

Called before Serum processes each input file.

Plugins can alter the raw contents of input files here.

processing_page(file, args)

(optional)

Specs

processing_page(file :: Serum.File.t(), args :: term()) ::
  Serum.Result.t(Serum.File.t())

processing_post(file)

(optional)

Specs

processing_post(file :: Serum.File.t()) :: Serum.Result.t(Serum.File.t())

Called before Serum processes each input file.

Plugins can alter the raw contents of input files here.

processing_post(file, args)

(optional)

Specs

processing_post(file :: Serum.File.t(), args :: term()) ::
  Serum.Result.t(Serum.File.t())

processing_template(file)

(optional)

Specs

processing_template(file :: Serum.File.t()) :: Serum.Result.t(Serum.File.t())

Called before Serum processes each input file.

Plugins can alter the raw contents of input files here.

processing_template(file, args)

(optional)

Specs

processing_template(file :: Serum.File.t(), args :: term()) ::
  Serum.Result.t(Serum.File.t())

reading_pages(files)

(optional)

Specs

reading_pages(files :: [binary()]) :: Serum.Result.t([binary()])

Called before reading input files.

Plugins can manipulate the list of files to be read and pass it to the next plugin.

reading_pages(files, args)

(optional)

Specs

reading_pages(files :: [binary()], args :: term()) :: Serum.Result.t([binary()])

reading_posts(files)

(optional)

Specs

reading_posts(files :: [binary()]) :: Serum.Result.t([binary()])

Called before reading input files.

Plugins can manipulate the list of files to be read and pass it to the next plugin.

reading_posts(files, args)

(optional)

Specs

reading_posts(files :: [binary()], args :: term()) :: Serum.Result.t([binary()])

reading_templates(files)

(optional)

Specs

reading_templates(files :: [binary()]) :: Serum.Result.t([binary()])

Called before reading input files.

Plugins can manipulate the list of files to be read and pass it to the next plugin.

reading_templates(files, args)

(optional)

Specs

reading_templates(files :: [binary()], args :: term()) ::
  Serum.Result.t([binary()])

rendered_fragment(frag)

(optional)

Specs

rendered_fragment(frag :: Serum.Fragment.t()) ::
  Serum.Result.t(Serum.Fragment.t())

Called after producing a HTML fragment for each page.

Plugins can modify the contents and metadata of each fragment here.

rendered_fragment(frag, args)

(optional)

Specs

rendered_fragment(frag :: Serum.Fragment.t(), args :: term()) ::
  Serum.Result.t(Serum.Fragment.t())

rendered_page(file)

(optional)

Specs

rendered_page(file :: Serum.File.t()) :: Serum.Result.t(Serum.File.t())

Called when Serum has rendered a full page and it's about to write to an output file.

Plugins can alter the raw contents of the page to be written.

rendered_page(file, args)

(optional)

Specs

rendered_page(file :: Serum.File.t(), args :: term()) ::
  Serum.Result.t(Serum.File.t())

rendering_fragment(html, metadata)

(optional)

Specs

rendering_fragment(html :: Floki.html_tree(), metadata :: map()) ::
  Serum.Result.t(Floki.html_tree())

Called while each fragment is being constructed.

Plugins can alter the HTML tree of its contents (which is generated by Floki). It is recommended to implement this callback if you want to modify the HTML document without worrying about breaking it.

rendering_fragment(html, metadata, args)

(optional)

Specs

rendering_fragment(html :: Floki.html_tree(), metadata :: map(), args :: term()) ::
  Serum.Result.t(Floki.html_tree())

serum()

Specs

serum() :: binary()

Returns the version requirement of Serum.

Refer to this document for the string format.

You must implement this callback, or the plugin may fail.

version()

Specs

version() :: binary()

Returns the version of the plugin.

The returned version string must follow the semantic versioning scheme.

You must implement this callback, or the plugin may fail.

wrote_file(file)

(optional)

Specs

wrote_file(file :: Serum.File.t()) :: Serum.Result.t()

Called after writing each output to a file.

wrote_file(file, args)

(optional)

Specs

wrote_file(file :: Serum.File.t(), args :: term()) :: Serum.Result.t()