View Source examples-styler-ex
Use Styler on elixir code examples in your docs!
usage
Usage
Examples Styler
relies on adobe/elixir-styler,
and acts as an extension to bring the same styling rules to your docs!
Add the following plugins
value to your .formatter.exs
file:
[
plugins: [Styler.Examples.MultiPlugin],
inputs: ...
]
There is no need to add Styler
itself. By default, mix format
will only run one
plugin per file; Styler.MultiPlugin
handles running both Styler
and
Styler.Examples
on .exs
and .ex
files.
It will also run Styler.Examples
.md
and .cheatmd
files.
approach-and-limitations
Approach and Limitations
This package is still in very early development, and as such, make sure that you do not run it on any code that is not backed up.
THe current approach is to simply find any contiguous lines that start with iex>
via
regex and styling those, ignoring considerations of context, such as code blocks or
@doc
attributes.
This approach may catch things like multi-line strings that start with iex>
, such as
appear in the tests for this module! As a starting approach, we feel that this should be
fine for the vast majority of projects, however, if it does happen to cause issues for
your particular code, please open a ticket with steps to re-create the issue and we'll
take a look!
installation
Installation
If available in Hex, the package can be installed
by adding examples_styler
to your list of dependencies in mix.exs
:
def deps do
[
{:examples_styler, "~> 0.1", only: [:dev, :test], runtime: false}
]
end