Back to Credo

Overview

guides/introduction/overview.md

1.7.181.4 KB
Original Source

Overview

Credo is a static code analysis tool for the Elixir language with a focus on teaching and code consistency.

credo can show you refactoring opportunities in your code, complex code fragments, warn you about common mistakes, show inconsistencies in your naming scheme and - if needed - help you enforce a desired coding style.

The basic functionality will be familiar to you if you used a linter like JavaScript's ESLint, Ruby's RuboCop or C#'s Stylecop before.

Contrary to the aforementioned tools, Credo puts a strong emphasis on teaching and code consistency.

To get started, you might want to check out these guides:

Once you are familiar with the basics, look into these topics:

Any incorrect or unclear information in these docs should be considered a bug. In case you find something, you can help maintaining these docs by filing an issue on GitHub and/or opening a pull request.