InnerCotton

Collection of recommended Elixir check utilities.

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

• Credo : Lint, coding style enhancer.
• Dialyxir : Type checker using Dialyzer.
• ExCoveralls : Mesure test coverage.
• EyeDrops : File change watcher.
• InchEx : Document (ExDoc) improver.
• mix format : Community standard code formatter.
• stream_data : Property base testing like QuickCheck.

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

Maintenance policy