feat: add support for files.insertFinalNewline during formatOnSave

[xai]

What it does

When the files.insertFinalNewline property is set to true, formatOnSave() will ensure that the file ends with a newline character instead of always removing a final empty line.

Fixes #13475

Contributed on behalf of STMicroelectronics

How to test

1. Open a workspace and set "editor.formatOnSave" to true in the workspace settings.
2. Edit a file that has a final empty line and save.
3. Verify that the empty line has been removed.
4. Set "files.insertFinalNewline" to true in the workspace settings.
5. Verify that final empty lines are kept or added when saving.

Follow-ups

Review checklist

• As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• As a reviewer, I agree to behave in accordance with the review guidelines

[JonasHelming]

@xai What is the state of this?

[xai]

@xai What is the state of this?

As I commented in the related issue, I feel that the added protected function might be living in the wrong place. But it works, and I do not know what would be a better file/package for that function, so I am just going to remove the draft state now and hope for input from a reviewer.

[xai]

@tsmaeder alerted me that the property seems to be ignored in certain cases:

• It works as intended without the built-in extensions (i.e., omit yarn download:plugins while building or clear plugins/ directory).
• With all built-in extensions, the behavior of an extension seems to override the new files.insertFinalNewline setting and also the format-on-save setting.

Merging as is does not make sense, because it will not work in most cases (i.e., all built-in extensions are present). So, I am going to debug into this to find out which extension we are having this feature interaction with.

[xai]

FYI: I am retesting this right now ...

Edit:
One of the plugins that is definitely interfering with the files.insertFinalNewline setting in Theia, is editorconfig.editorconfig, which is also part of the default built-ins.

If your workspace contains a .editorconfig file and specifies insert_final_newline, the newline will be added if theiasetting || editorconfigsetting is true.

[xai]

Just rebased against master, above comment still applies.

[xai]

So, what is the expected behavior if a generic Theia workspace setting such as files.insertFinalNewline and extension settings (e.g., in editorconfig, or any language-specific vscode extension) mismatch? From a user perspective, I would probably assume that the more specific setting (i.e., typically the extension) takes precedence. Any opinion, @tsmaeder?

[tsmaeder]

@xai We can turn the setting on/off per language in the settings, so I think doing it after the "format on save" is the right thing to do.