Documentation
¶
Overview ¶
Package listmarkerstyle implements MDS045, which pins the bullet character for unordered lists. CommonMark accepts `-`, `*`, and `+` interchangeably; this rule requires a single marker (or a rotation by depth) to reduce diff noise and aid visual scanning.
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) 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 ¶
View Source
const ( StyleDash = "dash" StyleAsterisk = "asterisk" StylePlus = "plus" )
Style values for the rule's `style` setting.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Rule ¶
Rule pins the marker character for unordered lists.
func (*Rule) ApplySettings ¶
ApplySettings implements rule.Configurable.
func (*Rule) Check ¶
func (r *Rule) Check(f *lint.File) []lint.Diagnostic
Check implements rule.Rule.
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
Click to show internal directories.
Click to hide internal directories.