Skip to content

📝 Add docstrings to feat/scanner-derived-content-rules #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
coderabbitai wants to merge 1 commit into from
Open

📝 Add docstrings to feat/scanner-derived-content-rules #754

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions lib/hypatia/cli.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,14 +301,19 @@ defmodule Hypatia.CLI do
# ─── Finding collection across rule modules ──────────────────────────

@doc """
Run the named rule modules against `repo_path` and return normalized findings
(`%{rule_module, type, severity, file, reason, action}`). Public so the RSR
conformance oracle can delegate content-scan criteria to the live scanners
rather than reimplement per-file detection. `rules` is a list of module atoms
(e.g. `[:cicd_rules, :structural_drift]`); GitHub-API modules
(`:dependabot_alerts`, `:secret_scanning_alerts`, `:code_scanning_alerts`,
`:scorecard`) require network + token and return nothing offline.
Runs the selected rule modules against a repository and produces findings in a
common map format. Findings covered by configured suppressions are excluded.

## Parameters

- repo_path: Path to the repository to scan.
- rules: Rule module identifiers to run.

## Returns

A list of normalized finding maps.
"""
@spec collect_findings(String.t(), [atom()]) :: [map()]
def collect_findings(repo_path, rules) do
results = []

Expand Down
Loading