EditorConfig.Parser (EditorConfig v0.1.0)

Parser for EditorConfig files.

Summary

Functions

parse(binary, opts \\ [])

Parses EditorConfig contents.

parse_with_warnings(binary, opts \\ [])

Parses EditorConfig contents and returns warnings for ignored invalid lines.

Functions

parse(binary, opts \\ [])

@spec parse(
  binary(),
  keyword()
) :: {:ok, EditorConfig.File.t()} | {:error, term()}

Parses EditorConfig contents.

Examples

iex> {:ok, file} = EditorConfig.Parser.parse("[*.ex]\nindent_size = 2\n")
iex> hd(file.sections).name
"*.ex"

parse_with_warnings(binary, opts \\ [])

@spec parse_with_warnings(
  binary(),
  keyword()
) :: {:ok, EditorConfig.File.t(), [map()]} | {:error, term()}

Parses EditorConfig contents and returns warnings for ignored invalid lines.

Examples

iex> {:ok, file, warnings} =
...>   EditorConfig.Parser.parse_with_warnings("[*]\ninvalid line\n")
iex> {length(file.sections), warnings}
{1, [%{line: 2, reason: :invalid_line, text: "invalid line"}]}