Guide (Guide v0.0.4)

Copy Markdown View Source

Turns sobelow static code analysis results into markdown, by:

  1. Fetching a collection of recommendations in markdown,
  2. Extracting the needed parts out of (1), that match the sobelow findings,
  3. Prepare markdown that can be used to decorate PRs in GitHub.

Summary

Functions

Writes the finished markdown to a file.

Functions

run(opts \\ [])

Writes the finished markdown to a file.

Returns :ok or {:error, _reason}.