Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format Enforcement Part 1 #119

Merged
merged 2 commits into from
Jul 23, 2014
Merged

Format Enforcement Part 1 #119

merged 2 commits into from
Jul 23, 2014

Commits on Jul 20, 2014

  1. Format Enforcement Part 1

    All formatting now consistent.  Used least change approach leaving tabs
    as default spacing.  At this point, only turned this on at the main
    project level.  Will need to revisit to get it working across the entire
    project in part 2.  No other hidden source changes were made here
    outside of the POM.XML and new FORMAT.XML files.
    
    A little about formatting.  It uses eclipse to do this but does not
    require eclipse usage directly.  It will pull in the necessary jars via
    maven to perform formatting with using maven-java-formatter-plugin.  As
    the name implies, it currently only works against java code and is based
    on 3.8 version of eclipse currently.
    
    Formatting removes extra blank lines, aligns properties, and corrects
    spacing across lines.  Default line is now considered 120 characters
    rather than 80 as most modern monitors handle this better and it is
    easier to read project overall.
    
    While the formatter will now always run, it has no real impact after
    formatting is enforced other than checking that nothing needs done.
    What this does for us is to ensure any new developer using the project
    applies to our formatting requirements without either party having to
    fix formatting related issues.  This essentially occurs before even the
    pull request can be made provided a build was completed first.
    
    Once this is applied and accepted, we need to make a decision on tabs vs
    spacing.  Using tabs now enforced does look odd in properties and code
    scanners do not like this practice of using tabs in general due to OS
    differences.  If we go ahead and switch to spaces, the next commit will
    be as large on a per file basis but much larger in overall change.  With
    at least this go, I wanted to not do that initially.
    hazendaz committed Jul 20, 2014
    Configuration menu
    Copy the full SHA
    f7b63f5 View commit details
    Browse the repository at this point in the history

Commits on Jul 23, 2014

  1. Format Enforcement Part 2

    Fix to pom relative locations for git build number to eliminate
    duplicate plugin in demo pom and fix so any code added in demo plugin
    will pick up formatting.
    
    Formatting now changed from tabs to spaces.
    hazendaz committed Jul 23, 2014
    Configuration menu
    Copy the full SHA
    eb7becf View commit details
    Browse the repository at this point in the history