Packages

reach

2.8.2
2.8.2 2.8.1 2.8.0 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7.0 2.6.1 2.6.0 2.5.0 2.4.0 2.3.5 2.3.4 2.3.3 2.3.2 2.3.1 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.1 1.4.0 1.3.0 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0

Program dependence graph for Elixir, Erlang, Gleam, JavaScript, and TypeScript

HexDocs

Current section

Files

Jump to
Readme
37 Versions
8 Dependencies
Dependants
Files
Activity
reach lib reach check candidate.ex
Raw

lib/reach/check/candidate.ex 

defmodule Reach.Check.Candidate do

  @moduledoc "Struct for an advisory refactoring candidate with confidence and proof."



  @derive JSON.Encoder

  defstruct [

    :id,

    :kind,

    :target,

    :file,

    :line,

    :benefit,

    :risk,

    :confidence,

    :actionability,

    :evidence,

    :effects,

    :proof,

    :suggestion,

    :modules,

    :representative_calls,

    :call,

    :branches,

    :direct_caller_count,

    :keys,

    :occurrences,

    :sources,

    :boundary,

    :decoder,

    :canonical_site,

    :draft_contract,

    blast_radius: [],

    clone_siblings: []

  ]



  @type t :: %__MODULE__{

          risk: :high | :medium | :low,

          confidence: :high | :medium | :low,

          effects: [Reach.Effects.effect()] | nil,

          canonical_site: map() | nil,

          blast_radius: [String.t()],

          clone_siblings: [map()]

        }



  def new(attrs) when is_list(attrs) or is_map(attrs), do: struct!(__MODULE__, attrs)

end