Documentation
¶
Overview ¶
Package forbiddentext implements MDS056, which flags paragraphs whose plain text contains any configured substring.
Index ¶
- type Rule
- func (r *Rule) ApplySettings(s map[string]any) error
- func (r *Rule) Category() string
- func (r *Rule) Check(f *lint.File) []lint.Diagnostic
- func (r *Rule) CheckNode(n ast.Node, entering bool, f *lint.File) []lint.Diagnostic
- func (r *Rule) DefaultSettings() map[string]any
- func (r *Rule) EnabledByDefault() bool
- func (r *Rule) ID() string
- func (r *Rule) Name() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Rule ¶
type Rule struct {
Contains []string
}
Rule flags paragraphs whose plain text contains one of the configured substrings. Each match emits a diagnostic at the paragraph's start line so the per-scope override in plan 146 keeps only diagnostics that fall inside the configured section's line range.
func (*Rule) ApplySettings ¶
ApplySettings implements rule.Configurable.
func (*Rule) Check ¶
func (r *Rule) Check(f *lint.File) []lint.Diagnostic
Check implements rule.Rule. The per-paragraph logic is pure and stateless, so it is expressed as CheckNode and the engine can fold this rule into one shared AST walk; a direct call still works via rule.WalkNodes.
func (*Rule) DefaultSettings ¶
DefaultSettings implements rule.Configurable.
func (*Rule) EnabledByDefault ¶
EnabledByDefault implements rule.Defaultable.
Source Files