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

rules

package

Go to main page

Versions in this module

v0

v0.3.5

Aug 25, 2026

v0.3.4

Aug 25, 2026

v0.3.3

Aug 25, 2026

v0.3.2

Aug 25, 2026

v0.3.1

Aug 24, 2026

Changes in this version

+ type ArchitectureComplexityRule struct

+ func (ArchitectureComplexityRule) Category() string

+ func (ArchitectureComplexityRule) Description() string

+ func (ArchitectureComplexityRule) ID() string

+ func (ArchitectureComplexityRule) Name() string

+ func (ArchitectureComplexityRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (ArchitectureComplexityRule) Severity() report.Severity

+ type ConfigurationLintRule struct

+ func (ConfigurationLintRule) Category() string

+ func (ConfigurationLintRule) Description() string

+ func (ConfigurationLintRule) ID() string

+ func (ConfigurationLintRule) Name() string

+ func (ConfigurationLintRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (ConfigurationLintRule) Severity() report.Severity

+ type DockerBestPracticesRule struct

+ func (DockerBestPracticesRule) Category() string

+ func (DockerBestPracticesRule) Description() string

+ func (DockerBestPracticesRule) ID() string

+ func (DockerBestPracticesRule) Name() string

+ func (DockerBestPracticesRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (DockerBestPracticesRule) Severity() report.Severity

+ type DocumentationCompletenessRule struct

+ func (DocumentationCompletenessRule) Category() string

+ func (DocumentationCompletenessRule) Description() string

+ func (DocumentationCompletenessRule) ID() string

+ func (DocumentationCompletenessRule) Name() string

+ func (DocumentationCompletenessRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (DocumentationCompletenessRule) Severity() report.Severity

+ type SecurityHardcodedIPRule struct

+ func (SecurityHardcodedIPRule) Category() string

+ func (SecurityHardcodedIPRule) Description() string

+ func (SecurityHardcodedIPRule) ID() string

+ func (SecurityHardcodedIPRule) Name() string

+ func (SecurityHardcodedIPRule) Severity() report.Severity

+ func (r SecurityHardcodedIPRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type SecuritySQLInjectionRule struct

+ func (SecuritySQLInjectionRule) Category() string

+ func (SecuritySQLInjectionRule) Description() string

+ func (SecuritySQLInjectionRule) ID() string

+ func (SecuritySQLInjectionRule) Name() string

+ func (SecuritySQLInjectionRule) Severity() report.Severity

+ func (r SecuritySQLInjectionRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type SecurityWeakCryptoRule struct

+ func (SecurityWeakCryptoRule) Category() string

+ func (SecurityWeakCryptoRule) Description() string

+ func (SecurityWeakCryptoRule) ID() string

+ func (SecurityWeakCryptoRule) Name() string

+ func (SecurityWeakCryptoRule) Severity() report.Severity

+ func (r SecurityWeakCryptoRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type SecurityXSSRule struct

+ func (SecurityXSSRule) Category() string

+ func (SecurityXSSRule) Description() string

+ func (SecurityXSSRule) ID() string

+ func (SecurityXSSRule) Name() string

+ func (SecurityXSSRule) Severity() report.Severity

+ func (r SecurityXSSRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

v0.3.0

Aug 20, 2026

Changes in this version

+ type ConfigValidationRule struct

+ func (ConfigValidationRule) Category() string

+ func (ConfigValidationRule) Description() string

+ func (ConfigValidationRule) ID() string

+ func (ConfigValidationRule) Name() string

+ func (ConfigValidationRule) Severity() report.Severity

+ func (r ConfigValidationRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type DependenciesRule struct

+ func (DependenciesRule) Category() string

+ func (DependenciesRule) Description() string

+ func (DependenciesRule) ID() string

+ func (DependenciesRule) Name() string

+ func (DependenciesRule) Severity() report.Severity

+ func (r DependenciesRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type FeaturesConsistencyRule struct

+ func (FeaturesConsistencyRule) Category() string

+ func (FeaturesConsistencyRule) Description() string

+ func (FeaturesConsistencyRule) ID() string

+ func (FeaturesConsistencyRule) Name() string

+ func (FeaturesConsistencyRule) Severity() report.Severity

+ func (r FeaturesConsistencyRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type PostgreSQLRule struct

+ func (PostgreSQLRule) Category() string

+ func (PostgreSQLRule) Description() string

+ func (PostgreSQLRule) ID() string

+ func (PostgreSQLRule) Name() string

+ func (PostgreSQLRule) Severity() report.Severity

+ func (r PostgreSQLRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

v0.1.2

Aug 9, 2026

v0.1.1

Aug 9, 2026

Changes in this version

+ type ArchitectureRule struct

+ Rules []config.ArchitectureRule

+ func (r ArchitectureRule) Category() string

+ func (r ArchitectureRule) Description() string

+ func (r ArchitectureRule) ID() string

+ func (r ArchitectureRule) Name() string

+ func (r ArchitectureRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (r ArchitectureRule) Severity() report.Severity

+ type Context struct

+ Extra map[string]any

+ GoVersion string

+ Language string

+ ProjectRoot string

+ type DockerRule struct

+ func (DockerRule) Category() string

+ func (DockerRule) Description() string

+ func (DockerRule) ID() string

+ func (DockerRule) Name() string

+ func (DockerRule) Run(_ context.Context, _ Context) ([]report.Finding, error)

+ func (DockerRule) Severity() report.Severity

+ type EnvFileRule struct

+ func (EnvFileRule) Category() string

+ func (EnvFileRule) Description() string

+ func (EnvFileRule) ID() string

+ func (EnvFileRule) Name() string

+ func (EnvFileRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (EnvFileRule) Severity() report.Severity

+ type GitRule struct

+ func (GitRule) Category() string

+ func (GitRule) Description() string

+ func (GitRule) ID() string

+ func (GitRule) Name() string

+ func (GitRule) Run(_ context.Context, _ Context) ([]report.Finding, error)

+ func (GitRule) Severity() report.Severity

+ type GoModRule struct

+ func (GoModRule) Category() string

+ func (GoModRule) Description() string

+ func (GoModRule) ID() string

+ func (GoModRule) Name() string

+ func (GoModRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (GoModRule) Severity() report.Severity

+ type GoVersionRule struct

+ func (GoVersionRule) Category() string

+ func (GoVersionRule) Description() string

+ func (GoVersionRule) ID() string

+ func (GoVersionRule) Name() string

+ func (GoVersionRule) Run(_ context.Context, _ Context) ([]report.Finding, error)

+ func (GoVersionRule) Severity() report.Severity

+ type GracefulShutdownRule struct

+ func (GracefulShutdownRule) Category() string

+ func (GracefulShutdownRule) Description() string

+ func (GracefulShutdownRule) ID() string

+ func (GracefulShutdownRule) Name() string

+ func (GracefulShutdownRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (GracefulShutdownRule) Severity() report.Severity

+ type Registry struct

+ func AnalyzeRules(cfg configLoader) *Registry

+ func CheckRules(cfg configLoader) *Registry

+ func DoctorRules() *Registry

+ func NewRegistry(rules ...Rule) *Registry

+ func (r *Registry) Add(rule Rule)

+ func (r *Registry) Rules() []Rule

+ func (r *Registry) Run(ctx context.Context, rctx Context) ([]report.Finding, error)

+ type Rule interface

+ Category func() string

+ Description func() string

+ ID func() string

+ Name func() string

+ Run func(ctx context.Context, rctx Context) ([]report.Finding, error)

+ Severity func() report.Severity

+ type SecurityCORSRule struct

+ func (SecurityCORSRule) Category() string

+ func (SecurityCORSRule) Description() string

+ func (SecurityCORSRule) ID() string

+ func (SecurityCORSRule) Name() string

+ func (SecurityCORSRule) Severity() report.Severity

+ func (r SecurityCORSRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type SecuritySecretsRule struct

+ func (SecuritySecretsRule) Category() string

+ func (SecuritySecretsRule) Description() string

+ func (SecuritySecretsRule) ID() string

+ func (SecuritySecretsRule) Name() string

+ func (SecuritySecretsRule) Severity() report.Severity

+ func (r SecuritySecretsRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ type SecuritySensitiveFilesRule struct

+ func (SecuritySensitiveFilesRule) Category() string

+ func (SecuritySensitiveFilesRule) Description() string

+ func (SecuritySensitiveFilesRule) ID() string

+ func (SecuritySensitiveFilesRule) Name() string

+ func (SecuritySensitiveFilesRule) Run(_ context.Context, rctx Context) ([]report.Finding, error)

+ func (SecuritySensitiveFilesRule) Severity() report.Severity

+ type StaticConfigLoader struct

+ Rules []config.ArchitectureRule

+ func (s StaticConfigLoader) ArchitectureRules() []config.ArchitectureRule