-
-
Notifications
You must be signed in to change notification settings - Fork 145
/
adoc.go
272 lines (224 loc) · 5.77 KB
/
adoc.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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
package lint
import (
"bytes"
"errors"
"fmt"
"os"
"os/exec"
"regexp"
"strings"
"github.com/errata-ai/vale/v2/internal/core"
)
// NOTE: Asciidoctor converts "'" to "’".
//
// See #206.
var adocSanitizer = strings.NewReplacer(
"\u2018", "'",
"\u2019", "'",
"\u201C", "“",
"\u201D", "”",
"’", "'",
"’", "'")
// Convert listing blocks of the form `[source,.+]` to `[source]`
var reSource = regexp.MustCompile(`\[source,.+\]`)
var reComment = regexp.MustCompile(`// .+`)
var homes = []*regexp.Regexp{
// Homebrew
regexp.MustCompile(`(?m)GEM_HOME="(.+?)"`),
// rbenv
regexp.MustCompile(`(?m)^exec "(.+?)"`),
}
var adocDomain = "localhost:7070"
var adocURL = "http://" + adocDomain
var adocRunning = false
var adocServer = `require 'socket'
require 'asciidoctor'
server = TCPServer.new("localhost", 7070)
loop do
socket = server.accept
headers = {}
while message = socket.gets
line = message.split(' ', 2)
break if line[0] == ""
headers[line[0].chop] = line[1].chop
end
data = socket.read(headers["Content-Length"].to_i)
next if data.strip == "" # TODO: Why?
data = data.encode("utf-8", :invalid => :replace, :undef => :replace, :replace => '')
response = Asciidoctor.convert(data, :header_footer => false, # -s
:attributes => %w(ATTRS),
:safe => :secure)
socket.print "HTTP/1.1 200 OK\r\n" +
"Content-Type: text/plain\r\n" +
"Content-Length: #{response.bytesize}\r\n" +
"Connection: close\r\n"
socket.print "\r\n"
socket.print response
socket.close
end`
func (l *Linter) lintADoc(f *core.File) error {
var html string
var err error
exe := core.Which([]string{"asciidoctor"})
if exe == "" {
return core.NewE100("lintAdoc", errors.New("asciidoctor not found"))
}
s, err := l.applyPatterns(f.Content, "\n----\n$1\n----\n", "`$1`", ".adoc")
if err != nil {
return err
}
s = adocSanitizer.Replace(s)
attrs := l.Manager.Config.Asciidoctor
if !l.HasDir {
html, err = callAdoc(f, s, exe, attrs)
if err != nil {
return core.NewE100(f.Path, err)
}
} else if err = l.startAdocServer(exe, attrs); err != nil {
html, err = callAdoc(f, s, exe, attrs)
if err != nil {
return core.NewE100(f.Path, err)
}
} else {
html, err = l.post(f, s, adocURL)
if err != nil {
html, err = callAdoc(f, s, exe, attrs)
if err != nil {
return core.NewE100(f.Path, err)
}
}
}
html = adocSanitizer.Replace(html)
body := reSource.ReplaceAllStringFunc(f.Content, func(m string) string {
offset := 0
if strings.HasSuffix(m, ",]") {
offset = 1
m = strings.Replace(m, ",]", "]", 1)
}
// NOTE: This is required to avoid finding matches in block attributes.
//
// See https://github.com/errata-ai/vale/issues/296.
parts := strings.Split(m, ",")
span := strings.Repeat("*", len(parts[len(parts)-1])-2+offset)
return "[source, " + span + "]"
})
body = reComment.ReplaceAllStringFunc(body, func(m string) string {
// NOTE: This is required to avoid finding matches in line comments.
//
// See https://github.com/errata-ai/vale/issues/414.
//
// TODO: Multiple line comments are not handled correctly.
//
// https://docs.asciidoctor.org/asciidoc/latest/comments/
parts := strings.Split(m, "//")
span := strings.Repeat("*", len(parts[1])-1)
return "// " + span
})
f.Content = body
return l.lintHTMLTokens(f, []byte(html), 0)
}
func (l *Linter) startAdocServer(exe string, attrs map[string]string) error {
if adocRunning {
return nil
}
var adocArgs = []string{
"notitle!",
"attribute-missing=drop",
}
adocArgs = append(adocArgs, parseAttributes(attrs)...)
ruby := core.Which([]string{"ruby", "jruby"})
if ruby == "" {
return core.NewE100("startAdoc", errors.New("ruby not found"))
}
home, err := findGems(exe)
if err != nil {
return err
} else if home == "" {
return errors.New("GEM_HOME parsing failed")
}
adocServer = strings.Replace(
adocServer,
"ATTRS",
strings.Join(adocArgs, " "),
1,
)
tmpfile, _ := os.CreateTemp("", "server.*.rb")
if _, err = tmpfile.WriteString(adocServer); err != nil {
return err
}
if err = tmpfile.Close(); err != nil {
return err
}
cmd := exec.Command(ruby, tmpfile.Name())
cmd.Env = append(os.Environ(),
"GEM_HOME="+home,
)
if err = cmd.Start(); err != nil {
return err
}
l.pids = append(l.pids, cmd.Process.Pid)
l.temps = append(l.temps, tmpfile)
if err = ping(adocDomain); err != nil {
return err
}
adocRunning = true
return nil
}
func callAdoc(f *core.File, text, exe string, attrs map[string]string) (string, error) {
var out bytes.Buffer
var eut bytes.Buffer
var adocArgs = []string{
"-s",
"-a",
"notitle!",
"-a",
"attribute-missing=drop",
}
adocArgs = append(adocArgs, parseAttributes(attrs)...)
adocArgs = append(adocArgs, []string{"--quiet",
"--safe-mode",
"secure",
"-"}...)
cmd := exec.Command(exe, adocArgs...)
cmd.Stdin = strings.NewReader(text)
cmd.Stdout = &out
cmd.Stderr = &eut
if err := cmd.Run(); err != nil {
return "", core.NewE100(f.Path, errors.New(eut.String()))
}
return out.String(), nil
}
func findGems(exe string) (string, error) {
var home string
for _, v := range []string{"GEM_HOME"} {
candidate := os.Getenv(v)
if candidate != "" {
return candidate, nil
}
}
bin, err := os.ReadFile(exe)
if err != nil {
return home, err
}
f := string(bin)
for _, opt := range homes {
m := opt.FindStringSubmatch(f)
if len(m) > 1 {
home = m[1]
}
}
return home, nil
}
func parseAttributes(attrs map[string]string) []string {
var adocArgs []string
for k, v := range attrs {
entry := fmt.Sprintf("%s=%s", k, v)
if v == "YES" {
entry = k
} else if v == "NO" {
entry = k + "!"
}
adocArgs = append(adocArgs, []string{"-a", entry}...)
}
return adocArgs
}