Class: RailsDoctor::Reporters::Markdown

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_doctor/reporters/markdown.rb

Instance Method Summary collapse

Constructor Details

#initialize(result) ⇒ Markdown

Returns a new instance of Markdown.



6
7
8
 
# File 'lib/rails_doctor/reporters/markdown.rb', line 6

def initialize(result)
  @result = result
end

Instance Method Details

#render ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rails_doctor/reporters/markdown.rb', line 10

def render
  lines = []
  lines << "# Rails Doctor Report"
  lines << ""
  lines << "- Profile: `#{@result.profile}`"
  lines << "- Overall score: `#{@result.score&.overall || "n/a"}/100`"
  lines << "- Changed-files score: `#{@result.score&.changed_files || "n/a"}/100`"
  lines << "- Confidence: `#{@result.score&.confidence || "n/a"}%`"
  lines << "- Coverage: `#{coverage_text}`"
  lines << "- Findings: `#{@result.findings.size}`"
  lines << "- Duration: `#{@result.duration_ms}ms`"
  lines << ""
  lines << "## Coverage"
  lines << ""
  lines.concat(coverage_lines)
  lines << ""
  lines << "## Severity Breakdown"
  lines << ""
  @result.summary.fetch(:severity_counts).each do |severity, count|
    lines << "- `#{severity}`: #{count}"
  end
  lines << ""
  lines << "## Skipped Tools"
  lines << ""
  if @result.skipped_tools.empty?
    lines << "No tools were skipped."
  else
    @result.skipped_tools.each do |tool|
      lines << "- **#{tool.name}**: #{tool.skip_reason}"
    end
  end
  lines << ""
  lines << "## Top Findings"
  lines << ""
  top_findings.each do |finding|
    lines << "### #{finding.severity.upcase}: #{finding.message}"
    lines << ""
    lines << "- Tool: `#{finding.tool}`"
    lines << "- Category: `#{finding.category}`"
    lines << "- Location: `#{[finding.file, finding.line].compact.join(":")}`" if finding.file
    lines << "- Confidence: `#{finding.confidence}`"
    lines << ""
    lines << finding.recommendation.to_s
    lines << ""
    lines << "**Agent instruction:** #{finding.agent_instruction}" if finding.agent_instruction
    lines << ""
  end
  lines << "No findings." if top_findings.empty?
  lines << ""
  lines << "## Hotspots"
  lines << ""
  if @result.hotspots.empty?
    lines << "No hotspots detected."
  else
    @result.hotspots.each do |hotspot|
      lines << "- `#{hotspot.file}`: score #{hotspot.score}, #{hotspot.finding_count} findings, churn #{hotspot.churn}, changed=#{hotspot.changed}"
    end
  end
  lines << ""
  lines.join("\n")
end