-
Notifications
You must be signed in to change notification settings - Fork 177
/
info.go
153 lines (129 loc) · 3.07 KB
/
info.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
// Copyright 2024 Jetify Inc. and contributors. All rights reserved.
// Use of this source code is governed by the license in the LICENSE file.
package plugin
import (
"bytes"
"context"
"fmt"
"io"
"runtime/trace"
"github.com/pkg/errors"
"github.com/samber/lo"
"go.jetpack.io/devbox/internal/devpkg"
"go.jetpack.io/devbox/internal/services"
)
func Readme(ctx context.Context,
pkg *devpkg.Package,
projectDir string,
markdown bool,
) (string, error) {
defer trace.StartRegion(ctx, "Readme").End()
cfg, err := getConfigIfAny(pkg, projectDir)
if err != nil {
return "", err
}
if cfg == nil {
return "", nil
}
buf := bytes.NewBuffer(nil)
_, _ = fmt.Fprintln(buf, "")
if err = printReadme(cfg, buf, markdown); err != nil {
return "", err
}
if err = printServices(cfg, pkg, buf, markdown); err != nil {
return "", err
}
if err = printCreateFiles(cfg, buf, markdown); err != nil {
return "", err
}
if err = printEnv(cfg, buf, markdown); err != nil {
return "", err
}
if err = printInfoInstructions(pkg.CanonicalName(), buf); err != nil {
return "", err
}
return buf.String(), nil
}
func printReadme(cfg *Config, w io.Writer, markdown bool) error {
if cfg.Description() == "" {
return nil
}
_, err := fmt.Fprintf(
w,
"%s%s NOTES:\n%s\n\n",
lo.Ternary(markdown, "### ", ""),
cfg.Name,
cfg.Description(),
)
return errors.WithStack(err)
}
func printServices(cfg *Config, pkg *devpkg.Package, w io.Writer, markdown bool) error {
_, contentPath := cfg.ProcessComposeYaml()
if contentPath == "" {
return nil
}
content, err := pkg.FileContent(contentPath)
if err != nil {
return errors.WithStack(err)
}
serviceNames, err := services.NamesFromProcessCompose(content)
if err != nil {
return errors.WithStack(err)
}
if len(serviceNames) == 0 {
return nil
}
services := ""
for _, serviceName := range serviceNames {
services += fmt.Sprintf("* %[1]s\n", serviceName)
}
_, err = fmt.Fprintf(
w,
"%sServices:\n%s\nUse `devbox services start|stop [service]` to interact with services\n\n",
lo.Ternary(markdown, "### ", ""),
services,
)
return errors.WithStack(err)
}
func printCreateFiles(cfg *Config, w io.Writer, markdown bool) error {
if len(cfg.CreateFiles) == 0 {
return nil
}
shims := ""
for name, src := range cfg.CreateFiles {
if src != "" {
shims += fmt.Sprintf("* %s\n", name)
}
}
_, err := fmt.Fprintf(
w,
"%sThis plugin creates the following helper files:\n%s\n",
lo.Ternary(markdown, "### ", ""),
shims,
)
return errors.WithStack(err)
}
func printEnv(cfg *Config, w io.Writer, markdown bool) error {
if len(cfg.Env) == 0 {
return nil
}
envVars := ""
for name, value := range cfg.Env {
envVars += fmt.Sprintf("* %s=%s\n", name, value)
}
_, err := fmt.Fprintf(
w,
"%sThis plugin sets the following environment variables:\n%s\n",
lo.Ternary(markdown, "### ", ""),
envVars,
)
return errors.WithStack(err)
}
func printInfoInstructions(pkg string, w io.Writer) error {
_, err := fmt.Fprintf(
w,
"To show this information, run `devbox info %s`\n\n",
pkg,
)
return errors.WithStack(err)
}