credo

Credo

CREDO ist ein statisches Tool für die Codeanalyse für die Elixiersprache mit Schwerpunkt auf Lehre und Codekonsistenz.

Es kann Ihnen zeigen, dass Sie Chancen in Ihrem Code, komplexen Codefragmente neu aufstellen, Sie vor gemeinsamen Fehlern warnen, Inkonsistenzen in Ihrem Namensschema zeigen und bei Bedarf einen gewünschten Codierungsstil durchsetzen können.

Installation und Verwendung

Der einfachste Weg, Ihrem Projekt Credo hinzuzufügen, ist die Verwendung von Mix.

Hinzufügen :credo als Abhängigkeit von mix.exs Ihres Projekts:

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

Und rennen:

 $ mix deps.get

$ mix credo

Dokumentation

Die Dokumentation ist auf Hexdocs verfügbar

Integrationen

IDE/Editor

Einige IDEs und Redakteure können Credo im Hintergrund ausführen und Probleme in der Inline -Probleme markieren.

• Intellij Elixir - Elixir -Plugin für Jetbrains -IDES (Intellij Idee, Rubymine, Phpstorm, Pycharm usw.)
• linter-elixir-credo-Paket für den ATOM-Editor (von @smeevil)
• Elixir Linter (CREDO) - VSCODE -Erweiterung (von @pantajoe)
• Flycheck - EMACS Syntax Checking -Erweiterung
• Kakoune - Konfiguration für die Stining -Unterstützung im Kakoune -Editor
• Neovim über NULL -LS - Diagnostik gebaut

Automatisierte Code -Überprüfung

• CODACY - Überprüft Ihren Code vom Stil über Sicherheit, Duplizierung, Komplexität und integriert sich auch in die Berichterstattung.
• Sourcelevel - Verfolgt, wie sich Ihr Code im Laufe der Zeit ändert und diese Informationen für Ihr gesamtes Team zugänglich sind.
• Stickler CI - Überprüft Ihren Code auf Stil und Best Practices in Ihrem gesamten Stapel.

Beitragen

1. Gabel es!
2. Erstellen Sie Ihre Funktionszweig ( git checkout -b my-new-feature ).
3. Bestimmen Sie Ihre Änderungen ( git commit -am 'Add some feature' )
4. Drücken Sie in den Zweig ( git push origin my-new-feature )
5. Erstellen Sie eine neue Pull -Anfrage

Autor

René Föhring (@rrrene)

Lizenz

Credo wird unter der MIT -Lizenz veröffentlicht. Weitere Informationen finden Sie in der Lizenzdatei.