Autoformat workflow

[riccardobl]

A github action workflow that applies prettifier to pull requests (if needed) to automatically fix formatting issues.

Why prettifier?

• It is standalone
• The rules are similar to jme style but standardized (the only custom option used is tabsize=4)
• It is supported by many editors and can be used as git pre commit hook
• It supports many languages

The goal is to make pr integration faster by resolving all sort of formatting issues automatically, since sometimes, even with a properly configured editor it is possible to miss some. (Unless you configure your editor to format on save, but can pollute the commit since most of our code was not formatted properly from the start.).

With this workflow contributors can simply pr changes and have github action attach a formatting commit for the changed files, only if necessary.

I won't hide the fact that i am proposing this also because i am starting to believe i have developed some form of formatting blindness, since despite putting in 101% effort my PRs always have formatting issues 🦀 .

[riccardobl]

If there aren't objections i will merge this

[stephengold]

Go ahead and integrate it. If it causes problems, we can simply delete the workflow, right?

[Ali-RS]

Shall we test this in a separate branch with a dummy PR first? Just to see if it works fine before applying it on real PRs.

[riccardobl]

Go ahead and integrate it. If it causes problems, we can simply delete the workflow, right?

Yes

Shall we test this in a separate branch with a dummy PR first? Just to see if it works fine before applying it on real PRs.

I've tested it here https://github.com/RiccardoblSandbox/jmonkeyengine-test .
I increased the suggested line length to 180 (that's the same max line length of our jme_style.xml) because it was breaking the lines too easily

[Ali-RS]

Do we prefer this

    public BulletAppState(
        Vector3f worldMin,
        Vector3f worldMax,
        BroadphaseType broadphaseType
    ) {

over this?

public BulletAppState(Vector3f worldMin, Vector3f worldMax, BroadphaseType broadphaseType) {

or was that because of the line length setting you mentioned above?

[stephengold]

I think the maximum line length should be 110 characters/columns, per our preferred coding style: https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/CONTRIBUTING.md#coding-style

[riccardobl]

or was that because of the line length setting you mentioned above?

This is the formatting with line width = 110

RiccardoblSandbox@65454e2

I think the maximum line length should be 110 characters/columns, per our preferred coding style: https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/CONTRIBUTING.md#coding-style

Done, it seems JME_style.xml has some errors

[Ali-RS]

This is the formatting with line width = 110
RiccardoblSandbox@65454e2

I think it looks better now, thanks.

What was the default width used by the plugin?

[riccardobl]

This is the formatting with line width = 110
RiccardoblSandbox@65454e2

I think it looks better now, thanks.

What was the default width used by the plugin?

it uses 80

[stephengold]

Is there any reason to retain the "autoformat" branch in the public repo?

[riccardobl]

nope, removed.

[stephengold]

This feature was disabled at 7c20f95 (12 October 2023).