sfox_credo

• code :: https://github.com/sfoxhq/sfox_credo
• issues :: https://github.com/sfoxhq/sfox_credo/issues

Credo checks used for Elixir projects at sFOX.

Installation

Add sfox_credo to your dependencies in mix.exs:

def deps do
  [
    {:sfox_credo, "~> 0.1"}
  ]
end

Documentation is found on HexDocs.

Usage

sfox_credo provides two plugins to add to the profile plugins list in .credo.exs:

• SfoxCredo.Standard: Add this to plugins to configure standard Credo checks (including some that will be in the next minor release) as used by sFOX.

• SfoxCredo.Custom: Add this to plugins to configure Credo checks written by sFOX. This includes SfoxCredo.Check.Design.EctoMigrationTimestamp and SfoxCredo.Check.Warning.AvoidAtomToString.

When using these plugins, it is strongly recommended that the enabled configuration block be omitted from your .credo.exs. Checks to be disabled should be added to the disabled list and additional or reconfigured checks should be placed in the extra list. Otherwise, it will be necessary for you to manually configure everything.

Semantic Versioning

sfox_credo follows Semantic Versioning 2.0.