credo

Credo

O CREDO é uma ferramenta de análise de código estático para o idioma Elixir, com foco no ensino e consistência do código.

Ele pode mostrar que você refatorava as oportunidades em seu código, fragmentos de código complexos, avisando sobre erros comuns, mostrar inconsistências em seu esquema de nomeação e - se necessário - ajudá -lo a aplicar um estilo de codificação desejado.

Instalação e uso

A maneira mais fácil de adicionar credo ao seu projeto é usando o mix.

Adicionar :credo como uma dependência do mix.exs do seu projeto:

 defp deps do
  [
    { :credo , "~> 1.7" , only: [ :dev , :test ] , runtime: false }
  ]
end

E correr:

 $ mix deps.get

$ mix credo

Documentação

A documentação está disponível em hexdocs

Integrações

IDE/editor

Alguns IDEs e editores são capazes de executar credo em segundo plano e marcar problemas em linha.

• Intellij Elixir - Elixir Plugin para Jetbrains Ides (Intellij Idea, Rubymine, Phpstorm, Pyharm, etc)
• Linter-Elixir-Credo-Pacote para Editor de Atom (por @smeevil)
• Elixir Linter (Credo) - Extensão do VSCode (por @Pantajoe)
• flycheck - Extensão de verificação de sintaxe emacs
• Kakoune - Config para suporte de linha no editor de Kakoune
• Neovim via null -ls - diagnóstico construído

Revisão de código automatizado

• Codacy - verifica seu código de estilo a segurança, duplicação, complexidade e também se integra à cobertura.
• Sourcelevel - rastreia como seu código muda com o tempo e tem essas informações acessíveis a toda a sua equipe.
• Stickler CI - verifica seu código quanto ao estilo e práticas recomendadas em toda a pilha.

Contribuindo

1. Fork!
2. Crie sua filial de recursos ( git checkout -b my-new-feature )
3. Comprometa suas alterações ( git commit -am 'Add some feature' )
4. Empurre para o ramo ( git push origin my-new-feature )
5. Crie um novo pedido de tração

Autor

René Föhring (@rrrene)

Licença

O CREDO é liberado sob a licença do MIT. Consulte o arquivo de licença para obter mais detalhes.