Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rule

package

Go to main page

Versions in this module

v0

v0.53.1

Sep 17, 2026

v0.53.0

Sep 17, 2026

v0.52.0

Sep 15, 2026

v0.51.0

Sep 14, 2026

v0.50.1

Sep 13, 2026

v0.50.0

Sep 11, 2026

v0.49.0

Sep 10, 2026

v0.48.0

Sep 10, 2026

Changes in this version

+ const TriggerMaxLen

+ func ResolveTrigger(statement string, detail *Detail) string

type Detail

+ InstructionsFirstLine string

+ Section string

+ SectionLine int

+ Trigger string

+ TriggerLine int

type Options

+ Trigger string

+ type RenderEntry struct

+ Section string

+ Slug string

+ Trigger string

+ func BuildRenderEntries(rows []Row, details map[string]*Detail) []RenderEntry

+ func (e RenderEntry) RenderLine() string

v0.47.0

Sep 10, 2026

v0.46.0

Sep 10, 2026

v0.45.0

Sep 10, 2026

v0.44.0

Sep 10, 2026

v0.43.0

Sep 9, 2026

v0.42.1

Sep 9, 2026

v0.42.0

Sep 7, 2026

v0.41.0

Sep 6, 2026

v0.40.0

Sep 5, 2026

v0.39.1

Sep 3, 2026

Changes in this version

+ func RepairHint(m MalformedRow) string

v0.39.0

Sep 3, 2026

Changes in this version

+ const DefaultSkillsPath

+ const FormatURL

+ const IndexEmptyPlaceholder

+ const IndexFormatURL

+ const IndexHeaderRow

+ const IndexHeading

+ const IndexSeparatorRow

+ const LessonPromotesToField

+ const ScopeFleet

+ const ScopePath

+ const ScopeProduct

+ const ScopeRepo

+ const Sentinel

+ const SkillRulesHeading

+ const SourceDecision

+ const SourceIdea

+ const SourceLesson

+ const SourceURL

+ var DetailFields = []string

+ var DetailSections = []string

+ var EnforcementTiers = []string

+ var ExampleSubsections = []string

+ var MirroredFields = []string

+ var Statuses = []string

+ func ApplyFieldEdits(content []byte, edits []FieldEdit) ([]byte, error)

+ func ClearLessonPromotesTo(lessonPath string) error

+ func DetailPath(rulesDir, slug string) string

+ func DetailsBySlug(rulesDir string) (map[string]*Detail, error)

+ func EnforcementList() string

+ func EnsureIndex(rulesDir string) error

+ func IndexContent() string

+ func IndexPath(rulesDir string) string

+ func IsEnforcement(value string) bool

+ func IsStatus(value string) bool

+ func LessonSources(sources []SourceRef) []string

+ func MergeSources(current, add, remove []string) ([]string, error)

+ func MirroredValuesOf(row Row) map[string]string

+ func ParseEnforcement(value string) (string, bool)

+ func ParsePromotesTo(value string) (slug string, ok bool, err error)

+ func ParseStatus(value string) (string, bool)

+ func PromotesToRef(slug string) string

+ func RemoveRow(rulesDir, slug string) error

+ func RequiresControl(tier string) bool

+ func RulesDir(projectRoot string) string

+ func ScaffoldDetail(opts Options) ([]byte, error)

+ func ScopesMatch(scopes []Scope, p string) bool

+ func SetLessonPromotesTo(lessonPath, ruleSlug string) error

+ func SetSkillRules(skillPath string, slugs []string) error

+ func SkillsByName(skillsDir string) (map[string]*Skill, error)

+ func SkillsDir(projectRoot, configuredPath string) string

+ func StatusList() string

+ func TitleCaseFromSlug(slug string) string

+ func UpsertRow(rulesDir string, row Row) error

+ func ValidateSlug(slug string) error

+ func WriteFileAtomic(path string, data []byte) error

+ func WriteIndexRows(path string, rows []Row, preserved []MalformedRow) error

+ type Detail struct

+ Control string

+ ControlLine int

+ Date string

+ DateLine int

+ Enforcement string

+ EnforcementLine int

+ Exceptions string

+ ExceptionsLine int

+ FieldCounts map[string]int

+ FieldOrder []string

+ FrontmatterStatus string

+ FrontmatterStatusLine int

+ HasRuleTitle bool

+ Owner string

+ OwnerLine int

+ Path string

+ ScopeLine int

+ ScopeText string

+ ScopesRaw []string

+ SectionLines map[string]int

+ SkillRefs []string

+ Slug string

+ SourcesLine int

+ SourcesRaw []string

+ SourcesText string

+ Statement string

+ StatementLine int

+ Status string

+ StatusLine int

+ SubsectionLines map[string]int

+ SupersededBy string

+ SupersededByLine int

+ Supersedes string

+ SupersedesLine int

+ Title string

+ TitleLine int

+ Why string

+ WhyLine int

+ func DiscoverDetails(rulesDir string) ([]*Detail, error)

+ func ParseDetail(path string) (*Detail, error)

+ func (d *Detail) HasControl() bool

+ func (d *Detail) HasSection(title string) bool

+ func (d *Detail) MirroredValues() map[string]string

+ func (d *Detail) MissingExampleSubsections() []string

+ func (d *Detail) MissingSections() []string

+ func (d *Detail) Scopes() ([]Scope, error)

+ func (d *Detail) Sources() ([]SourceRef, error)

+ type FieldEdit struct

+ Name string

+ Value string

+ type IndexReport struct

+ Duplicates []string

+ HeaderSeen bool

+ Malformed []MalformedRow

+ Rows []Row

+ func ReadIndex(path string) (IndexReport, error)

+ func (rep IndexReport) BySlug() map[string]Row

+ func (rep IndexReport) HasMalformed() bool

+ func (rep IndexReport) MalformedExcept(slugs ...string) []MalformedRow

+ func (rep IndexReport) MalformedLines() []int

+ func (rep IndexReport) Slugs() []string

+ type MalformedRow struct

+ Line int

+ Reason string

+ SlugHint string

+ Text string

+ func (m MalformedRow) Repair() (Row, bool)

+ type Options struct

+ Compliant string

+ Control string

+ Date string

+ Enforcement string

+ Exceptions string

+ Instructions string

+ Owner string

+ Scopes []string

+ Skills []string

+ Slug string

+ Sources []string

+ Statement string

+ Status string

+ Supersedes string

+ Title string

+ Violation string

+ Why string

+ func (o *Options) Normalize() error

+ func (o Options) Row(linked bool) Row

+ type Row struct

+ Control string

+ Enforcement string

+ Line int

+ Linked bool

+ Scope string

+ Slug string

+ Sources string

+ Statement string

+ Status string

+ func NewRow(slug string, linked bool, status, statement string, scopes []string, ...) Row

+ func ResolveRow(rulesDir, slug string) (Row, error)

+ func RowFromDetail(d *Detail) Row

+ func (r Row) DetailLink() string

+ func (r Row) Detailed() bool

+ func (r Row) Equals(o Row) bool

+ func (r Row) HasControl() bool

+ func (r Row) Render() string

+ func (r Row) ScopeList() []string

+ func (r Row) SourceList() []string

+ type Scope struct

+ Kind string

+ Raw string

+ Value string

+ func ParseScope(raw string) (Scope, error)

+ func ParseScopes(raws []string) ([]Scope, error)

+ func (s Scope) Matches(p string) bool

+ func (s Scope) String() string

+ type Skill struct

+ Name string

+ Path string

+ RuleRefs []string

+ RulesHeadingLine int

+ func DiscoverSkills(skillsDir string) ([]*Skill, error)

+ type SourceRef struct

+ Kind string

+ Raw string

+ Value string

+ func ParseSource(raw string) (SourceRef, error)

+ func ParseSources(raws []string) ([]SourceRef, error)

+ func (s SourceRef) String() string