dogma

Догма

Этот инструмент устарел

С новым форматированием в Elixir v1.6 я не думаю, что для догмы больше есть использование. Спасибо, что использовали этот Линтер, это было весело :)

Вступление

Догма - это принцип или набор принципов, изложенных авторитетом, как несомненно, верно .

Это также кодовый стиль для Эликсира, основанный на стыде.

• О
• Использование
• Конфигурация
• Правила
• Выходные форматы

О

Dogma - это инструмент для обеспечения соблюдения постоянного стиля кода эликсира в вашем проекте, и идея заключается в том, что если ваш код легче читать, его также должны быть проще для понимания. Он очень настраивается, поэтому вы можете настроить его в соответствии с вашим руководством по стилю, но поставляется с разумным набором по умолчанию, поэтому для большинства людей он должен просто работать вне коробки. Мне нравится запускать Dogma на сервере CI с тестовым набором, и рассматривать сборку, если догма сообщает о проблеме.

Если вы заинтересованы в инструменте, более ориентированном на предложения в стиле, а не строго соблюдает ваше руководство по стилю, ознакомьтесь с Credo.

Использование

Добавьте догму в ваши зависимости от микса

 # mix.exs
def deps do
  [
    { :dogma , "~> 0.1" , only: :dev } ,
  ]
end

Принесите это:

 mix deps.get

Запустите задачу микса:

 mix dogma

Вы получите что -то вроде этого:

 Inspecting 27 files.

.....X..........X..........

27 files, 2 errors!

== lib/dogma/rules.ex ==
23: TrailingBlankLines: Blank lines detected at end of file

== test/dogma/formatter_test.exs ==
9: TrailingWhitespace: Trailing whitespace detected

Как удобно!

Установите догму во всем мире

Чтобы запустить догму из любого каталога построить Escript:

 mix escript.build

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

Информация о участнике

Проверьте это

mix test       # Run tests once
mix test.watch # Run tests on file changes
mix dogma      # Dogfooding- run the linter!

Прочитайте документы разработчика

Проверьте их на Hexdocs или создайте их самостоятельно:

mix docs

ЛИЦЕНЗИЯ

 Dogma - A code style linter for Elixir, powered by shame.
Copyright © 2015 Louis Pilfold - MIT Licence

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.