Valence.Strict (valence v1.0.0)

Copy Markdown View Source

Modo estrito de tipagem: o arquivo precisa declarar o contrato e o corpo precisa cumpri-lo.

As regras são:

  • todo def público (nem defp, nem defmacro) precisa de @spec;
  • o tipo inferido do corpo do def precisa unificar com o retorno do @spec;
  • os protocolos de case e de handlers continuam sendo checados por Valence.check_with_index/2.

A posição do diagnóstico é a do head do def (nome da função), não a do corpo: é ali que o contrato deveria estar declarado.

Summary

Functions

Checa source contra o índice de tipos já montado.

Types

diagnostic()

@type diagnostic() :: %{
  kind: atom(),
  line: pos_integer(),
  column: pos_integer(),
  message: String.t()
}

Functions

check(source, index)

@spec check(String.t(), Valence.index()) :: {:ok, [diagnostic()]}

Checa source contra o índice de tipos já montado.

Devolve sempre {:ok, diagnósticos}; erro de sintaxe é um diagnóstico, não uma exceção, porque o compilador de .val também usa esta função.