Spec-Zone.ru › Elixir 1.11

Mix.Task.Compiler.Diagnostic

Информация о диагностике, например, предупреждение или ошибка компиляции.

Краткое описание

Типы

position()

Место в файле, к которому относится диагностика. Может быть либо номером строки, либо диапазоном, заданным как {start_line, start_col, end_line, end_col}, или nil в случае неизвестности.

severity()

Степень серьезности диагностики

t()

Типы

position()

Характеристики

position() ::
  nil
  | pos_integer()
  | {pos_integer(), non_neg_integer(), pos_integer(), non_neg_integer()}

Место в файле, к которому относится диагностика. Может быть либо номером строки, либо диапазоном, заданным как {start_line, start_col, end_line, end_col}, или nil в случае неизвестности.

Номера строк нумеруются с единицы, а номера столбцов в диапазоне нумеруются с нуля и относятся к позиции курсора в начале символа с этим индексом. Например, чтобы указать, что диагностика относится к первым n символам первой строки, диапазон будет {1, 0, 1, n}.

severity()

Характеристики

severity() :: :error | :warning | :information | :hint

Степень серьезности диагностики:

  • :error - проблема, которая привела к сбою компиляции

  • :warning - проблема, которая не привела к сбою, но предполагает, что программист мог допустить ошибку

  • :hint - рекомендация по стилю или хорошей практике, которая не так серьезна, как предупреждение

  • :information - любая другая информация, относящаяся к компиляции, которая не подходит под вышеперечисленные категории

t()

Характеристики

t() :: %Mix.Task.Compiler.Diagnostic{
  compiler_name: String.t(),
  details: any(),
  file: Path.t(),
  message: String.t(),
  position: position(),
  severity: severity()
}

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/mix/1.11.2/Mix.Task.Compiler.Diagnostic.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API