credo

信条

Credo是精灵语言的静态代码分析工具，重点是教学和代码一致性。

它可以向您显示代码中的重构机会，复杂的代码片段，警告您有关常见错误，在命名方案中显示不一致之处，并且 - 如果需要，请帮助您执行所需的编码样式。

安装和用法

将Credo添加到您的项目的最简单方法是使用Mix。

添加:credo作为您项目mix.exs的依赖性。exs：

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

并运行：

 $ mix deps.get

$ mix credo

文档

可以在Hexdocs上使用文档

集成

IDE/编辑器

一些IDE和编辑可以在后台运行Credo，并在内联标记问题。

• Intellij Elixir-喷气桥的Elixir插件（Intellij Idea，Rubymine，Phpstorm，Pycharm等）
• linter-elixir-credo-原子编辑器包（@smeevil）
• Elixir Linter（Credo）-VScode扩展（@pantajoe）
• flycheck -Emacs语法检查扩展
• Kakoune- Kakoune编辑中的覆盖支持配置
• Neovim通过null -LS-内置诊断

自动代码审核

• CODACY-检查您的代码从样式到安全性，重复，复杂性，并与覆盖范围集成。
• Sourcelevel-跟踪您的代码如何随时间变化，并使您的整个团队都可以访问此信息。
• 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（@Rrrrene）

执照

Credo根据MIT许可发布。有关更多详细信息，请参见许可证文件。