clerk: internal/linter/rule_undeclared

clerk/internal/linter/rule_undeclared_tag.go (view raw)

Oleksandr Smirnov feat: config (#6), 1 month ago

package linter

import (
	"fmt"

	"olexsmir.xyz/clerk/internal/analyzer"
)

const UndeclaredTagID RuleID = "undeclared-tag"

// UndeclaredTag flags used tag that's not declared via `tag` directive.
type UndeclaredTag struct{}

func (UndeclaredTag) ID() RuleID { return UndeclaredTagID }
func (u *UndeclaredTag) CheckJournal(an *analyzer.Analysis) []Find {
	var finds []Find
	for name, info := range an.Tags {
		if len(info.Directives) > 0 {
			continue
		}
		// default tags
		if name == "date" || name == "date2" || name == "type" {
			continue
		}
		for _, usage := range info.Usage {
			finds = append(finds, Find{
				Code:    u.ID(),
				Span:    usage.Tag.Span,
				Message: fmt.Sprintf("undeclared tag: %s", name),
			})
		}
	}
	return finds
}

1	package linter
2
3	import (
4	"fmt"
5
6	"olexsmir.xyz/clerk/internal/analyzer"
7	)
8
9	const UndeclaredTagID RuleID = "undeclared-tag"
10
11	// UndeclaredTag flags used tag that's not declared via `tag` directive.
12	type UndeclaredTag struct{}
13
14	func (UndeclaredTag) ID() RuleID { return UndeclaredTagID }
15	func (u UndeclaredTag) CheckJournal(an analyzer.Analysis) []Find {
16	var finds []Find
17	for name, info := range an.Tags {
18	if len(info.Directives) > 0 {
19	continue
20	}
21	// default tags
22	if name == "date" \|\| name == "date2" \|\| name == "type" {
23	continue
24	}
25	for _, usage := range info.Usage {
26	finds = append(finds, Find{
27	Code: u.ID(),
28	Span: usage.Tag.Span,
29	Message: fmt.Sprintf("undeclared tag: %s", name),
30	})
31	}
32	}
33	return finds
34	}