systemd-lsp 0.2.0

Language Server Protocol implementation for systemd unit files
Documentation 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

package main

import (
	"bytes"
	"fmt"
	"strings"

	md "github.com/JohannesKaufmann/html-to-markdown"
	"golang.org/x/net/html"
)

type SystemdBackend struct{}

func (s *SystemdBackend) ParseDirectives(htmlContent, filter string) ([]Directive, error) {
	doc, err := parseHTML(htmlContent)
	if err != nil {
		return nil, err
	}

	converter := md.NewConverter("", true, nil)
	var directives []Directive
	seen := make(map[string]bool)
	section := ""
	inSection := filter == ""

	var walk func(*html.Node)
	walk = func(n *html.Node) {
		if n.Type == html.ElementNode {
			text := getText(n)

			// Track sections from h2 or strong tags
			if n.Data == "h2" || n.Data == "strong" {
				trackSection(text, filter, &section, &inSection)
			}

			// Extract directives from dt tags
			if n.Data == "dt" && inSection {
				for _, match := range directivePattern.FindAllStringSubmatch(text, -1) {
					name := match[1]
					if seen[name] {
						continue
					}
					seen[name] = true

					desc := ""
					if dd := nextElement(n); dd != nil && dd.Data == "dd" {
						desc = toMarkdown(dd, converter)
						desc = strings.TrimPrefix(desc, "<dd>")
						desc = strings.TrimSuffix(desc, "</dd>")
						desc = strings.TrimSpace(desc)
					}

					directives = append(directives, Directive{Name: name, Description: desc})
				}
			}
		}

		for c := n.FirstChild; c != nil; c = c.NextSibling {
			walk(c)
		}
	}

	walk(doc)
	return directives, nil
}

func (s *SystemdBackend) ExtractDescription(htmlContent, _ string, converter *md.Converter) string {
	doc, err := parseHTML(htmlContent)
	if err != nil {
		return ""
	}

	var found *html.Node
	var walk func(*html.Node) bool
	walk = func(n *html.Node) bool {
		if n.Type == html.ElementNode && n.Data == "h2" {
			for _, attr := range n.Attr {
				if attr.Key == "id" && attr.Val == "Description" {
					var buf bytes.Buffer
					for elem := nextElement(n); elem != nil && elem.Data != "h2"; elem = nextElement(elem) {
						html.Render(&buf, elem)
					}
					found, _ = parseHTML(buf.String())
					return true
				}
			}
		}
		for c := n.FirstChild; c != nil; c = c.NextSibling {
			if walk(c) {
				return true
			}
		}
		return false
	}

	walk(doc)
	if found == nil {
		return ""
	}
	return toMarkdown(found, converter)
}

func (s *SystemdBackend) GenerateAttribution(url string) string {
	name := strings.TrimSuffix(strings.TrimPrefix(url, "https://www.freedesktop.org/software/systemd/man/latest/systemd."), ".html")
	return fmt.Sprintf("*Based on [systemd.%s(5)](https://www.freedesktop.org/software/systemd/man/systemd.%s.html) official documentation.*\n\n", name, name)
}