Avoiding Whitespace Noise from Commits by Automation/GitHooks about odftoolkit HOT 9 CLOSED

Hi Svante,

perhaps https://editorconfig.org/ can help. Here are some editor support .editorconfig:

https://editorconfig.org/#download

Regards
Hanh

from odftoolkit.

That is very interesting, GitHub has native support for editconfig, it runs out-of-the-box in various editors (like IntelliJ) and with Plugin for editors such VisualStudioCode, Eclipse, Sublime, etc.
And there is even a Maven Plugin - https://ec4j.github.io/editorconfig-maven-plugin/

Would you like to come up with an exampe for it for our project? Even a patch perhaps?
I am still stuck with updating the documentation..

Cheers,
Svante

from odftoolkit.

I was curious and I have started a branch issue-15 with a new config file ".editorconfig" and a new Maven plugin in a new branch: https://github.com/tdf/odftoolkit/compare/issue-15
So far I only added the changed pom.xml itself so we can now discuss on the configuration instead being polluted by noise of changed spaces ;-)

For configuration details see:
https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties

You simply run from command line:
mvn editorconfig:format
Within the ODFDOM project I would roll it out for all projects, but let's start simple.

I used the following Maven plugin: https://ec4j.github.io/editorconfig-maven-plugin/
Also I do not apply it to all files, but only I have included a handful, see odfdom/pom.xml

pom.xml
src/codegen/resources/config.xml
src/codegen/resources/pkg/config.xml
src/codegen/resources/pkg/javacodetemplate.xml
src/main/java/org/odftoolkit/odfdom/doc/OdfChartDocument.java

Does this configuration suit you? Later for all Java and XML files and all projects?
Any Pro/Cons on the configuration?

PS: Somehow I have hoped that the branch would automaticalle align with this issue, any idea what I have missed?

from odftoolkit.

As the tavis test failed (likely due to the build in support of .editorconfig of GitHub) I have changed my mind and transformed all files (see subset in config) of the ODFDOM project.
If you like the configuration I would add the same configuration for all other ODF Toolkit projects.

NOTE: For review, fokus on the odfdom/pom.xml and odfdom/.editorconfig file, otherwise it is a review of whitespace adoption ;-)

from odftoolkit.

Hi
.editorconfig looks fine. But do you really want indent_style as tab? I think in Java project the indent_style is space as standard.

Regards
Hanh

from odftoolkit.

from odftoolkit.

That is fine.

from odftoolkit.

I have added a new pull request for review:
#18

from odftoolkit.

Merged the according pull request: #18

from odftoolkit.