# `Valence`
[🔗](https://github.com/freitaseric/valence-lang/blob/v1.0.0/lib/valence.ex#L1)

Juízo de tipagem para Elixir: "qual o tipo desta expressão nesta posição" e
diagnóstico de protocolos não-exaustivos, com o tipo vindo de
`@spec`/`@type` e das superfícies tipadas de macro (`Valence.GenServer`,
`Valence.Schema`).

Ponto de entrada de biblioteca (o que um editor consulta):

    {:ok, tipo} = Valence.type_at(fonte, {linha, coluna}, deps)

Ponto de entrada de projeto (o que o CI roda):

    Valence.Checker.check_paths(["lib/**/*.ex"])

# `index`

```elixir
@type index() :: map()
```

Índice de tipos de um conjunto de fontes (módulos + structs).

# `check`

```elixir
@spec check(String.t(), [String.t()]) :: {:ok, [map()]}
```

Diagnósticos de exaustividade (`case` e handlers de GenServer) do módulo.

`deps` são fontes de outros módulos usados na inferência.

# `check_with_index`

```elixir
@spec check_with_index(String.t(), index()) :: {:ok, [map()]}
```

Como `check/2`, com o índice já montado.

# `declared_field_at`

```elixir
@spec declared_field_at(String.t(), {pos_integer(), pos_integer()}, index()) ::
  term() | nil
```

Tipo do campo declarado na linha de `pos` (`field`, `belongs_to`,
`has_one`, `has_many` de um schema Ecto ou `Valence.Schema`), ou `nil`.

Existe porque o AST do Elixir não carrega posição para átomo literal: em
`field :name, :string` o `:name` não tem span, então `type_at/3` responderia
o tipo sintático do bloco. Aqui a pergunta "qual o tipo deste campo?" tem
resposta de verdade.

# `index`

```elixir
@spec index([String.t()]) :: index()
```

Indexa fontes (módulos + structs declarados por macro).

# `type_at`

```elixir
@spec type_at(String.t(), {pos_integer(), pos_integer()}, [String.t()]) ::
  {:ok, term()} | {:error, atom()}
```

Tipo da expressão que contém `pos` (`{linha, coluna}`).

`deps` são fontes de outros módulos usados na inferência.

# `type_at_with_index`

```elixir
@spec type_at_with_index(String.t(), {pos_integer(), pos_integer()}, index()) ::
  {:ok, term()} | {:error, atom()}
```

Como `type_at/3`, com o índice já montado (evita reindexar).

---

*Consult [api-reference.md](api-reference.md) for complete listing*
