Packages

localize

0.23.0
1.0.0-rc.5 1.0.0-rc.4 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.41.3 0.41.2 0.41.1 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.1 0.30.0 retired 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 0.1.0-alpha.1

Localization (parsing, formatting) of numbers, dates/time/calendar, units of measure, messages and lists. Includes localized collation.

HexDocs

Current section

Files

Jump to
Readme
58 Versions
4 Dependencies
Dependants
Files
Activity
localize lib localize message formatter ansi.ex
Raw

lib/localize/message/formatter/ansi.ex 

defmodule Localize.Message.Formatter.ANSI do

  @moduledoc """

  ANSI terminal formatter for MF2 highlight tokens.



  Wraps each token in ANSI colour escape codes suitable for IEx

  output, `mix` task messages, or anywhere a terminal is assumed.

  Colours are chosen for legibility on both light and dark

  backgrounds using ANSI 4-bit colours only (no truecolor).



  """



  alias Localize.Message.Highlighter



  @type options :: [palette: %{Highlighter.class() => [atom()]}]



  # Default palette: each class maps to a list of IO.ANSI sequences

  # (applied in order, then the text, then :reset).

  @default_palette %{

    text: [:default_color],

    string_escape: [:light_yellow],

    punctuation_bracket: [:cyan],

    variable: [:green],

    function: [:blue],

    keyword: [:magenta, :bright],

    tag: [:magenta],

    attribute: [:light_magenta],

    property: [:light_blue],

    string: [:yellow],

    number: [:light_red],

    constant_builtin: [:cyan, :bright]

  }



  @doc """

  Renders a token list as an ANSI-coloured string.



  ### Arguments



  * `tokens` is a list of `t:Highlighter.token/0` tuples.



  * `options` is a keyword list.



  ### Options



  * `:palette` — a map `%{class => [ansi_atom]}` overriding the

    default colour for specific classes.



  ### Returns



  * A string containing ANSI escape codes.



  """

  @spec render([Highlighter.token()], options()) :: String.t()

  def render(tokens, options \\ []) do

    palette = Map.merge(@default_palette, Keyword.get(options, :palette, %{}))



    tokens

    |> Enum.map(fn {class, text} ->

      codes = Map.get(palette, class, [])



      case codes do

        [] ->

          text



        codes ->

          # `IO.ANSI.format/2` with `emit? = true` forces the escape

          # sequences to be rendered even when STDOUT isn't a TTY.

          # Without this, ANSI codes would only appear in interactive

          # shells, making the output untestable and unpredictable.

          IO.ANSI.format(codes ++ [text, :reset], true)

      end

    end)

    |> IO.iodata_to_binary()

  end

end