credo

信条

CREDOは、教育とコードの一貫性に焦点を当てたElixir言語向けの静的コード分析ツールです。

コード、複雑なコードの断片のリファクタリングの機会を示すことができ、一般的な間違いについて警告し、命名スキームの矛盾を示し、必要に応じて目的のコーディングスタイルを実施するのに役立ちます。

インストールと使用

プロジェクトにCredoを追加する最も簡単な方法は、Mixを使用することです。

追加：プロジェクトのmix.exsへの依存関係としての:credo ：

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

と実行：

 $ mix deps.get

$ mix credo

ドキュメント

ドキュメントはhexdocsで入手できます

統合

IDE/エディター

一部のIDESおよび編集者は、バックグラウンドでCREDOを実行し、問題をインラインでマークすることができます。

• Intellij Elixir -JetBrains Ides用のElixirプラグイン（Intellij Idea、Rubymine、Phpstorm、Pycharmなど）
• Linter-Elixir-Credo-原子エディター用パッケージ（@smeevil by）
• Elixir Linter（credo） - vscode拡張機能（@pantajoeによる）
• FlyCheck -EMACS構文チェック拡張機能
• Kakoune -Kakoune Editorでのリントサポートの構成
• null -ls経由のneovim -Diagnostics Builtin

自動コードレビュー

• Codacy-スタイルからセキュリティ、複製、複雑さまでコードをチェックし、カバレッジと統合します。
• SourceleEvel-コードが時間の経過とともにどのように変化するかを追跡し、この情報をチーム全体でアクセスできるようにします。
• Stickler CI-スタック全体にわたってスタイルとベストプラクティスについてコードをチェックします。

貢献

1. フォーク！
2. 機能ブランチを作成します（ git checkout -b my-new-feature ）
3. あなたの変更をコミットします（ git commit -am 'Add some feature' ）
4. ブランチへのプッシュ（ git push origin my-new-feature ）
5. 新しいプルリクエストを作成します

著者

RenéFöhring（@rrrene）

ライセンス

CREDOはMITライセンスの下でリリースされます。詳細については、ライセンスファイルを参照してください。