Confused about toml file generation/writing

[Stein-N]

I'm confused about why on Neo-/Forge categories in the toml file get writen with a blank line between/above them, but when i use it on Fabric they get "crunshed" together. Is there a setting for the CommentedConfig or the TomlWriter i can set to achive this?

Neo-/Forge:

["Crack Hammer Durability"]
	copper = 64
	gold = 96
	iron = 128
	steel = 160
	diamond = 256
	netherite = 384

["Chisel Durability"]
	copper = 10
	gold = 15
	iron = 30
	steel = 45
	diamond = 64
	netherite = 96

Fabric:

["Crack Hammer Durability"]
	copper = 64
	gold = 96
	iron = 128
	steel = 160
	diamond = 256
	netherite = 384
["Chisel Durability"]
	copper = 10
	gold = 15
	iron = 30
	steel = 45
	diamond = 64
	netherite = 96

For all Modloaders i use my simple API to Build and create the Config File.

My current approach, i guess, is not the best but for now i cant imagine a better way:

Repo for the Config API

Writing every Config Entry to the Commented Config

Method for writing the Values to the CommentedConfig wich is initialized as inMemory():

    private void writeToConfig(ConfigEntry<?> entry) {
        for (Map.Entry<String, String> categoryComment : this.builder.getCategoryComments().entrySet()) {
            this.config.setComment(categoryComment.getKey(), categoryComment.getValue());
        }

        this.config.set(entry.path, entry.value);

        if (entry.configValue.getRangedComment() == null) this.config.setComment(entry.path, entry.configValue.getComment());
        else this.config.setComment(entry.path, entry.configValue.getRangedComment());
    }

Method for saving/generating the toml file:

    private void writeValuesToTomlFile() {
        TomlWriter writer = new TomlWriter();
        writer.write(this.config, this.file, WritingMode.REPLACE);
    }

I tried to "modify" the TomlWriter, by adding the writer.setNewLine() like below, but then every value has a blank line above.
When i only add one \n the result is the same, that the categories get crunshed together.

    private void writeValuesToTomlFile() {
        TomlWriter writer = new TomlWriter();
        writer.setNewline("\n\n");
        writer.write(this.config, this.file, WritingMode.REPLACE);
    }

After checking how the ModConfig from Forge handles the saving, i also tried like Forge to cast my CommentedConfig to the CommentedFileConfig to use the .save() method but this produces an Exception that a CommentedConfig cannot be cast to CommentedFileConfig

    private void writeValuesToTomlFile() {
//        TomlWriter writer = new TomlWriter();
//        writer.write(this.config, this.file, WritingMode.REPLACE);
        ((CommentedFileConfig) this.config).save();
    }

[TheElectronWill]

Hello

The type of your config variable should not change its serialization, in the end it's the ConfigWriter (in that case a TomlWriter) that transforms the entries into a TOML file (this also applies when you call save()). It could be due to a difference between the version of NightConfig you use (seems to be 3.6.7), and the version of NightConfig used by NeoForge (seems to be 3.6.4).

You can try an older version to see if it improves your problem.
If that's the case then congratulations, you've just found a bug in the TomlWriter 🎉 I'll fix it ^^

[Stein-N]

Hey yeah the switch to v 3.6.4 fixed the issue thanks 😄

I also watched inside the Toml code real quick, at first im not anything near of understanding java completely, but can it be that the following code inside the writeNormal() Function from the Table Writer can "trigger" this issue?

int nonSimpleValuesCount = tablesEntries.size() + tableArraysEntries.size();
int simpleValuesCount = config.size() - nonSimpleValuesCount;
if (simpleValuesCount > 0 && nonSimpleValuesCount > 0) {
	writer.writeNewline(output);
}

because in version 3.6.4 it simply calls:

writer.writeNewline(output);

But i only watched quickly for any difference in the code and this is the first that catched my attention.
Hope this helpes a little bit tracking down the issue 😄

UPDATE - Compare v3.6.4 and v3.6.7:

Ok after downloading the code for version 3.6.7 and comment out the first code block and adding the second code block back it seems to fix the issue

This is the console Output of the writeToString Test from TomlWriterTest with the check:

Written:
bool_array = [
	true,
	false,
	true,
	false
]
string = "\"value\""
double = 3.1415926535
integer = 2
long = 123456789
enum = "A"

[config]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array2]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array2]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array2]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"
[[table_array]]
	dateTime = 2024-01-23T20:22:27.807294+01:00
	sub = {}
	string = "test"

And this without the check and reverted back to v3.6.4 approach

Written:
bool_array = [
	true,
	false,
	true,
	false
]
string = "\"value\""
double = 3.1415926535
integer = 2
long = 123456789
enum = "A"

[config]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array2]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array2]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array2]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

[[table_array]]
	dateTime = 2024-01-23T20:24:27.681016+01:00
	sub = {}
	string = "test"

UPDATE 2 - Dumb/Useless Fix:

After printing the nonSimpleValuesCount and the simpleValuesCount to the console this gets printed:

Non Simple Values Count:   2
Simple Values Count:   6
Non Simple Values Count:   0
Simple Values Count:   3
Non Simple Values Count:   0
Simple Values Count:   3
Non Simple Values Count:   0
Simple Values Count:   3
Non Simple Values Count:   0
Simple Values Count:   3

So my solution to the "non blank line" issue would be the following:

int nonSimpleValuesCount = tablesEntries.size() + tableArraysEntries.size();
int simpleValuesCount = config.size() - nonSimpleValuesCount;
if (simpleValuesCount > 0 && nonSimpleValuesCount >= 0) {
	writer.writeNewline(output);
}

Simply allow that the nonSimpleValuesCount can also be 0 to print a new line, but i think this bigger than 0 check has a specific reason to be there and by the same time it makes the check basically useless because it gets the same result as by simply call the writeNewLine method.

UPDATE 3 - Usefull Fix?

Another Solution for my after work brain could be the following:

for (UnmodifiableCommentedConfig.Entry entry : tablesEntries) {
	// Writes the comment, if there is one
	writer.writeComment(entry.getComment(), output);

	// Writes the table declaration
	configPath.add(entry.getKey());// path level ++
	writeTableName(configPath, output, writer);
	writer.writeNewline(output);

	// Writes the table's content
	writeNormal(entry.<UnmodifiableConfig>getValue(), configPath, output, writer);
	configPath.remove(configPath.size() - 1);// path level --
	writer.writeNewline(output); // After work brain solution
}

This would only separate the tablesEntries without "splitting" the table arrays.
And because of the Method structure this will have no further collison with normal/simple values

Final Result and Pull Request #154

When modifying the for loops inside the writeNormal Method like this:

// Writes the tables:
for (UnmodifiableCommentedConfig.Entry entry : tablesEntries) {
       // Writes the comment, if there is one
	writer.writeComment(entry.getComment(), output);

	// Writes the table declaration
	configPath.add(entry.getKey());// path level ++
	writeTableName(configPath, output, writer);
	writer.writeNewline(output);

	// Writes the table's content
	writeNormal(entry.<UnmodifiableConfig>getValue(), configPath, output, writer);
	configPath.remove(configPath.size() - 1);// path level --
	writer.writeNewline(output); // separates Tables
}

// Writes the arrays of tables:
for (UnmodifiableCommentedConfig.Entry entry : tableArraysEntries) {
	// Writes the comment, if there is one
	writer.writeComment(entry.getComment(), output);

	// Writes the tables
	configPath.add(entry.getKey());// path level ++
	List<Config> tableArray = entry.getValue();
	for (UnmodifiableConfig table : tableArray) {
		writeTableArrayName(configPath, output, writer);
		writer.writeNewline(output);
		writeNormal(table, configPath, output, writer);
	}
	configPath.remove(configPath.size() - 1);// path level --
	writer.writeNewline(output); // separates each written ArrayList Table
}
writer.decreaseIndentLevel();// Indent--

The Console output from the writeToString Test looks like this:

Written:
bool_array = [
	true,
	false,
	true,
	false
]
string = "\"value\""
double = 3.1415926535
integer = 2
long = 123456789
enum = "A"

[config]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"

[[table_array2]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"
[[table_array2]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"
[[table_array2]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"

[[table_array]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"
[[table_array]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"
[[table_array]]
	dateTime = 2024-01-23T20:18:29.0438218+01:00
	sub = {}
	string = "test"

Now the tableEntries and tableArrayEntries get separated when a new Entry or Array is written.

[TheElectronWill]

Nice investigation! I think that the last solution is quite good, I'll take a look at your PR.