Skip to content

cli/templateinit: add links to template READMEs #2576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 22, 2022
Merged

cli/templateinit: add links to template READMEs #2576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51fbea6
cli/templateinit: add links to template READMEs
johnstcn Jun 22, 2022
bf53bcc
fix data races by shadowing
johnstcn Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/cliui/cliui.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ var Styles = struct {
Fuschia: defaultStyles.SelectedMenuItem.Copy(),
Logo: defaultStyles.Logo.SetString("Coder"),
Warn: lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#04B575", Dark: "#ECFD65"}),
Wrap: defaultStyles.Wrap,
Wrap: lipgloss.NewStyle().Width(80),
}
3 changes: 2 additions & 1 deletion cli/templateinit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ func templateInit() *cobra.Command {
exampleByName := map[string]examples.Example{}
for _, example := range exampleList {
name := fmt.Sprintf(
"%s\n%s\n",
"%s\n%s\n%s\n",
cliui.Styles.Bold.Render(example.Name),
cliui.Styles.Wrap.Copy().PaddingLeft(6).Render(example.Description),
cliui.Styles.Keyword.PaddingLeft(6).Render(example.URL),
)
exampleNames = append(exampleNames, name)
exampleByName[name] = example
Expand Down
10 changes: 7 additions & 3 deletions examples/examples.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ var (
//go:embed templates
files embed.FS

examples = make([]Example, 0)
parseExamples sync.Once
archives = singleflight.Group{}
exampleBasePath = "https://github.com/coder/coder/tree/main/examples/templates/"
examples = make([]Example, 0)
parseExamples sync.Once
archives = singleflight.Group{}
)

type Example struct {
ID string `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Description string `json:"description"`
Markdown string `json:"markdown"`
Expand Down Expand Up @@ -52,6 +54,7 @@ func List() ([]Example, error) {
continue
}
exampleID := dir.Name()
exampleURL := exampleBasePath + exampleID
// Each one of these is a example!
readme, err := fs.ReadFile(files, path.Join(dir.Name(), "README.md"))
if err != nil {
Expand Down Expand Up @@ -91,6 +94,7 @@ func List() ([]Example, error) {

examples = append(examples, Example{
ID: exampleID,
URL: exampleURL,
Name: name,
Description: description,
Markdown: string(frontMatter.Content),
Expand Down
19 changes: 15 additions & 4 deletions examples/examples_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"io"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/coder/coder/examples"
Expand All @@ -16,10 +17,20 @@ func TestTemplate(t *testing.T) {
t.Parallel()
list, err := examples.List()
require.NoError(t, err)
require.Greater(t, len(list), 0)

_, err = examples.Archive(list[0].ID)
require.NoError(t, err)
require.NotEmpty(t, list)
for _, eg := range list {
eg := eg
t.Run(eg.ID, func(t *testing.T) {
t.Parallel()
assert.NotEmpty(t, eg.ID, "example ID should not be empty")
assert.NotEmpty(t, eg.URL, "example URL should not be empty")
assert.NotEmpty(t, eg.Name, "example name should not be empty")
assert.NotEmpty(t, eg.Description, "example description should not be empty")
assert.NotEmpty(t, eg.Markdown, "example markdown should not be empty")
_, err := examples.Archive(eg.ID)
assert.NoError(t, err, "error archiving example")
})
}
}

func TestSubdirs(t *testing.T) {
Expand Down