clerk: internal/linter/rule_missing_commodity.go (42ed6f19392789706708b1171eb08e16905f6b8e)

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

Oleksandr Smirnov linter: add missing-commodity, 1 month ago

package linter

import "olexsmir.xyz/clerk/journal/ast"

// MissingCommodity flags amounts with a missing commodity.
type MissingCommodity struct{}

func (MissingCommodity) ID() RuleID          { return "missing-commodity" }
func (MissingCommodity) Severity() Severity  { return SeverityWarning }
func (MissingCommodity) Description() string { return "amount missing commodity" }
func (m *MissingCommodity) CheckEntry(entry ast.Entry) []Find {
	txn, ok := entry.(*ast.Transaction)
	if !ok || (txn.Postings != nil && len(txn.Postings) == 0) {
		return nil
	}

	var finds []Find
	for _, posting := range txn.Postings {
		if posting.Amount == nil {
			continue
		}
		if posting.Amount.Commodity == "" {
			finds = append(finds, Find{
				Code:     m.ID(),
				Severity: m.Severity(),
				Message:  m.Description(),
				Span:     posting.Amount.Span,
			})
		}
	}
	return finds
}

1	package linter
2
3	import "olexsmir.xyz/clerk/journal/ast"
4
5	// MissingCommodity flags amounts with a missing commodity.
6	type MissingCommodity struct{}
7
8	func (MissingCommodity) ID() RuleID { return "missing-commodity" }
9	func (MissingCommodity) Severity() Severity { return SeverityWarning }
10	func (MissingCommodity) Description() string { return "amount missing commodity" }
11	func (m *MissingCommodity) CheckEntry(entry ast.Entry) []Find {
12	txn, ok := entry.(*ast.Transaction)
13	if !ok \|\| (txn.Postings != nil && len(txn.Postings) == 0) {
14	return nil
15	}
16
17	var finds []Find
18	for _, posting := range txn.Postings {
19	if posting.Amount == nil {
20	continue
21	}
22	if posting.Amount.Commodity == "" {
23	finds = append(finds, Find{
24	Code: m.ID(),
25	Severity: m.Severity(),
26	Message: m.Description(),
27	Span: posting.Amount.Span,
28	})
29	}
30	}
31	return finds
32	}