Documentation
¶
Overview ¶
Package orderedlistnumbering implements MDS046, which pins how ordered list items are numbered in the source: literal sequential (1. 2. 3.) or all-ones (1. 1. 1.). CommonMark renders both the same, but the choice controls what the source text shows authors and reviewers.
Index ¶
- Constants
- 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) Fix(f *lint.File) []byte
- func (r *Rule) ID() string
- func (r *Rule) Name() string
Constants ¶
const ( StyleSequential = "sequential" StyleAllOnes = "all-ones" )
Style values for the rule's `style` setting.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Rule ¶
Rule pins the numbering style of ordered lists in source.
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-list 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. The rule is opt-in: users pick a project convention and turn the rule on.
Source Files