fix(deps): update module github.com/pelletier/go-toml to v2 #472

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 https://github.com/pelletier/go-toml/pull/893

Fixed bugs

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

Other changes

Add support for Go 1.21 by @michalbiesek in https://github.com/pelletier/go-toml/pull/885

New Contributors

@michalbiesek made their first contribution in https://github.com/pelletier/go-toml/pull/885
@ocean2811 made their first contribution in https://github.com/pelletier/go-toml/pull/887

Full Changelog: pelletier/go-toml@v2.0.9...v2.1.0

`v2.0.9`

Compare Source

What's Changed

Fixed bugs

Encode: fix support for arrays by @MrJetBOX in https://github.com/pelletier/go-toml/pull/876
Decode: assign empty struct to empty defined sections by @dbarrosop in https://github.com/pelletier/go-toml/pull/879

Other changes

build(deps): bump github.com/stretchr/testify from 1.8.3 to 1.8.4 by @dependabot in https://github.com/pelletier/go-toml/pull/877

New Contributors

@MrJetBOX made their first contribution in https://github.com/pelletier/go-toml/pull/876
@dbarrosop made their first contribution in https://github.com/pelletier/go-toml/pull/879

Full Changelog: pelletier/go-toml@v2.0.8...v2.0.9

`v2.0.8`

Compare Source

What's Changed

What's new

Support MarshalText/UnmarshalText for map keys by @gordon-klotho in https://github.com/pelletier/go-toml/pull/863
Experimental: comments support in unstable/Parser by @pelletier in https://github.com/pelletier/go-toml/pull/860

Fixed bugs

Decode: fix decode into unsettable structs by @pelletier in https://github.com/pelletier/go-toml/pull/868

Documentation

Add example on how to use TextUnmarshaler by @pelletier in https://github.com/pelletier/go-toml/pull/867

New Contributors

@manunio made their first contribution in https://github.com/pelletier/go-toml/pull/861
@gordon-klotho made their first contribution in https://github.com/pelletier/go-toml/pull/863

Full Changelog: pelletier/go-toml@v2.0.7...v2.0.8

`v2.0.7`

Compare Source

What's Changed

Fixed bugs

Encode: fix inline table first key value whitespace by @cuonglm in https://github.com/pelletier/go-toml/pull/837
Decode: allow integers to be unmarshaled into floats by @PotatoesFall in https://github.com/pelletier/go-toml/pull/841
Decode: fix error reporting of type mismatch on inline tables by @pelletier in https://github.com/pelletier/go-toml/pull/853
Decode: fix panic when unmarshaling into a map twice by @pelletier in https://github.com/pelletier/go-toml/pull/854

Documentation

Fix typos by @deining in https://github.com/pelletier/go-toml/pull/849

New Contributors

@DavidKorczynski made their first contribution in https://github.com/pelletier/go-toml/pull/831
@cuonglm made their first contribution in https://github.com/pelletier/go-toml/pull/837
@PotatoesFall made their first contribution in https://github.com/pelletier/go-toml/pull/841
@deining made their first contribution in https://github.com/pelletier/go-toml/pull/849

Full Changelog: pelletier/go-toml@v2.0.6...v2.0.7

`v2.0.6`

Compare Source

What's Changed

What's new

Expose parser API as unstable by @pelletier in https://github.com/pelletier/go-toml/pull/827

Performance

Reduce init time allocation when declaring types used for reflect by @dolmen in https://github.com/pelletier/go-toml/pull/821

Other changes

refactor: Use typeMismatchError rather than raw string error by @jidicula in https://github.com/pelletier/go-toml/pull/826
build(deps): bump github.com/stretchr/testify from 1.8.0 to 1.8.1 by @dependabot in https://github.com/pelletier/go-toml/pull/825
build(deps): bump actions/setup-go from 2 to 3 by @dependabot in https://github.com/pelletier/go-toml/pull/820

New Contributors

@dolmen made their first contribution in https://github.com/pelletier/go-toml/pull/821

Full Changelog: pelletier/go-toml@v2.0.5...v2.0.6

`v2.0.5`

Compare Source

What's Changed

Fixed bugs

Fix reflect.Pointer backward compatibility by @pelletier in https://github.com/pelletier/go-toml/pull/813

Full Changelog: pelletier/go-toml@v2.0.4...v2.0.5

`v2.0.4`

Compare Source

This version has compatibility issues with Go <= 1.17. Though go-toml doesn't officially support Go less than 2 versions old, a new version has been released with a backward-compatible fix: https://github.com/pelletier/go-toml/releases/tag/v2.0.5.

What's Changed

Fixed bugs

Decode: don't crash on embedded nil pointers by @pelletier in https://github.com/pelletier/go-toml/pull/808
Add back missing build tag needed for Go 1.16 and earlier by @piotrbulinski in https://github.com/pelletier/go-toml/pull/809
Decode: don't break on non-struct embed field by @pelletier in https://github.com/pelletier/go-toml/pull/810

New Contributors

@piotrbulinski made their first contribution in https://github.com/pelletier/go-toml/pull/809

Full Changelog: pelletier/go-toml@v2.0.3...v2.0.4

`v2.0.3`

Compare Source

What's Changed

Fixed bugs

Encode: define and fix newlines behavior when using omitempty by @pelletier in https://github.com/pelletier/go-toml/pull/798
Encode: don't inherit omitempty by @pelletier in https://github.com/pelletier/go-toml/pull/803
Decode: error on array table mismatched type by @pelletier in https://github.com/pelletier/go-toml/pull/804

Other changes

build(deps): bump github.com/stretchr/testify from 1.7.2 to 1.8.0 by @dependabot in https://github.com/pelletier/go-toml/pull/793 https://github.com/pelletier/go-toml/pull/794 https://github.com/pelletier/go-toml/pull/795
Go 1.19 by @pelletier in https://github.com/pelletier/go-toml/pull/802

Full Changelog: pelletier/go-toml@v2.0.2...v2.0.3

`v2.0.2`

Compare Source

What's Changed

Fixed bugs

Encode: add bound check for uint64 > math.Int64 by @pelletier in https://github.com/pelletier/go-toml/pull/785

Other changes

Build arm + arm64 binaries for linux and windows by @pelletier in https://github.com/pelletier/go-toml/pull/790

Full Changelog: pelletier/go-toml@v2.0.1...v2.0.2

`v2.0.1`

Compare Source

What's Changed

Fixed bugs

Encode: fix embedded struct with explicit field name by @pelletier in https://github.com/pelletier/go-toml/pull/773
Encode: fix multiline comment by @pelletier in https://github.com/pelletier/go-toml/pull/775
Encode: support comment on array tables by @pelletier in https://github.com/pelletier/go-toml/pull/776
Decode: check max uint on 32 bit platforms by @pelletier in https://github.com/pelletier/go-toml/pull/778

Documentation

Typo in README.md fix by @fnork in https://github.com/pelletier/go-toml/pull/770

New Contributors

@fnork made their first contribution in https://github.com/pelletier/go-toml/pull/770

Full Changelog: pelletier/go-toml@v2.0.0...v2.0.1

`v2.0.0`

Compare Source

It is finally here! go-toml v2 is now stable. 🎉

Only just over one year after I started working on it. This version of go-toml has been rebuilt from the ground up. It respects the latest TOML specification. Countless bugs have been fixed. It behaves more like the standard library. And it is much faster. Special attention was given to keeping the public API to a minimum. Continuing the strict policy of backward compatibility, the next breaking change will be in another 5 years!

Thank you to everybody who contributed to this new version, as well as folks willing to try out the intermediate beta versions. Shout out to @moorereason for reporting many issues during the development process using differential fuzzing, as well as @bep for running a beta on the popular Hugo project!

There is still some work that could be done to improve the performance of the library (https://github.com/pelletier/go-toml/pull/758 and https://github.com/pelletier/go-toml/pull/669 for instance). But I am confident that the library is in a good-enough place at the moment for folks to reap the benefits of the rewrite. The major feature removal is the sort-of-AST that v1 provided. It allowed manipulating an arbitrary document and writing it back out. This was done to cut down the scope of the project, removing a feature that had unclear use-cases. The v2 parser creates some intermediate AST so that if somebody is up to design a Document API the tools should be available to do so. Please reach out if you are interested!

The readme contains a list of differences between v1 and v2 to be aware of when upgrading. Please report any issue you may have with the new version in the bug tracker 🐞, provide feedback, and ask questions in Discussions 💬.
With this release, go-toml v1 will not be receiving any updates. This is required to keep maintenance of the project to a minimum.

Hopefully, this change doesn't break your thing!

Full commit log: pelletier/go-toml@c9a09d8...v2

Thank you contributors: @pelletier @oschwald @moorereason @xwjdsh @kkHAIKE @RiyaJohn @jidicula @zostay @mmorel-35.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

codecov · 2024-06-06T07:08:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.06%. Comparing base (4ce4684) to head (58e7a0b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #472   +/-   ##
=======================================
  Coverage   53.06%   53.06%           
=======================================
  Files          46       46           
  Lines        3865     3865           
=======================================
  Hits         2051     2051           
  Misses       1587     1587           
  Partials      227      227

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

renovate bot force-pushed the renovate/github.com-pelletier-go-toml-2.x branch from 3e638cc to 22c8f04 Compare June 6, 2024 06:59

renovate bot force-pushed the renovate/github.com-pelletier-go-toml-2.x branch from 22c8f04 to ced0078 Compare June 17, 2024 13:45

renovate bot force-pushed the renovate/github.com-pelletier-go-toml-2.x branch from ced0078 to 58e7a0b Compare July 14, 2024 10:18

fix(deps): update module github.com/pelletier/go-toml to v2

f62e835

renovate bot force-pushed the renovate/github.com-pelletier-go-toml-2.x branch from 58e7a0b to f62e835 Compare August 23, 2024 18:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update module github.com/pelletier/go-toml to v2 #472

fix(deps): update module github.com/pelletier/go-toml to v2 #472

renovate bot commented Jun 6, 2024 •

edited

Loading

codecov bot commented Jun 6, 2024 •

edited

Loading

fix(deps): update module github.com/pelletier/go-toml to v2 #472

Are you sure you want to change the base?

fix(deps): update module github.com/pelletier/go-toml to v2 #472

Conversation

renovate bot commented Jun 6, 2024 • edited Loading

Release Notes

What's Changed

What's new

Performance

Fixed bugs

Documentation

Other changes

New Contributors

What's Changed

Fixed bugs

New Contributors

What's Changed

Fixed bugs

New Contributors

What's Changed

What's new

Fixed bugs

Documentation

Other changes

New Contributors

What's Changed

Fixed bugs

New Contributors

What's Changed

What's new

Fixed bugs

Other changes

New Contributors

What's Changed

Fixed bugs

Other changes

New Contributors

What's Changed

What's new

Fixed bugs

Documentation

New Contributors

What's Changed

Fixed bugs

Documentation

New Contributors

What's Changed

What's new

Performance

Other changes

New Contributors

What's Changed

Fixed bugs

What's Changed

Fixed bugs

New Contributors

What's Changed

Fixed bugs

Other changes

What's Changed

Fixed bugs

Other changes

What's Changed

Fixed bugs

Documentation

New Contributors

Configuration

codecov bot commented Jun 6, 2024 • edited Loading

Codecov Report

renovate bot commented Jun 6, 2024 •

edited

Loading

codecov bot commented Jun 6, 2024 •

edited

Loading