Scry.Report (scry v0.1.22)

Copy Markdown View Source

Output formats for the standalone mix scry task.

Text is the pentiment frames plus a summary line. JSON is the stable machine schema — the structured finding fields, never the rendered frames:

[
  {
    "analysis": "one_for_one_coupling",
    "severity": "warning",
    "file": "lib/my_app/application.ex",
    "line": 12,
    "title": "Coupled children under one_for_one",
    "detail": "...",
    "help": ["..."],
    "related": [{"label": "coupling call", "file": "...", "line": 41}]
  }
]

Summary

Functions

json(entries, cwd)

Encodes resolved finding entries as JSON on stdout.

summary(diagnostics)

The N findings (x errors, y warnings, z infos) summary line.

text(rendered)

Prints resolved entries as pentiment frames with a trailing summary.

Functions

json(entries, cwd)

@spec json([map()], String.t()) :: :ok

Encodes resolved finding entries as JSON on stdout.

summary(diagnostics)

@spec summary([Mix.Task.Compiler.Diagnostic.t()]) :: String.t()

The N findings (x errors, y warnings, z infos) summary line.

text(rendered)

@spec text([Scry.Diagnostics.rendered()]) :: :ok

Prints resolved entries as pentiment frames with a trailing summary.