feature_flag_audit library

Public API for the feature_flag_audit package.

This library exports configuration models, configuration loading utilities, validation types, and source scanning results.

Classes

AuditConfig
Complete package configuration used for loading, validation, and scanning.
AuditConfigLoader
Loads and validates feature_flag_audit.yaml from a project root.
AuditConfigLoadResult
Result of loading and validating configuration.
AuditFinding
A resolved key usage discovered in source code.
AuditKeyComparison
Comparison result between keys used in code and keys defined in Firebase.
AuditScanner
Scanner for detecting feature flag usage in Dart code.
AuditScanResult
Aggregate result returned by the scanner.
AuditUnresolvedReference
A method match where key reference could not be resolved.
ConfigIssue
A single warning or error discovered while validating configuration.
ConfigValidationResult
Validation outcome containing warnings and errors.
DetectionConfig
Controls method and key class detection rules.
FirebaseConfig
Firebase project and credential configuration.
FirebaseRemoteConfigClient
Loads Firebase Remote Config keys from the remote template API.
OutputConfig
Controls CLI output sections.
PolicyConfig
Controls pipeline enforcement behavior for each class of audit finding.
PolicyEvaluationResult
Aggregate result of evaluating all policy rules against audit findings.
PolicyRuleResult
Outcome of a single policy rule evaluation.
ScanConfig
Controls which source paths are included or excluded.

Enums

AuditMatchKind
Type of method match that produced a finding.
ConfigIssueSeverity
Severity levels used during configuration validation.
PolicyAction
Action to take when a policy rule has violations.

Functions

evaluatePolicy({required PolicyConfig policy, required AuditScanResult scanResult, AuditKeyComparison? comparison}) PolicyEvaluationResult
Evaluates policy rules against scan and optional Firebase comparison results.

Typedefs

ConfigLogger = void Function(String message)
Logger callback used during configuration loading.

Exceptions / Errors

AuditConfigException
Exception thrown when configuration parsing fails.