-
Notifications
You must be signed in to change notification settings - Fork 197
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.
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
feat(pkg/printer): add yaml and raw printers #133
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
package printer | ||
|
||
import ( | ||
"fmt" | ||
"io" | ||
) | ||
|
||
// PrintRaw is a printer that prints the provided value as is | ||
func PrintRaw(out io.Writer, v interface{}) error { | ||
fmt.Fprintln(out, v) | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
package printer | ||
|
||
import ( | ||
"bytes" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestPrintRaw(t *testing.T) { | ||
v := struct { | ||
A bool | ||
B string | ||
}{ | ||
A: false, | ||
B: "waltz", | ||
} | ||
|
||
b := &bytes.Buffer{} | ||
err := PrintRaw(b, v) | ||
|
||
require.Nil(t, err) | ||
require.Equal(t, "{false waltz}\n", b.String()) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package printer | ||
|
||
import ( | ||
"fmt" | ||
"io" | ||
|
||
"gopkg.in/yaml.v2" | ||
|
||
"github.com/pkg/errors" | ||
) | ||
|
||
// PrintYaml is a printer that prints the provided value in yaml | ||
func PrintYaml(out io.Writer, v interface{}) error { | ||
b, err := yaml.Marshal(v) | ||
if err != nil { | ||
return errors.Wrap(err, "could not marshal value to yaml") | ||
} | ||
fmt.Fprintln(out, string(b)) | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
package printer | ||
|
||
import ( | ||
"bytes" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestPrintYaml(t *testing.T) { | ||
v := struct { | ||
A string | ||
B bool | ||
}{ | ||
A: "foo", | ||
B: true, | ||
} | ||
|
||
b := &bytes.Buffer{} | ||
err := PrintYaml(b, v) | ||
|
||
require.Nil(t, err) | ||
require.Equal(t, "a: foo\nb: true\n\n", b.String()) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So raw is really a dump of the go structure? Let me know if I don't have that right.
What's the use case for this format? json and yaml I see people using that in scripts. If they are chaining the output of this new raw format into a Go program I want to make sure that maybe there isn't an easier way (like making it so that they can use our libraries and functions directly from their code). Or at least making sure that it's a consumable format (e.g. maybe we should be using
%#v
instead).Also once we have hammered out the use case, let's pick a name that describes the format more clearly, e.g. "go" or something along those lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to change to
FormatPlaintext
per getporter/helm2-mixin#12 (comment)