listmarkerspace

package

v0.23.0 Latest Latest Go to latest Published: May 21, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jeduden/mdsmith

Links

Open Source Insights

Documentation ¶

Overview ¶

Package listmarkerspace implements MDS061, which enforces a consistent number of spaces between a list marker and item text, configurable per single-line vs multi-paragraph items and ordered vs unordered lists.

Index ¶

type Rule

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Rule ¶

type Rule struct {
	ULSingle int
	ULMulti  int
	OLSingle int
	OLMulti  int
}

Rule enforces the number of spaces between a list marker and item text.

func (*Rule) ApplySettings ¶

func (r *Rule) ApplySettings(s map[string]any) error

ApplySettings implements rule.Configurable.

func (*Rule) Category ¶

func (r *Rule) Category() string

Category implements rule.Rule.

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) CheckNode ¶ added in v0.23.0

func (r *Rule) CheckNode(n ast.Node, entering bool, f *lint.File) []lint.Diagnostic

CheckNode implements rule.NodeChecker.

func (*Rule) DefaultSettings ¶

func (r *Rule) DefaultSettings() map[string]any

DefaultSettings implements rule.Configurable.

func (*Rule) Fix ¶

func (r *Rule) Fix(f *lint.File) []byte

Fix implements rule.FixableRule.

func (*Rule) ID ¶

func (r *Rule) ID() string

ID implements rule.Rule.

func (*Rule) Name ¶

func (r *Rule) Name() string

Name implements rule.Rule.

Source Files ¶

View all Source files

rule.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL