Function checkRefs

cmd/cmdexample_check_test.go:26–60

checkRefs validates refs against cat and returns all mismatches in order.

(cat *catalog, refs []ref)

// checkRefs validates refs against cat and returns all mismatches in order.
func checkRefs(cat *catalog, refs []ref) []finding {
	var out []finding
	for _, r := range refs {
		path, n, ok := cat.longestPrefix(r.words)
		if !ok {
			attempted := strings.Join(r.words, " ")
			out = append(out, finding{
				line: r.line, raw: r.raw, kind: unknownCommand,
				path: attempted, suggest: cat.suggestCommand(attempted),
			})
			continue
		}
		// Leftover words after a group node are an unknown subcommand (e.g. a
		// mistyped method like "batch_modify_message"). After a leaf they are
		// positionals (e.g. "api GET /path"), so only groups trigger this.
		if n < len(r.words) && cat.isGroup(path) {
			attempted := strings.Join(r.words, " ")
			out = append(out, finding{
				line: r.line, raw: r.raw, kind: unknownCommand,
				path: attempted, suggest: cat.suggestCommand(attempted),
			})
			continue
		}
		for _, f := range r.flags {
			if cat.hasFlag(path, f) {
				continue
			}
			out = append(out, finding{
				line: r.line, raw: r.raw, kind: unknownFlag,
				path: path, flag: f, suggest: cat.suggestFlag(path, f),
			})
		}
	}
	return out
}