chore - Fix reformatter conflicts between eclipse java formatter and pre commit checks #581
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: When you run mvn package, it uses the Eclipse Java Formatter: https://github.com/aws-cloudformation/cloudformation-cli-java-plugin/blob/master/src/main/resources/com/amazonaws/cloudformation/eclipse-java-formatter.xml#L1
But the pre-commit hook we use has a different set of reformatting rules, which conflict with the Eclipse Java Formatter.
Problem
This means, whenever you run
mvn package
to build the project, your project gets reformatted via the eclipse formatter, but maven verify step in our build process runs lint checks from the pre-commit hook - these 2 conflict, meaning everytime you build the project withmvn package
your project WILL reformat itself.Description of changes:
This change commits:
Removes
end-of-file-fixer
from precommit because it conflicts with https://github.com/aws-cloudformation/cloudformation-cli-java-plugin/blob/master/src/main/resources/com/amazonaws/cloudformation/eclipse-java-formatter.xml#L120, precommit tries to add a new line, and eclipse formatter tries to remove itRemoves
trailing-whitespace
from precommit, as precommit tried to remove whitespace at the end, and eclipse java formatter tried to add itBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.