Skip to content

Conversation

@nook24
Copy link

@nook24 nook24 commented Dec 24, 2025

This PR will improve the README to inform users about the changes related to HCL, INI and Java Properties implemented with Viper 1.20.0 and will resolve #2092

Happy holidays!

the user to UPGRADE.md

Signed-off-by: nook24 <info@nook24.eu>
@CLAassistant
Copy link

CLAassistant commented Dec 24, 2025

CLA assistant check
All committers have signed the CLA.

README.md Outdated
* INI
* envfile
* Java Propeties
* HCL (see below)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a Markdown link.

Developers are lazy animals for good reasons.

I know it, I'm one of them 😅

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, i will fix this

README.md Outdated
> specify the format programmatically, which is useful for files that naturally
> have no extension (e.g., `.bashrc`).
> **NOTE (since 1.20)** In order to reduce third-party dependencies, Viper dropped support for the following formats from the core:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use the following syntax maybe

> [!NOTE]
> Blah blah

It would be rendered this way

Note

Blah blah

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently there a multiple, let's call it legacy note blocks. For this reason I decided to use the same way.
I guess it would be good to refactor all of the quote blocks in this case. I can also do this if you like.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a random Gopher here. Keep it as-is and consider refactoring in a later PR if a maintainer is OK about the format

Signed-off-by: nook24 <info@nook24.eu>
@nook24
Copy link
Author

nook24 commented Dec 24, 2025

All done :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Outdated documentation for INI, HCL and Java Propeties

3 participants