InnerCotton

Collection of recommended Elixir check utilities.

Hex.pm Build Status

InnerCotton is a collection of recommended Elixir check utilities. It contains,

Installation

Add inner_cotton to your list of dependencies in mix.exs:

def deps do
  [
    {:inner_cotton, "~> 0.3", only: [:dev, :test]},
    # {:inner_cotton, github: "ne-sachirou/inner_cotton", only: [:dev, :test]},
  ]
end

& run,

mix deps.get
mix cotton.init

Then InnerCotton is installed & some configuration files are generated.

Lint

mix cotton.lint

runs all checks. Now InnerCotton runs mix format --check-formatted, mix credo --strict, mix dialyzer & mix inch --pedantic.

mix cotton.lint --fix

auto correct errors if available.

Test

InnerCotton installs stream_data in your project. You can use it in your test.

mix test
MIX_ENV=test mix coveralls

Watch

Watch file changes then run lint & test.

mix cotton.watch

Update InnerCotton

Edit your mix.exs & run,

mix deps.update inner_cotton
mix cotton.init

CONTRIBUTING

  1. Fork.
  2. Implement a new feature & write some tests.
  3. Create a Pull Request.

Please run lint & test before commit.

mix cotton.lint
mix test