-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
plugin.go
70 lines (57 loc) · 1.99 KB
/
plugin.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
/*
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package plugin
import (
"encoding/json"
"fmt"
"io"
"os"
)
// Plugin represents a mdBook plugin.
type Plugin interface {
// SupportsOutput checks if the given plugin supports the given output format.
SupportsOutput(string) bool
// Process modifies the book in the input, which gets returned as the result of the plugin.
Process(*Input) error
}
// Run runs the given plugin on the given input stream, outputting its result to the given
// result, assuming the given command-line args (without program name).
func Run(plug Plugin, inputRaw io.Reader, outputRaw io.Writer, args ...string) error {
if len(args) > 1 && args[0] == "supports" {
// we support any renderer, no need to check (name is in Args[1])
if plug.SupportsOutput(args[1]) {
return nil
}
return fmt.Errorf("output format %q not supported", args[1])
}
var input Input
dec := json.NewDecoder(inputRaw)
if err := dec.Decode(&input); err != nil {
return fmt.Errorf("unable to decode preprocessor input: %v", err)
}
if err := plug.Process(&input); err != nil {
return err
}
out, err := json.Marshal(&input.Book)
if err != nil {
return fmt.Errorf("unable to encode output book object: %v", err)
}
if n, err := outputRaw.Write(out); err != nil || n < len(out) {
if err == nil && n < len(out) {
err = io.ErrShortWrite
}
return fmt.Errorf("unable to write output book object: %v", err)
}
os.WriteFile("/tmp/litout.json", out, os.ModePerm)
return nil
}