zkessin

zkessin

Credo ignore existing errors

I want to add Credo to an existing project, and of course, when it runs it flags a lot of problems. What I want to know is there a built-in way to cause Credo to ignore the known issues, but report an error on new issues that may come up? That way the existing issues can be handled over time while we prevent any more issues from happening

First 4 of 4 Posts Switch mode

srowley

srowley

I am not aware of anything Credo does to remember results of prior runs, but it does allow you to ignore specific lines or files, if you are willing able to go through the code and apply those exceptions.

hauleth

hauleth

You can use ReviewDog to filter out failures limiting them to only the errors in current diff.

zoldar

zoldar

As a kind of a workaround, you could use git to select only files that changed relative to the base branch for credo checks. It’s still coarse grained but allows for incrementally improving credo compliance of the code base (however that assumes branch-based workflow so YMMV).

NOTE: I didn’t run this code (it’s a heavily edited and simplified version of an existing solution). It should give an idea though.

defmodule Mix.Tasks.Credo.Ci do
  use Mix.Task

  @impl true
  def run(_) do
    if System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]) == {"master", 0} do
      Mix.Task.run("credo", [])
    else
      {head_sha, 0} = System.cmd("git", ["rev-parse", "HEAD"])

      {closest_ancestor_sha, 0} =
        System.cmd("git", [
          "merge-base",
          String.trim(head_sha),
          "origin/master",
        ])

      {diff, 0} = System.cmd("git", ["diff", "--name-only", String.trim(closest_ancestor_sha)])

      files =
        diff
        |> String.split("\n")
        |> Enum.filter(&(&1 =~ ~r/(lib|test).*\.exs?/))
        |> Enum.flat_map(&["--files-included", &1])

      unless files == [] do
        Mix.Task.run("credo", ["-C", config_name | files])
      end
    end
  end
end
m1dnight

m1dnight

I noticed @hauleth s comment and I decided to figure out how to do it locally.

My workflow would be to run credo on my current changes not staged for committing. To only get reports on the current unstaged changes is done as follows.

mix credo --strict --format=flycheck | reviewdog -efm="%f:%l:%c: %t: %m" -efm="%f:%l: %t: %m" -name="credo" -diff="git diff"

The key here is to play around with the -diff command. That’s the output reviewdog will use to determine which violations (according to credo) are relevant to show you.

Say you want to get only new issues since you created your feature branch off of the develop branch, this will do too:

mix credo --strict --format=flycheck | reviewdog -efm="%f:%l:%c: %t: %m" -efm="%f:%l: %t: %m" -name="credo" -diff="git diff HEAD $(git merge-base HEAD develop) "

— All posts loaded —

Where Next?

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement