Skip to content
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

fix(deps): update module github.com/burntsushi/toml to v1 #316

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 24, 2022

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
github.com/BurntSushi/toml v0.4.1 -> v1.4.0 age adoption passing confidence

⚠️ MAJOR MAJOR MAJOR ⚠️


Release Notes

BurntSushi/toml (github.com/BurntSushi/toml)

v1.4.0

Compare Source

This version requires Go 1.18

  • Add toml.Marshal() (#​405)

  • Require 2-digit hour (#​320)

  • Wrap UnmarshalTOML() and UnmarshalText() return values in ParseError for position information (#​398)

  • Fix inline tables with dotted keys inside inline arrays (e.g. k=[{a.b=1}]) (#​400)

v1.3.2

Compare Source

Fix reading BURNTSUSHI_TOML_110 again 😅 The fix for 1.3.1 caused a race issue with multiple decodes being run in parallel.

v1.3.1

Compare Source

This fixes two small bugs:

  • The BURNTSUSHI_TOML_110 environment variable would be checked on package import, rather than Decode().

    This meant that setting os.Setenv("BURNTSUSHI_TOML_110", "") had no effect, as it happens after the import.

  • Fix order of Meta.Keys() for inline tables (this has been an issue since support for inline tables was added).

v1.3.0

Compare Source

New features:

  • Support upcoming TOML 1.1

    While it looks like TOML 1.1 is mostly stable and I don't expect any further major changes, there are NO compatibility guarantees as it is NOT yet released and anything can still change.

    To use it, set the BURNTSUSHI_TOML_110 environment variable to any value, which can be done either with os.SetEnv() or by the user running a program.

    A full list is changes is available in the TOML ChangeLog; the two most notable ones are that newlines and trailing commas are now allowed in inline tables, and Unicode in bare keys can now be used – this is now a valid document:

    lëttërs = {
      ä = "a with diaeresis",
      è = "e with accent grave",
    }
    
  • Allow MarshalTOML and MarshalText to be used on the document type itself, instead of only fields (#​383).

Bufixes:

  • \ escapes at the end of line weren't processed correctly in multiline strings (#​372).

  • Read over UTF-8 BOM (#​381).

  • omitempty struct tag did not work for pointer values (#​371).

  • Fix encoding anonymous structs on 32bit systems (#​374).

v1.2.1

Compare Source

This release fixes the omitempty struct tag on an uncomparable type panicking.

v1.2.0

Compare Source

This release adds a few additional features:

  • Support encoding and decoding json.Number, making interoperability with JSON when using json.Encoder.UseNumber() easier.

  • Support time.Duration string format; an integer will be interpreted as nanoseconds (like before), but a string like "5h" will be parsed. On encoding the string format is used.

  • The omitempty struct tag now also works for structs with all zero values, for example an empty time.Time. A struct is considered "empty" when all fields (exported and private) are the zero value.

  • Allow using interface{} (or any) as the map key when decoding.

And some fixes:

  • Fix encoding.TextUnmarshaler not working for map values.

  • Make encoding.TextUnmarshaler and toml.Unmarshaler work if MarshalText() or MarshalTOML() have a pointer receiver.

  • Error out on nil returns from MarshalTOML/MarshalText; before they would get encoded as invalid TOML (keyname =).

  • Fix a panic where it would try to encode array = [{}, 0] as:

    [[array]]
    [[array]]
    

    Which isn't valid as 0 isn't a table.

  • Some better error reporting for some errors.

v1.1.0

Compare Source

Just a few bugfixes:

  • Skip fields with toml:"-" even when they're unsupported types. Previously something like this would fail to encode due to func being an unsupported type:

    struct {
        Str  string `toml:"str"
        Func func() `toml:"-"`
    }
    
  • Multiline strings can't end with \. This is valid:

Valid

  key = """ foo \
  """

Invalid

  key = """ foo \ """
  • Don't quote values in TOMLMarshaler. Previously they would always include quoting (e.g. "value"), while the entire point of this interface is to bypass that.

v1.0.0

Compare Source

This release adds much more detailed errors, support for the toml.Marshaler interface, and several fixes.

There is no special meaning in the jump to v1.0; the 0.x releases were always treated as if they're 1.x with regards to compatibility; the versioning scheme for this library predates the release of modules.

New features

  • Error reporting is much improved; the reported position of errors should now always be correct and the library can print more detailed errors (#​299, #​332)

    Decode always return a toml.ParseError, which has three methods:

    • Error() behaves as before and shows a single concise line with the error.

    • ErrorWithPosition() shows the same error, but also shows the line the error occurred at, similar to e.g. clang or the Rust compiler.

    • ErrorWithUsage() is the same as ErrorWithPosition(), but may also show a longer usage guidance message. This isn't always present (in which case it behaves identical to ErrorWithPosition()), but it should be present for most common mistakes and sources of confusion.

    Which error the correct one to use is depends on your application and preferences; in general I would recommend using at least ErrorWithPosition() for user-facing errors, as it's much more helpful for users of any skill level. If your users are likely to be non-technical then ErrorWithUsage() is probably a good idea; I did my best to avoid technical jargon such as "newline" and phrase things in a way that's understandable by most people not intimately familiar with these sort of things.

    Additionally, the TOML key that fialed should now always be reported in all errors.

  • Add toml.Marshaler interface. This can be used if you want full control over how something is marshalled as TOML, similar to json.Marshaler etc. This takes precedence over encoding.TextMarshaler. (#​327)

  • Allow TOML integers to be decoded to a Go float (#​325)

    Previously int = 42 could only be decoded to an int* type; now this can also be decoded in a float type as long as it can be represented without loss of data.

Fixes

  • Key.String() is now quoted when needed (#​333)

  • Fix decoding of nested structs on 32bit platforms (#​314)

  • Empty slices are now always []T{} rather than nil, which was the behaviour in v0.3.1 and before. While they are identical for most purposes, encoding/json encodes them different ([] vs. null), making it an (accidentally) incompatible change (#​339)


Configuration

📅 Schedule: Branch creation - "before 3am on tuesday" (UTC), 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.

@renovate renovate bot requested a review from a team as a code owner January 24, 2022 14:06
@renovate renovate bot added the type: chore work needed to keep the product and development running smoothly label Jan 24, 2022
@github-actions github-actions bot added the type: bug code to address defects in shipped code label Jan 24, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Jan 24, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Jan 24, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Jan 27, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from eb8edd7 to a1055ff Compare March 3, 2022 09:10
kodiakhq[bot]
kodiakhq bot previously approved these changes Mar 3, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from a1055ff to 8163461 Compare March 8, 2022 22:15
kodiakhq[bot]
kodiakhq bot previously approved these changes Mar 8, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from 8163461 to 6968b7b Compare April 4, 2022 23:58
kodiakhq[bot]
kodiakhq bot previously approved these changes Apr 4, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from 6968b7b to fbf924b Compare April 7, 2022 13:16
kodiakhq[bot]
kodiakhq bot previously approved these changes Apr 7, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from fbf924b to 6036e3a Compare April 7, 2022 16:29
kodiakhq[bot]
kodiakhq bot previously approved these changes Apr 7, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Apr 18, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Jul 8, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from 2fc9214 to 682d9f3 Compare July 11, 2022 23:53
kodiakhq[bot]
kodiakhq bot previously approved these changes Jul 11, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from 682d9f3 to 04cfee3 Compare July 20, 2022 14:50
kodiakhq[bot]
kodiakhq bot previously approved these changes Jul 20, 2022
kodiakhq[bot]
kodiakhq bot previously approved these changes Nov 20, 2022
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from d4a87d0 to ad12935 Compare May 30, 2023 17:41
kodiakhq[bot]
kodiakhq bot previously approved these changes May 30, 2023
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from ad12935 to bb64050 Compare June 6, 2023 14:45
kodiakhq[bot]
kodiakhq bot previously approved these changes Jun 6, 2023
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from bb64050 to 1a03599 Compare June 8, 2023 14:54
kodiakhq[bot]
kodiakhq bot previously approved these changes Jun 8, 2023
@renovate renovate bot force-pushed the renovate/github.com-burntsushi-toml-1.x branch from 1a03599 to aea347e Compare May 23, 2024 16:17
@renovate renovate bot changed the title fix(deps): update module github.com/burntsushi/toml to v1 fix(deps): update module github.com/burntsushi/toml to v1 - autoclosed Oct 16, 2024
@renovate renovate bot closed this Oct 16, 2024
@renovate renovate bot deleted the renovate/github.com-burntsushi-toml-1.x branch October 16, 2024 16:06
@renovate renovate bot changed the title fix(deps): update module github.com/burntsushi/toml to v1 - autoclosed fix(deps): update module github.com/burntsushi/toml to v1 Oct 16, 2024
@renovate renovate bot reopened this Oct 16, 2024
@renovate renovate bot restored the renovate/github.com-burntsushi-toml-1.x branch October 16, 2024 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale type: bug code to address defects in shipped code type: chore work needed to keep the product and development running smoothly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants