credo

Кредо

Credo - это статический инструмент анализа кода для языка эликсира с акцентом на обучение и согласованность кода.

Это может показать вам возможности рефакторинга в вашем коде, сложных фрагментах кода, предупреждаете вас об общих ошибках, показывают несоответствия в вашей схеме именования и - при необходимости - помогать вам обеспечить желаемый стиль кодирования.

Установка и использование

Самый простой способ добавить кредо в ваш проект - это использовать Mix.

Добавить :credo в зависимости от зависимости от mix.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 для Jetbrains Ides (Intellij Idea, Rubymine, Phpstorm, Pycharm и т. Д.)
• Линтер-Эликсир-Кредо-Пакет для редактора Atom (от @smeevil)
• Эликсир Линтер (Credo) - расширение VSCODE (от @pantajoe)
• Flycheck - Emacs Syntax Проверка расширения
• Kakoune - Config для поддержки Linting в редакторе Kakoune
• Neovim via null -ls - диагностика встроенная

Автоматизированный обзор кода

• Кодекс - проверяет ваш код от стиля до безопасности, дублирования, сложности, а также интегрируется с покрытием.
• 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. Создать новый запрос на привлечение

Автор

Рене Форинг (@rrrene)

Лицензия

Credo выпускается по лицензии MIT. См. Файл лицензии для получения дополнительной информации.