jimeh/go-render
1
0
Fork 0
mirror of https://github.com/jimeh/go-render.git synced 2026-02-19 03:16:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: correct typos and align struct field tags (#12)

Browse Source 
Fixes typos in package documentation and variable names. Aligns 
struct field tags in examples and tests for better readability.
This commit is contained in:
Jim Myhrberg
2025-06-11 03:15:29 +01:00
committed by GitHub
parent 64d24259e3
commit 1b8fb22499
10 changed files with 53 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -73,8 +73,8 @@ The above assumes the following `Version` struct:
```go ```go
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
func (v *Version) String() string { func (v *Version) String() string {

6
binary.go
View File

@@ -6,7 +6,7 @@ import (
"io" "io"
) )
// Binary can render values which implment the encoding.BinaryMarshaler // Binary can render values which implement the encoding.BinaryMarshaler
// interface. // interface.
type Binary struct{} type Binary struct{}
@@ -15,8 +15,8 @@ var (
_ FormatsHandler = (*Binary)(nil) _ FormatsHandler = (*Binary)(nil)
) )
// Render writes result of calling MarshalBinary() on v. If v does not implment // Render writes result of calling MarshalBinary() on v. If v does not implement
// encoding.BinaryMarshaler the ErrCannotRander error will be returned. // encoding.BinaryMarshaler the ErrCannotRender error will be returned.
func (br *Binary) Render(w io.Writer, v any) error { func (br *Binary) Render(w io.Writer, v any) error {
x, ok := v.(encoding.BinaryMarshaler) x, ok := v.(encoding.BinaryMarshaler)
if !ok { if !ok {

18
compact_example_test.go
View File

@@ -13,12 +13,12 @@ import (
func ExampleCompact_json() { func ExampleCompact_json() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -47,12 +47,12 @@ func ExampleCompact_json() {
func ExampleCompact_yaml() { func ExampleCompact_yaml() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -98,12 +98,12 @@ func ExampleCompact_yaml() {
func ExampleCompact_xml() { func ExampleCompact_xml() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`

2
interfaces.go
View File

@@ -3,7 +3,7 @@ package render
import "io" import "io"
// Handler interface is for single format renderers, which can only render a // Handler interface is for single format renderers, which can only render a
// single format. It is the basis of the multi-format support offerred by the // single format. It is the basis of the multi-format support offered by the
// render package. // render package.
type Handler interface { type Handler interface {
// Render writes v into w in the format that the Handler supports. // Render writes v into w in the format that the Handler supports.

18
pretty_example_test.go
View File

@@ -12,12 +12,12 @@ import (
func ExamplePretty_json() { func ExamplePretty_json() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -75,12 +75,12 @@ func ExamplePretty_json() {
func ExamplePretty_yaml() { func ExamplePretty_yaml() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -125,12 +125,12 @@ func ExamplePretty_yaml() {
func ExamplePretty_xml() { func ExamplePretty_xml() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`

2
render.go
View File

@@ -1,4 +1,4 @@
// Package render provides a simple and flexible solutio to render a value to a // Package render provides a simple and flexible solution to render a value to a
// io.Writer using different formats based on a format string argument. // io.Writer using different formats based on a format string argument.
// //
// It is designed around using a custom type/struct to render your output. // It is designed around using a custom type/struct to render your output.

42
render_example_test.go
View File

@@ -12,8 +12,8 @@ import (
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
func (v *Version) WriteTo(w io.Writer) (int64, error) { func (v *Version) WriteTo(w io.Writer) (int64, error) {
@@ -26,7 +26,7 @@ func (v *Version) WriteTo(w io.Writer) (int64, error) {
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -60,12 +60,12 @@ func (ol *OutputList) String() string {
func ExampleRender_compactJSON() { func ExampleRender_compactJSON() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -94,12 +94,12 @@ func ExampleRender_compactJSON() {
func ExampleRender_compactYAML() { func ExampleRender_compactYAML() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -145,12 +145,12 @@ func ExampleRender_compactYAML() {
func ExampleRender_compactXML() { func ExampleRender_compactXML() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -295,12 +295,12 @@ func ExampleRender_compactTextFromStringer() {
func ExampleRender_prettyJSON() { func ExampleRender_prettyJSON() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -358,12 +358,12 @@ func ExampleRender_prettyJSON() {
func ExampleRender_prettyYAML() { func ExampleRender_prettyYAML() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
@@ -408,12 +408,12 @@ func ExampleRender_prettyYAML() {
func ExampleRender_prettyXML() { func ExampleRender_prettyXML() {
type Version struct { type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"` Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"` Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type OutputList struct { type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"` Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`

2
render_test.go
View File

@@ -132,7 +132,7 @@ type renderFormatTestCase struct {
} }
// "binary" format. // "binary" format.
var binaryFormattestCases = []renderFormatTestCase{ var binaryFormatTestCases = []renderFormatTestCase{
{ {
name: "with binary marshaler", name: "with binary marshaler",
formats: []string{"binary", "bin"}, formats: []string{"binary", "bin"},

2
renderer.go
View File

@@ -105,7 +105,7 @@ func (r *Renderer) Pretty(w io.Writer, format string, v any) error {
} }
// NewWith creates a new Renderer with the formats given, if they have handlers // NewWith creates a new Renderer with the formats given, if they have handlers
// in the currener Renderer. It essentially allows to restrict a Renderer to a // in the current Renderer. It essentially allows to restrict a Renderer to a
// only a sub-set of supported formats. // only a sub-set of supported formats.
func (r *Renderer) NewWith(formats ...string) *Renderer { func (r *Renderer) NewWith(formats ...string) *Renderer {
handlers := make(map[string]Handler, len(formats)) handlers := make(map[string]Handler, len(formats))

10
renderer_test.go
View File

@@ -112,13 +112,13 @@ func TestRenderer_Add(t *testing.T) {
want: []string{"tackle"}, want: []string{"tackle"},
}, },
{ {
name: "hander with Formats", name: "handler with Formats",
format: "hackle", format: "hackle",
handler: &mockFormatsHandler{formats: []string{"hackle"}}, handler: &mockFormatsHandler{formats: []string{"hackle"}},
want: []string{"hackle"}, want: []string{"hackle"},
}, },
{ {
name: "hander with alias formats", name: "handler with alias formats",
format: "hackle", format: "hackle",
handler: &mockFormatsHandler{formats: []string{"hackle", "hack"}}, handler: &mockFormatsHandler{formats: []string{"hackle", "hack"}},
want: []string{"hackle", "hack"}, want: []string{"hackle", "hack"},
@@ -471,7 +471,7 @@ func TestRenderer_Pretty(t *testing.T) {
func TestRenderer_RenderAllFormats(t *testing.T) { func TestRenderer_RenderAllFormats(t *testing.T) {
tests := []renderFormatTestCase{} tests := []renderFormatTestCase{}
tests = append(tests, binaryFormattestCases...) tests = append(tests, binaryFormatTestCases...)
tests = append(tests, jsonFormatTestCases...) tests = append(tests, jsonFormatTestCases...)
tests = append(tests, textFormatTestCases...) tests = append(tests, textFormatTestCases...)
tests = append(tests, xmlFormatTestCases...) tests = append(tests, xmlFormatTestCases...)
@@ -540,7 +540,7 @@ func TestRenderer_RenderAllFormats(t *testing.T) {
func TestRenderer_CompactAllFormats(t *testing.T) { func TestRenderer_CompactAllFormats(t *testing.T) {
tests := []renderFormatTestCase{} tests := []renderFormatTestCase{}
tests = append(tests, binaryFormattestCases...) tests = append(tests, binaryFormatTestCases...)
tests = append(tests, jsonFormatTestCases...) tests = append(tests, jsonFormatTestCases...)
tests = append(tests, textFormatTestCases...) tests = append(tests, textFormatTestCases...)
tests = append(tests, xmlFormatTestCases...) tests = append(tests, xmlFormatTestCases...)
@@ -602,7 +602,7 @@ func TestRenderer_CompactAllFormats(t *testing.T) {
func TestRenderer_PrettyAllFormats(t *testing.T) { func TestRenderer_PrettyAllFormats(t *testing.T) {
tests := []renderFormatTestCase{} tests := []renderFormatTestCase{}
tests = append(tests, binaryFormattestCases...) tests = append(tests, binaryFormatTestCases...)
tests = append(tests, jsonFormatTestCases...) tests = append(tests, jsonFormatTestCases...)
tests = append(tests, textFormatTestCases...) tests = append(tests, textFormatTestCases...)
tests = append(tests, xmlFormatTestCases...) tests = append(tests, xmlFormatTestCases...)