credo

Credo

Credo es una herramienta de análisis de código estático para el lenguaje Elixir con un enfoque en la enseñanza y la consistencia del código.

Puede mostrarle oportunidades de refactorización en su código, fragmentos de código complejos, advertirle sobre errores comunes, mostrar inconsistencias en su esquema de nomenclatura y, si es necesario, ayudarlo a aplicar un estilo de codificación deseado.

Instalación y uso

La forma más fácil de agregar credo a su proyecto es mediante la mezcla.

ADD :credo como dependencia de mix.exs de su proyecto.

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

Y corre:

 $ mix deps.get

$ mix credo

Documentación

La documentación está disponible en hexdocs

Integración

IDE/Editor

Algunos IDES y editores pueden ejecutar Credo en segundo plano y marcar los problemas en línea.

• IntelliJ Elixir - Plugin de elixir para JetBrains IDES (Idea IntelliJ, Rubymine, Phpstorm, Pycharm, etc.)
• Linter-Elixir-Credo-Paquete para Atom Editor (por @SmeEvil)
• Elixir Live (Credo) - VScode Extension (por @pantaJoe)
• FlyCheck - Extensión de verificación de sintaxis de Emacs
• Kakoune - Configuración para el soporte de pelucas en el editor de Kakoune
• Neovim a través de NULL -LS - Diagnóstico Builtin

Revisión de código automatizado

• Codacy: verifica su código de estilo a seguridad, duplicación, complejidad y también se integra con la cobertura.
• SourCelevel: rastrea cómo cambia su código con el tiempo y tiene esta información accesible para todo su equipo.
• Stickler CI: verifica su código en busca de estilo y mejores prácticas en toda su pila.

Que contribuye

1. ¡Bifurca!
2. Crea tu rama de características ( git checkout -b my-new-feature )
3. Comprometer sus cambios ( git commit -am 'Add some feature' )
4. Empuje a la rama ( git push origin my-new-feature )
5. Crear nueva solicitud de extracción

Autor

René Föhring (@rrrrene)

Licencia

Credo se publica bajo la licencia MIT. Consulte el archivo de licencia para obtener más detalles.