https://github.com/rrrene/credo

A static code analysis tool for the Elixir language with a focus on code consistency and teaching.
https://github.com/rrrene/credo

code-analysis credo elixir linter static-analysis

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rrrene/credo
• Owner: rrrene
• License: mit
• Created: 2015-09-27T13:16:15.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-20T11:58:55.000Z (about 2 months ago)
• Last Synced: 2024-10-29T21:59:13.527Z (about 1 month ago)
• Topics: code-analysis, credo, elixir, linter, static-analysis
• Language: Elixir
• Homepage: http://credo-ci.org/
• Size: 4.97 MB
• Stars: 4,927
• Watchers: 57
• Forks: 416
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A static code analysis tool with a focus on code consistency and teaching Elixir. ([Docs](https://hexdocs.pm/credo/Credo.html)). (Top 20 packages)
• fucking-awesome-elixir - credo - A static code analysis tool with a focus on code consistency and teaching Elixir. ([Docs](https://hexdocs.pm/credo/Credo.html)). (Code Analysis)
• awesome-linters - credo - Static code analysis tool for the (Linters / Elixir)
• awesome-elixir - credo - A static code analysis tool with a focus on code consistency and teaching Elixir. ([Docs](https://hexdocs.pm/credo/Credo.html)). (Code Analysis)

README

        
# Credo [![CI Tests](https://github.com/rrrene/credo/workflows/CI%20Tests/badge.svg)](https://github.com/rrrene/credo/actions?query=branch%3Amaster) [![Inline docs](https://inch-ci.org/github/rrrene/credo.svg?branch=master)](https://hexdocs.pm/credo)

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

It 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.

![Credo](https://raw.github.com/rrrene/credo/master/assets/screenshot.png)

## Installation and Usage

The easiest way to add Credo to your project is by [using Mix](http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html).

Add `:credo` as a dependency to your project's `mix.exs`:

```elixir

defp deps do

  [

    {:credo, "~> 1.7", only: [:dev, :test], runtime: false}

  ]

end

```

And run:

    $ mix deps.get

    $ mix credo

## Documentation

Documentation is [available on Hexdocs](https://hexdocs.pm/credo/)

## Integrations

### IDE/Editor

Some IDEs and editors are able to run Credo in the background and mark issues inline.

* [IntelliJ Elixir](https://github.com/KronicDeth/intellij-elixir#credo) - Elixir plugin for JetBrains IDEs (IntelliJ IDEA, Rubymine, PHPStorm, PyCharm, etc)

* [linter-elixir-credo](https://atom.io/packages/linter-elixir-credo) - Package for Atom editor (by @smeevil)

* [Elixir Linter (Credo)](https://marketplace.visualstudio.com/items?itemName=pantajoe.vscode-elixir-credo) - VSCode extension (by @pantajoe)

* [flycheck](https://www.flycheck.org/en/latest/languages.html#elixir) - Emacs syntax checking extension

* [kakoune](https://github.com/mawww/kakoune/wiki/Lint#elixir) - Config for linting support in Kakoune editor

* [Neovim via null-ls](https://github.com/jose-elias-alvarez/null-ls.nvim/blob/main/lua/null-ls/builtins/diagnostics/credo.lua) - diagnostics builtin

### Automated Code Review

* [Codacy](https://www.codacy.com/) - checks your code from style to security, duplication, complexity, and also integrates with coverage.

* [SourceLevel](https://sourcelevel.io/) - tracks how your code changes over time and have this information accessible to your whole team.

* [Stickler CI](https://stickler-ci.com/) - checks your code for style and best practices across your entire stack.

## Contributing

1. [Fork it!](http://github.com/rrrene/credo/fork)

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)

## License

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

details.