rules

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 21, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const SignalRolePermission = "permission"

Variables

This section is empty.

Functions

func Questions

func Questions(selected []Rule, audit, retrieved bool) []decision.Question

Questions is the common instruction assembly path for checks and evaluations.

func ValidPack

func ValidPack(pack string) bool

Types

type PermissionPolicy

type PermissionPolicy struct {
	AllowedAtLeast   float64 `json:"allowed_at_least"`
	DisallowedAtMost float64 `json:"disallowed_at_most"`
}

func (PermissionPolicy) Classify

func (p PermissionPolicy) Classify(score float64) string

func (PermissionPolicy) Validate

func (p PermissionPolicy) Validate() error

type Rule

type Rule struct {
	Context             string
	Pack                string
	ID                  string
	Description         string
	Signals             []Signal
	CompositionMode     string
	Message             string
	Scope               Scope
	DefaultThreshold    float64
	DefaultSeverity     Severity
	RequiresTaskContext bool
	AuditSkipReason     string
	Version             int
	Applicable          func(semantic.Unit, string) (bool, string)
}

func All

func All() []Rule

func Get

func Get(id string) (Rule, bool)

func (Rule) Compose

func (r Rule) Compose(probabilities map[string]float64) (float64, bool)

func (Rule) ComposePermission

func (r Rule) ComposePermission(probabilities map[string]float64) (float64, []string, bool)

func (Rule) Composition

func (r Rule) Composition() string

func (Rule) QuestionID

func (r Rule) QuestionID(signal Signal) string

type Scope

type Scope string
const (
	ScopeHunk  Scope = "hunk"
	ScopePatch Scope = "patch"
)

type Severity

type Severity string
const (
	SeverityWarning Severity = "warning"
	SeverityError   Severity = "error"
)

func ValidateSeverity

func ValidateSeverity(value string) (Severity, error)

type Signal

type Signal struct {
	ID           string
	Instructions string
	Criteria     *decision.NoulCriteria `json:",omitempty"`
	Negate       bool                   `json:",omitempty"`
	Role         string                 `json:",omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL