InchEx

InchEx is a wrapper to use Inch for Elixir projects.

Usage

Add InchEx as a dependency in your mix.exs file.

defp deps do
  [{:inch_ex, "~> 0.2.0"}]
end

After adding you are done, run mix deps.get in your shell to fetch the dependencies and mix inch to run it:

    $ mix inch

    # Properly documented, could be improved:

    ┃  B  ↑  Foo.complicated/5

    # Undocumented:

    ┃  U  ↑  Foo
    ┃  U  ↗  Foo.filename/1

    Grade distribution (undocumented, C, B, A):  █  ▁ ▄ ▄

If you have Inch installed it will run locally. If not, it will use the API of inch-ci.org to display results. If you want to specify a certain Inch version you have installed (e.g. for testing), you can set the INCH_PATH environment variable.

Philosophy

I will point you to the original Inch README for an overview of the basic premises and priorities of the Inch project.

Contributing

1. Fork it!
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Author

René Föhring (@rrrene)

Credits

InchEx ows its existence to the extensive study and "code borrowing" from ExDoc.

License

InchEx is released under the MIT License. See the LICENSE file for further details.