describe/describe.go


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

package describe

import (
	"bufio"
	"os"
	"pik/model"
	"strings"
)

var DescriptionPrefixes = []string{
	"#",
	"//",
}

var descriptions = make(map[model.Target]*string)

func Describe(key model.Target, file string) (string, error) {
	if d := descriptions[key]; d != nil {
		return *d, nil
	}
	fd, err := os.Open(file)
	if err != nil {
		msg := err.Error()
		descriptions[key] = &msg
		return "", err
	}
	defer fd.Close()
	scanner := bufio.NewScanner(fd)
	scanner.Split(bufio.ScanLines)
	scanner.Scan()
	text := scanner.Text()
	if strings.HasPrefix(text, "#!") {
		scanner.Scan()
		text = scanner.Text()
	}
	text = strings.TrimSpace(text)
	if !strings.HasPrefix(text, "#") {
		return "", nil
	}
	for _, c := range DescriptionPrefixes {
		text = strings.TrimPrefix(text, c)
		text = strings.TrimSpace(text)
	}
	descriptions[key] = &text
	return text, nil
}