Packages

earmark

1.4.38
1.5.0-pre1 retired 1.5.0-pre retired 1.4.49 retired 1.4.48 retired 1.4.47 retired 1.4.46 retired 1.4.45 retired 1.4.44 retired 1.4.43 retired 1.4.42 retired 1.4.41 retired 1.4.40 retired 1.4.39 retired 1.4.38 retired 1.4.37 retired 1.4.36 retired 1.4.35 retired 1.4.34 retired 1.4.33 retired 1.4.32 retired 1.4.31 retired 1.4.30 retired 1.4.29 retired 1.4.28 retired 1.4.27 retired 1.4.26 retired 1.4.25 retired 1.4.24 retired 1.4.23 retired 1.4.22 retired 1.4.21 retired 1.4.20 retired 1.4.19 retired 1.4.18 retired 1.4.17 retired 1.4.16 retired 1.4.16-pre2 retired 1.4.16-pre1 retired 1.4.16-pre retired 1.4.15 retired 1.4.14 retired 1.4.13 retired 1.4.12 retired 1.4.10 retired 1.4.9 retired 1.4.8 retired 1.4.7 retired 1.4.6 retired 1.4.5 retired 1.4.4 retired 1.4.3 retired 1.4.2 retired 1.4.1 retired 1.4.0 retired 1.3.6 retired 1.3.5 retired 1.3.4 retired 1.3.3 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.6 retired 1.2.5 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.1 retired 1.1.0 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired 0.2.1 retired 0.2.0 retired 0.1.19 retired 0.1.18 retired 0.1.17 retired 0.1.16 retired 0.1.15 retired 0.1.14 retired 0.1.13 retired 0.1.12 retired 0.1.10 retired 0.1.9 retired 0.1.8 retired 0.1.7 retired 0.1.6 retired 0.1.5 retired 0.1.4 retired 0.1.3 retired 0.1.2 retired 0.1.1 retired 0.1.0 retired

Earmark is a pure-Elixir Markdown converter. It is intended to be used as a library (just call Earmark.as_html), but can also be used as a command-line tool (run mix escript.build first). Output generation is pluggable.

Retired package: Deprecated - Earmark is no longer maintained. Migrate to a replacement, for example MDEx (https://hex.pm/packages/mdex).
Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
95 Versions
1 Dependency
114 Dependants
1 Advisory
Files
Activity
earmark lib earmark cli implementation.ex
Raw

lib/earmark/cli/implementation.ex 

defmodule Earmark.Cli.Implementation do

  alias Earmark.Options

  alias Earmark.SysInterface



  @moduledoc """

  Functional (with the exception of reading input files with `Earmark.File`) interface to the CLI

  returning the device and the string to be output.

  """



  @doc ~S"""

  allows functional access to the CLI API, does everything `Earmark.Cli.main` does without outputting the result



  Returns a tuple of the device to write to (`:stdio|:stderr`) and the content to be written



  Example: Bad file



  iex(0)> run(["no-such--file--ayK7k"])

  {:stderr, "Cannot open no-such--file--ayK7k, reason: enoent"}



  Example: Good file



  iex(1)> {:stdio, html} = run(["test/fixtures/short1.md"])

  ...(1)> html

  "<h1>\nHeadline1</h1>\n<hr class=\"thin\">\n<h2>\nHeadline2</h2>\n"



  Example: Using EEx



  iex(2)> {:stdio, html} = run(["--eex", "--gfm", "--code-class-prefix", "alpha", "--timeout", "12000", "test/fixtures/short2.md.eex"])

  ...(2)> html

  "<h1>\nShort2</h1>\n<p>\n<em>Short3</em></p>\n<!-- SPDX-License-Identifier: Apache-2.0 -->\n"





  Example: Using an EEx template first



  iex(3)> run(["--template", "test/fixtures/eex_first.html.eex"])

  {:stdio, "<html>\n  <h1>\nShort2</h1>\n<p>\n<em>Short3</em></p>\n<!-- SPDX-License-Identifier: Apache-2.0 -->\n\n</html>\n"}



  """



  def run(argv) do

    argv

    |> _parse_args()

    |> _process()

  end



  @args """

  usage:



  earmark --help

  earmark --version

  earmark [ options... <file> ]



  convert file from Markdown to HTML.



  where options can be any of:

  --breaks

  --code-class-prefix <a prefix>

  --eex

  --escape

  --gfm

  --smartypants

  --pedantic

  --pure-links

  --breaks

  --template

  --timeout <timeout in ms>

  --wikilinks



  """



  @cli_options ~W[

    breaks

    code_class_prefix

    eex escape

    gfm

    pedantic pure_links

    smartypants

    template timeout

    wikilinks

  ]



  defp _parse_args(argv) do

    switches = [

      breaks: :boolean,

      code_class_prefix: :string,

      eex: :boolean,

      escape: :boolean,

      gfm: :boolean,

      help: :boolean,

      inner_html: :boolean,

      pedantic: :boolean,

      pure_links: :boolean,

      template: :boolean,

      timeout: :integer,

      version: :boolean,

      wikiklinks: :boolean

    ]



    aliases = [

      h: :help,

      v: :version

    ]



    case OptionParser.parse(argv, strict: switches, aliases: aliases) do

      {_, _, [_ | _] = errors} -> errors

      {[{:help, true}], _, _} -> :help

      {[{:version, true}], _, _} -> :version

      {options, [file], _} -> Map.put(Options.make_options!(options), :file, file)

      {options, [], _} -> Options.make_options!(options)

    end

  end



  defp _format_errors(errors) do

    "Illegal options #{errors |> Enum.map(fn {option, _} -> option end) |> Enum.join(", ")}"

  end



  defp _maybe_to_html!(output, %{file: nil}), do: Earmark.Internal.as_html!(output)



  defp _maybe_to_html!(output, options) do

    filename = options.file



    case Path.extname(Path.basename(filename, Path.extname(filename))) do

      ".html" -> output

      _ -> Earmark.Internal.as_html!(output, options)

    end

  end



  defp _process(flag_errors_or_options)



  defp _process(errors) when is_list(errors) do

    {:stderr, _format_errors(errors)}

  end



  defp _process(:help) do

    {:stderr, IO.chardata_to_string([@args, _option_related_help()])}

  end



  defp _process(:version) do

    {:stdio, Earmark.version()}

  end



  defp _process(%Options{file: nil} = options), do: _process_input({:ok, :stdio}, options)



  defp _process(%Options{file: filename} = options) do

    {device_tuple, options_} = _open_file(filename, options)

    _process_input(device_tuple, options_)

  end



  defp _process_input(device_tuple, options)



  defp _process_input({:error, reason}, options) do

    {:stderr, "Cannot open #{options.file}, reason: #{reason}"}

  end



  defp _process_input({:ok, io_device}, %Options{eex: true} = options) do

    input = SysInterface.readlines(io_device) |> Enum.to_list() |> IO.chardata_to_string()

    output = EEx.eval_string(input, include: &Earmark.Internal.include(&1, options))

    output_ = _maybe_to_html!(output, options)

    {:stdio, output_}

  end



  defp _process_input({:ok, io_device}, options) do

    content =

      io_device

      |> SysInterface.readlines()

      |> Enum.to_list()



    {:stdio, Earmark.as_html!(content, options)}

  end



  defp _open_file(filename, options) do

    case Path.extname(filename) do

      ".eex" -> {File.open(filename, [:utf8]), %{options | eex: true}}

      _ -> {File.open(filename, [:utf8]), options}

    end

  end



  defp _option_related_help do

    @cli_options

    |> Enum.map(&_specific_option_help/1)

    |> Enum.join("\n")

  end



  defp _specific_option_help(option) do

    "      --#{_unixize_option(option)} defaults to #{inspect(Map.get(%Earmark.Options{}, option))}"

  end



  defp _unixize_option(option) do

    "#{option}"

    |> String.replace("_", "-")

  end

end



# SPDX-License-Identifier: Apache-2.0