farol v0.1.2 initial

farol 0.1.2

by Erich Oliveira ·

Farol execution on a repository

Free CLI and GitHub Action that maps the risk of merging a pull request

#typescript #cli #devtools #productivity #linux #macos #windows #mit #ai-generated

Changelog

farol tells the person who approves a pull request how risky the merge is and which files carry the risk, so the riskiest changes get the most attention. It is a free, open-source CLI and GitHub Action, and it works from static analysis: it never executes your code and never blocks a merge.

Try it: live demo · npx @winninjs/farol routes · get started

What's new in 0.1.2

  • GitHub Marketplace: action.yml at the repository root, so farol can be listed in the Marketplace. uses: winnin/farol/action@… keeps working: both point at the same action, kept in sync by a test.
  • Website and live demo: https://winnin.github.io/farol/, with the CI reports of a demo pull request on the FastAPI full-stack template.
  • Social preview image for the repository and the website.

What farol does

  • Verdict and merge risk score: fast track, quick review or careful review, with the reasons.
  • Riskiest files first: reach (centrality in a declaration graph built with your compilers) times what diff coverage leaves, with inline diffs that mark untested lines and findings.
  • Impact: every page, endpoint, RPC method, job or script the change reaches, with the call chain.
  • Diff coverage, lint and security findings on the changed lines, from the reports your CI already produces.
  • Contract changes for GraphQL, FastAPI, Go handlers and gRPC: breaking, dangerous and safe.
  • Dependencies: critical bumps and known vulnerabilities in what the PR adds or changes.
  • Suggested reviewers from git blame on the riskiest code, plus CODEOWNERS.
  • Incremental mode: after a push, a report with only the commits since the previous one.
  • Test plan that follows your review, pages behind a feature flag, and a copyable review record.
  • Optional Datadog traffic and errors for the affected pages and endpoints.

Supports React Router, Next.js and TanStack Router frontends; TypeScript (GraphQL/REST), Go and Python backends.

npm: @winninjs/farol · Full changelog: CHANGELOG.md

Links

← Back to the feed