What's Changed

• Implement valueMap for StampedConfig, resolve #177 by @TheElectronWill in https://github.com/TheElectronWill/night-config/pull/178
• Fix some AsyncFileConfig issues, resolve #181 and #180 by @TheElectronWill in https://github.com/TheElectronWill/night-config/pull/182
• More warnings have been fixed

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.8.0...v3.8.1

What's Changed

• FileWatcher offers new methods that return a CompletableFuture
• Every FileConfig is now a ConcurrentConfig
• Some warnings have been fixed.

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.7.4...v3.8.0

This minor release fixes a bug that caused the FileWatcher to close when a directory containing watched files was deleted. Also, an exception is now raised early if the FileWatcher is used in an unsupported manner.

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.7.3...v3.7.4

Fixes

This minor release fixes a bad interaction between AsyncFileConfig and StampedConfig, and between SyncFileConfig, SynchronizedConfig and TomlParser, which resulted in some TOML configurations to be mis-loaded. Thanks to @Technici4n for discovering the bug!

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.7.2...v3.7.3

TOML Fixes

• Implement TOML test suite by @TheElectronWill in https://github.com/TheElectronWill/night-config/pull/175

The TOML implementation is now more robust thanks to toml-test. We don't call the binary, but rather include the repository as a Git submodule in order to grab all the test files.

Compatibility note: the TOML parser of NightConfig now rejects some files that it would have previously accepted (even though they were invalid). This is intended, and we encourage all users to fix their invalid TOML files.

Please read the release notes of v3.7.0 ✨ to learn what has changed since v3.6.x.

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.7.1...v3.7.2

Fixes

• Resolve a misconfiguration of the Gradle build, see https://github.com/TheElectronWill/night-config/issues/173 for more details
• Fix a minor issue with the new options of JsonParser

You should use v3.7.1 instead of v3.7.0.
Please read the release notes of v3.7.0 ✨ to learn what has changed since v3.6.x.

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.7.0...v3.7.1

Major changes

• FileWatcher now comes with out-of-the-box debouncing, which improves the performance of autoreloading and autosaving configurations ⚡, see https://github.com/TheElectronWill/night-config/pull/148
• FileConfig instances are now actually thread-safe and work better with autoreload, which should prevent most of the corruption issues 🛡️, see https://github.com/TheElectronWill/night-config/pull/152
• A new Serialization/Deserialization framework is available in the serde package 🚀, see https://github.com/TheElectronWill/night-config/pull/163.
  Unlike the old ObjectConverter, the new ObjectSerializer and ObjectDeserializer are modular and extensible: you can register your own serializers and deserializers. Deserializers (config -> object) are chosen based on the generic type of the field to set and the type of the config value to deserialize. This allows for fine-grained deserialization. The old ObjectConverter still works but is now deprecated. The goal is to remove the old conversion package in version 4.0.0.

Enhancements

• Allow multiple spec conditions to be checked by @vaperion in https://github.com/TheElectronWill/night-config/pull/151 (Note: this fix applies to the deprecated conversion package; the new serde package supports multiple @SerdeAssert conditions out of the box)
• Support UTF-16 and UTF-8 BOM by @TheElectronWill in https://github.com/TheElectronWill/night-config/commit/68502b9d6a119a20367c4c1ec4d5352c118b4133
• In ConfigSpec and in the new serde Deserializer, automatically apply some "risky" conversions (e.g. long -> int) when it is not lossy, close https://github.com/TheElectronWill/night-config/issues/119
• Allow custom Config storage in ConfigSpec, by @PaintNinja in https://github.com/TheElectronWill/night-config/pull/168
• More unit tests, on Java 8, Java 11 and Java 17, by @TheElectronWill

Bug fixes

• toml: Fix squeezed Files by @Stein-N in https://github.com/TheElectronWill/night-config/pull/154
• toml: Align List ending when in a "group" by @Stein-N in https://github.com/TheElectronWill/night-config/pull/160
• toml: Allow header comments by @Stein-N in https://github.com/TheElectronWill/night-config/pull/162
• json: Disallow trailing data (configurable) by @TheElectronWill, close https://github.com/TheElectronWill/night-config/issues/167
• Multiple bugs have been fixed in ObjectConverter by @TheElectronWill in https://github.com/TheElectronWill/night-config/pull/163

Compatibility Note

NightConfig 3.7.0 is backward-compatible with previous releases, therefore I encourage you to upgrade your dependency on NightConfig in order to benefit from the new version.

Binary-wise, the backward-compatibility has been checked with japicmp.
Source-wise, there is one small incompatible change: FileWatcher#addWatch no longers throws an IOException, which can result in a compiler error unreachable code on the associated try/catch (example in forge).

New Contributors

• @vaperion made their first contribution in https://github.com/TheElectronWill/night-config/pull/151
• @Stein-N made their first contribution in https://github.com/TheElectronWill/night-config/pull/154
• @PaintNinja made their first contribution in https://github.com/TheElectronWill/night-config/pull/168

Thank you everyone!

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.6.7...v3.7.0

More bug fixes :)

What's Changed

• Fixed #121
• Generate jars as OSGi compliant bundles. by @mnlipp in https://github.com/TheElectronWill/night-config/pull/120
• Update HoconWriter to stop putting newlines at the head of the file by @0x3C50 in https://github.com/TheElectronWill/night-config/pull/137

New Contributors

• @mnlipp made their first contribution in https://github.com/TheElectronWill/night-config/pull/120
• @0x3C50 made their first contribution in https://github.com/TheElectronWill/night-config/pull/137

Full Changelog: https://github.com/TheElectronWill/night-config/compare/v3.6.6...v3.6.7

Fixes include: #101, #113

Fix #87, fix #82

See #77

See #71 😃

This release resolves the issue #62 by adding two methods to FileConfigBuilder:

• preserveInsertionOrder()
• backingMapCreator(Supplier<Map<String, Object>>)

And some other things around the backing map of configurations.

Breaking change if you implement your own ConfigFormat (for advanced users)

If you implement your own ConfigFormat, please note that the interface now requires you to implement the new method createConfig(Supplier<Map<String, Object>>).

The two methods createConfig() and createConcurrentConfig() are now default methods and don't need to be implemented. They both call createConfig(Supplier) with the result of Config.getDefaultMapCreator(boolean).

You can read the detailed changes here.

I don't implement my own ConfigFormat, what happens to me? (for normal users)

If you don't implement your own ConfigFormat then everything is fine! Just enjoy the new features. 😃

You can now use the following code to make all new configurations preserve the insertion order of their values.

Config.setInsertionOrderPreserved(true)

You can also provide your own map supplier ("map creator") on a case-by-case basis. See PR https://github.com/TheElectronWill/Night-Config/pull/61

Unlike wrapping a LinkedHashMap, these two new possibilities also work with nested configs.

Fix writing of enum values for TOML and JSON languages.

Enum support

Enum values are now supported via the getEnum methods which can convert strings and integers to enum values of the specified class.

config.set("key", MyEnum.A);
config.set("string", "A");
config.set("ordinal", 0);
MyEnum value = config.getEnum("key", MyEnum.class); // We could have used config.get("key") here
MyEnum valueByString = config.getEnum("string", MyEnum.class); // getEnum is necessary to convert the string to an Enum value
MyEnum valueByOrdinal = config.getEnum("ordinal", MyEnum.class, EnumGetMethod.ORDINAL_OR_NAME);

There exists variants of getOrElse and getOptional for enums :

MyEnum value = config.getEnumOrElse("key", MyEnum.B);
Optional<MyEnum> optionalValue = config.get("key", MyEnum.class);

Bugfixes

The following bugs have been fixed:

• ConfigSpec: issue #49 resolved
• TOML: issues #51 and #53 resolved

Boosted ObjectConverter

ObjectConverter now

• converts the superclass fields too (see #48)
• supports all types of Collection, not just lists
• handles generic nested collections, like LinkedList<Collection<List<Optional<SomeObject>>>> (see #47)

These improvements are also available to the android modules.

Other improvements include

• Tests rewritten with JUnit instead of ifs and Java asserts
• A few mistakes have been fixed

• Special android modules which don't use java.nio.file nor java.util.function in order to be compatible with old versions of Android (i.e. below api level 26).
• Fix charset parameter in ConfigParser: the parameter was ignored, it now works properly