v2.1.0

[pelletier]

This new minor release brings back the commented struct field tag from go-toml v1. It makes it easier to generate default or example configuration files. For instance:

type TLS struct {
	Cipher  string `toml:"cipher"`
	Version string `toml:"version"`
}
type Config struct {
	Host string `toml:"host" comment:"Host IP to connect to."`
	Port int    `toml:"port" comment:"Port of the remote server."`
	Tls  TLS    `toml:"TLS,commented" comment:"Encryption parameters (optional)"`
}
example := Config{
	Host: "127.0.0.1",
	Port: 4242,
	Tls: TLS{
		Cipher:  "AEAD-AES128-GCM-SHA256",
		Version: "TLS 1.3",
	},
}
out, err := toml.Marshal(example)

generates this TOML document:

# Host IP to connect to.
host = '127.0.0.1'
# Port of the remote server.
port = 4242

# Encryption parameters (optional)
# [TLS]
# cipher = 'AEAD-AES128-GCM-SHA256'
# version = 'TLS 1.3'

This feature was often mentioned as a blocker to upgrading from go-toml v1. Hopefully bringing it back in scope will help folks make the transition!

An other noteworthy improvement is on type mismatch errors. They now include the human-readable context, and include the struct field name of the faulty value if applicable.

Before:

toml: cannot store TOML string into a Go int

After:

1| [server]
2| path = "/my/path"
3| port = "bad"
 |        ~~~~~ cannot decode TOML string into struct field toml_test.Server.Port of type int

What's Changed

What's new

• Encoder: add back the commented option by @pelletier in encoder: add back the commented option #893

Fixed bugs

• Decode: fix panic when parsing '0' as a float by @ocean2811 in Decode: fix panic when parsing '0' as a float #887
• Encode: fix ignored indent of array tables by @pelletier in Encode: fix ignored indent of array tables #889
• Unstable/parser: add raw to integers by @pelletier in unstable/parser: add raw to integers #890
• Decode: improve errors on integers and strings by @pelletier in Decode: improve errors on integers and strings #891
• Decode: fix wrong indention for comments on tables by @Felixoid in Decode: fix wrong indention for comments on tables #892

Other changes

• Add support for Go 1.21 by @michalbiesek in Add support for Go 1.21 #885

New Contributors

• @michalbiesek made their first contribution in Add support for Go 1.21 #885
• @ocean2811 made their first contribution in Decode: fix panic when parsing '0' as a float #887

Full Changelog: v2.0.9...v2.1.0

---

This discussion was created from the release v2.1.0.