dogma

Dogme

Cet outil a été obsolète

Avec le nouveau formateur dans Elixir v1.6, je ne pense plus qu'il y ait une utilisation pour le dogme. Merci d'avoir utilisé ce linter, ça a été amusant :)

Introduction

Le dogme est un principe ou un ensemble de principes énoncés par une autorité aussi incontestablement vraie .

C'est aussi un linter de style de code pour Elixir, alimenté par la honte.

• À propos
• Usage
• Configuration
• Règles
• Formats de sortie

À propos

Le dogme est un outil pour appliquer un style de code Elixir cohérent dans votre projet, l'idée étant que si votre code est plus facile à lire, il devrait également être plus facile à comprendre. Il est hautement configurable, vous pouvez donc l'ajuster en fonction de votre guide de style, mais est livré avec un ensemble sain d'esprit de valeurs par défaut, donc pour la plupart des gens, il devrait simplement travailler à l'extérieur. J'aime exécuter Dogma sur le serveur CI avec la suite de tests, et considérer la construction cassée si Dogma rapporte un problème.

Si vous êtes intéressé par un outil plus visant à faire des suggestions de style plutôt qu'à appliquer strictement votre guide de style, consultez Credo.

Usage

Ajouter un dogme à vos dépendances de mélange

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

Retrouvez-le:

 mix deps.get

Exécutez la tâche de mixage:

 mix dogma

Vous obtiendrez quelque chose comme ceci:

 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

Comme c'est pratique!

Installer le dogme à l'échelle mondiale

Afin d'exécuter Dogma à partir de n'importe quel répertoire, construisez l'escript:

 mix escript.build

Cela créera un exécutable que vous pouvez placer sur votre chemin et invoquer de n'importe où.

Informations sur les contributeurs

Testez-le

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

Lisez les documents du développeur

Vérifiez-les sur des hexdocs ou générez-les vous-même:

mix docs

LICENCE

 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.