Dogma
=====
<img src="https://raw.github.com/lpil/dogma/master/docs/for-shame.png" alt="FOR SHAME!" title="SHAME" align="right"/>
[](https://travis-ci.org/lpil/dogma)
[](https://coveralls.io/r/lpil/dogma)
[](https://hex.pm/packages/dogma)
[](https://hex.pm/packages/dogma)
[](http://inch-ci.org/github/lpil/dogma)
Dogma is a principle or set of principles laid down by an authority as
**incontrovertibly true**.
It's also a code style linter for Elixir, powered by shame.
* [About](#about)
* [Usage](#usage)
* [Configuration][config-doc]
* [Rules][rules-doc]
* [Output formats][reporters-doc]
[config-doc]: https://github.com/lpil/dogma/blob/master/docs/configuration.md
[rules-doc]: https://github.com/lpil/dogma/blob/master/docs/rules.md
[reporters-doc]: https://github.com/lpil/dogma/blob/master/docs/reporters.md
## About
Dogma is a tool for enforcing a consistent Elixir code style within your
project, the idea being that if your code is easier to read, it should also be
easier to understand. It's highly configurable so you can adjust it to fit your
style guide, but comes with a sane set of defaults so for most people it
should just work out-of-the-box. I like to run Dogma on the CI server with
the test suite, and consider the build broken if Dogma reports a problem.
If you're interested in a tool more geared towards making style suggestions
rather than strictly enforcing your style guide, check out
[Credo](https://github.com/rrrene/credo).
## Usage
Add Dogma to your Mix dependencies
```elixir
# mix.exs
def deps do
[
{:dogma, "~> 0.1", only: :dev},
]
end
```
Fetch it:
```
mix deps.get
```
Run the mix task:
```
mix dogma
```
You'll get something like this:
```
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
```
How handy!
### Install Dogma globally
In order to run dogma from any directory build the escript:
```
mix escript.build
```
this will create an executable that you can place in your PATH
and invoke from anywhere.
## Contributor Information
### Test it
```sh
mix test # Run tests once
mix test.watch # Run tests on file changes
mix dogma # Dogfooding- run the linter!
```
### Read the developer docs
Check them out on [hexdocs][hexdocs-dogma], or generate them yourself:
[hexdocs-dogma]: https://hexdocs.pm/dogma/api-reference.html
```sh
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.
```
