/
renderer.go
71 lines (59 loc) · 1.61 KB
/
renderer.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
// Copyright 2015 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.
package shell
import (
"runtime"
"strings"
"github.com/juju/errors"
"github.com/juju/utils/v3"
"github.com/juju/utils/v3/filepath"
)
// A PathRenderer generates paths that are appropriate for a given
// shell environment.
type PathRenderer interface {
filepath.Renderer
// Quote generates a new string with quotation marks and relevant
// escape/control characters properly escaped. The resulting string
// is wrapped in quotation marks such that it will be treated as a
// single string by the shell.
Quote(str string) string
// ExeSuffix returns the filename suffix for executable files.
ExeSuffix() string
}
// Renderer provides all the functionality needed to generate shell-
// compatible paths and commands.
type Renderer interface {
PathRenderer
CommandRenderer
OutputRenderer
}
// NewRenderer returns a Renderer for the given shell, OS, or distro name.
func NewRenderer(name string) (Renderer, error) {
if name == "" {
name = runtime.GOOS
} else {
name = strings.ToLower(name)
}
// Try known shell names first.
switch name {
case "bash":
return &BashRenderer{}, nil
case "ps", "powershell":
return &PowershellRenderer{}, nil
case "cmd", "batch", "bat":
return &WinCmdRenderer{}, nil
}
// Fall back to operating systems.
switch {
case name == "windows":
return &PowershellRenderer{}, nil
case utils.OSIsUnix(name):
return &BashRenderer{}, nil
}
// Finally try distros.
switch name {
case "ubuntu":
return &BashRenderer{}, nil
}
return nil, errors.NotFoundf("renderer for %q", name)
}