https://github.com/hauleth/credo_code_climate
Plugin for Credo to produce CodeClimate-compatible JSON output
https://github.com/hauleth/credo_code_climate
code-climate codeclimate credo elixir elixir-lang linter
Last synced: 7 months ago
JSON representation
Plugin for Credo to produce CodeClimate-compatible JSON output
- Host: GitHub
- URL: https://github.com/hauleth/credo_code_climate
- Owner: hauleth
- License: mit
- Created: 2021-01-17T01:46:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T08:55:57.000Z (over 4 years ago)
- Last Synced: 2025-02-02T01:03:10.205Z (12 months ago)
- Topics: code-climate, codeclimate, credo, elixir, elixir-lang, linter
- Language: Elixir
- Homepage:
- Size: 9.77 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CredoCodeClimate
Generate CodeClimate report of the Credo lint.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `credo_code_climate` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:credo_code_climate, "~> 0.1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/credo_code_climate](https://hexdocs.pm/credo_code_climate).
## Usage
Add `{CredoCodeClimate, []}` to list of plugins in `.credo.exs` (if you have no
such file then first generate it via `mix credo.gen.config`).
### Options
- `:path` - where the generated report will be stored. Defaults to
`codeclimate.json` in the root directory.