Picket.Compat API
Generated from XML documentation for Picket.Compat.
- GitleaksBaseline - Represents a Gitleaks-compatible baseline report used to suppress existing findings.
- GitleaksBaselineComparisonMode - Specifies how findings are compared with a Gitleaks baseline.
- GitleaksConfigLoader - Loads Gitleaks-compatible rule configuration.
- GitleaksConfigWriter - Writes resolved Gitleaks-compatible rule sets as deterministic TOML.
- GitleaksIgnore - Represents Gitleaks-compatible fingerprint ignore entries.
- PicketConfigLoader - Loads Picket-native rule configuration while preserving the Gitleaks-compatible rule schema.
GitleaksBaseline
Section titled “GitleaksBaseline”Picket.Compat.GitleaksBaseline
Represents a Gitleaks-compatible baseline report used to suppress existing findings.
Constructors
Section titled “Constructors”GitleaksBaseline(IReadOnlyList<Finding> findings, GitleaksBaselineComparisonMode comparisonMode)- Represents a Gitleaks-compatible baseline report used to suppress existing findings.
Methods
Section titled “Methods”Filter(IReadOnlyList<Finding> findings, int redactionPercent)- Returns findings not already present in this baseline.IsNew(Finding finding, int redactionPercent)- Returns a value indicating whether a finding is new relative to this baseline.Load(string path)- Loads a Gitleaks JSON report from disk as a baseline.Load(string path, GitleaksBaselineComparisonMode comparisonMode)- Loads a Gitleaks JSON report from disk as a baseline.
Properties
Section titled “Properties”Count- Gets the number of findings in the baseline.Empty- Gets an empty baseline.
GitleaksBaselineComparisonMode
Section titled “GitleaksBaselineComparisonMode”Picket.Compat.GitleaksBaselineComparisonMode
Specifies how findings are compared with a Gitleaks baseline.
Fields
Section titled “Fields”Exact- Uses the exact field comparison implemented by Gitleaks.PortableLineEndings- Treats LF and CRLF evidence as equivalent while preserving all other identity fields.
GitleaksConfigLoader
Section titled “GitleaksConfigLoader”Picket.Compat.GitleaksConfigLoader
Loads Gitleaks-compatible rule configuration.
Methods
Section titled “Methods”FromToml(string toml, string sourceName)- Loads rules from Gitleaks TOML content.LoadDefaultRuleSet()- Loads the embedded Gitleaks-compatible default rule set without reading environment variables or target-local configuration files.LoadFile(string path)- Loads rules from a Gitleaks TOML file.LoadRuleSet(string configPath, string source)- Loads rules using Gitleaks-compatible config precedence.
GitleaksConfigWriter
Section titled “GitleaksConfigWriter”Picket.Compat.GitleaksConfigWriter
Writes resolved Gitleaks-compatible rule sets as deterministic TOML.
Methods
Section titled “Methods”Write(RuleSet ruleSet)- Writes a resolved rule set as deterministic TOML.
GitleaksIgnore
Section titled “GitleaksIgnore”Picket.Compat.GitleaksIgnore
Represents Gitleaks-compatible fingerprint ignore entries.
Constructors
Section titled “Constructors”GitleaksIgnore(IEnumerable<string> fingerprints)- Represents Gitleaks-compatible fingerprint ignore entries.
Methods
Section titled “Methods”Filter(IReadOnlyList<Finding> findings)- Returns findings not suppressed by this ignore set.FromLines(IEnumerable<string> lines)- Parses ignore entries from lines using Gitleaks-compatible rules.IsIgnored(Finding finding)- Returns a value indicating whether a finding is suppressed.Load(string path)- Loads ignore entries from a .gitleaksignore file.LoadExisting(IEnumerable<string> paths)- Loads ignore entries from every existing file path in order.
Properties
Section titled “Properties”Count- Gets the number of loaded fingerprint entries.Empty- Gets an empty ignore set.
PicketConfigLoader
Section titled “PicketConfigLoader”Picket.Compat.PicketConfigLoader
Loads Picket-native rule configuration while preserving the Gitleaks-compatible rule schema.
Methods
Section titled “Methods”LoadBuiltInRulePack(string rulePack)- Loads one built-in rule pack without reading environment variables or target-local configuration files.LoadDefaultRuleSet()- Loads the embedded Picket-native default rule set without reading environment variables or target-local configuration files.LoadRuleSet(string configPath, string source, string[] additionalBuiltInRulePacks)- Loads rules using Picket-native config precedence.