commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: [configuration] checkstyle fails build
Date Sun, 25 Jun 2017 10:46:49 GMT
On 25 June 2017 at 10:09, Claude Warren <claude@xenei.com> wrote:
> Eclipse lets you export the format rules as separate files.  My suggestion
> was intended to mean that these files should be included, not the entire
> .settings as that contains a number of local settings and my leak
> confidential information. (I have not verified that it will leak
> confidential information).

Regardless of whether any information is leaked, Eclipse config files
are generally NOT portable between systems.
This is because they may contain local paths, and also people may wish
to include different features.

> Another option would be to use something like:
> http://code.revelc.net/formatter-maven-plugin/formatter-maven-plugin/usage.html
> to format the code during the maven build.
>
> On Fri, Jun 23, 2017 at 5:44 PM, Gary Gregory <garydgregory@gmail.com>
> wrote:
>
>> On Fri, Jun 23, 2017 at 9:35 AM, sebb <sebbaz@gmail.com> wrote:
>>
>> > On 23 June 2017 at 17:29, Gary Gregory <garydgregory@gmail.com> wrote:
>> > > On Fri, Jun 23, 2017 at 8:21 AM, Claude Warren <claude@xenei.com>
>> wrote:
>> > >
>> > >> How about an eclipse format configuration that will correct the error
>> on
>> > >> demand.  Granted you have to run eclipse but if such a file were
>> created
>> > >> (and checked in) then it would be easy for anyone running eclipse to
>> fix
>> > >> it.
>> > >>
>> > >
>> > > I use Eclipse and would appreciate such a file. In the past we've not
>> > > included IDE files in the repo but making it easier would be nice.
>> >
>> > If added, these should be optional.
>> > i.e. don't use the same name as Eclipse uses, but copy the required
>> > settings to another file.
>> >
>> > See for example how Tomcat do it:
>> >
>> > http://svn.apache.org/repos/asf/tomcat/trunk/res/ide-support/eclipse/
>>
>>
>> Putting the files in a separate folder is one thing but flattening the
>> folders and changing file names is -1. Just put the Eclipse .settings
>> folder I should be using so I can overlay it on top of my project.
>> Otherwise, a user has to know where to sprinkle each file in each place.
>> Maybe something like:
>>
>> .../eclipse/.classpath
>> .../eclipse/.project
>> .../eclipse/.settings/fileA
>> .../eclipse/.settings/fileB
>> .../eclipse/.settings/folderA
>>
>> and so on.
>>
>> Gary
>>
>> >
>> >
>> > > Gary
>> > >
>> > >>
>> > >> Claude
>> > >>
>> > >> On Fri, Jun 23, 2017 at 4:03 PM, Oliver Heger <
>> > >> oliver.heger@oliver-heger.de>
>> > >> wrote:
>> > >>
>> > >> >
>> > >> >
>> > >> > Am 23.06.2017 um 08:58 schrieb Allon Mureinik:
>> > >> > > The root cause, IMHO, is having failValidation=false configured
in
>> > the
>> > >> > > pom.xml. This way, when you introduce a new problem your
only
>> > option to
>> > >> > > notice it is if you visually scan mvn's output. As evident
by the
>> > >> current
>> > >> > > state of the build, not everyone notices these.
>> > >> > > A more robust approach would be to set failValidation=true,
and
>> > >> actively
>> > >> > > fail the build if checkstyle's rules are violated.
>> > >> > >
>> > >> > > I've submitted a PR to fix all the existing issues and enable
this
>> > >> > > validation. Reviews are welcome:
>> > >> > > https://github.com/apache/commons-configuration/pull/5
>> > >> > >
>> > >> >
>> > >> > Thanks for the PR, I will have a look.
>> > >> >
>> > >> > However, letting the build fail because of checkstyle error is
too
>> > >> > restrictive IMHO. My approach is to work through the errors before
>> > >> > creating a new release. This has the disadvantage that errors
might
>> > >> > accumulate; but from one release to the next one there is typically
>> > not
>> > >> > that much.
>> > >> >
>> > >> > Oliver
>> > >> >
>> > >> > >
>> > >> > > On Thu, Jun 22, 2017 at 11:10 PM, Gary Gregory <
>> > garydgregory@gmail.com
>> > >> >
>> > >> > > wrote:
>> > >> > >
>> > >> > >> FYI, to whom can take the time to fix this.
>> > >> > >>
>> > >> > >> When I run 'mvn clean install', I get:
>> > >> > >>
>> > >> > >> [INFO] --- maven-checkstyle-plugin:2.15:check (default)
@
>> > >> > >> commons-configuration2 ---
>> > >> > >> [INFO] There are 23 errors reported by Checkstyle 6.1.1
with
>> > >> > >> C:\vcs\svn\apache\commons\trunks-proper\configuration/
>> > >> > conf/checkstyle.xml
>> > >> > >> ruleset.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> AbstractHierarchicalConfiguration.java[976]
>> > >> > >> (regexp) RegexpSingleline: Line has trailing spaces.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> AbstractHierarchicalConfiguration.java[978:30]
>> > >> > >> (blocks) LeftCurly: '{' should be on a new line.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> AbstractYAMLBasedConfiguration.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\builder\fluent\
>> > >> > >> INIBuilderParameters.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\builder\
>> > >> > >> INIBuilderParametersImpl.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\builder\
>> > >> > >> INIBuilderParametersImpl.java[42:5]
>> > >> > >> (whitespace) FileTabCharacter: File contains tab characters
(this
>> > is
>> > >> the
>> > >> > >> first instance).
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\builder\
>> > >> > >> INIBuilderParametersImpl.java[52:84]
>> > >> > >> (blocks) LeftCurly: '{' should be on a new line.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> builder\INIBuilderProperties.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\ex\
>> > >> > >> ConfigurationRuntimeException.java[68]
>> > >> > >> (regexp) RegexpSingleline: Line has trailing spaces.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > JSONConfiguration.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> JSONConfiguration.java[43:5]
>> > >> > >> (javadoc) JavadocVariable: Missing a Javadoc comment.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> JSONConfiguration.java[44:5]
>> > >> > >> (javadoc) JavadocVariable: Missing a Javadoc comment.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\tree\
>> > >> > >> ImmutableNode.java[106]
>> > >> > >> (regexp) RegexpSingleline: Line has trailing spaces.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\tree\
>> > >> > >> ImmutableNode.java[114:27]
>> > >> > >> (blocks) LeftCurly: '{' should be on a new line.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\tree\
>> > >> > >> ImmutableNode.java[117]
>> > >> > >> (regexp) RegexpSingleline: Line has trailing spaces.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\tree\
>> > >> > >> ImmutableNode.java[666]
>> > >> > >> (regexp) RegexpSingleline: Line has trailing spaces.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> XMLConfiguration.java[1169:15]
>> > >> > >> (whitespace) WhitespaceAround: 'if' is not followed by
>> whitespace.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> XMLConfiguration.java[1210:15]
>> > >> > >> (whitespace) WhitespaceAround: 'if' is not followed by
>> whitespace.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> XMLConfiguration.java[1212:19]
>> > >> > >> (whitespace) WhitespaceAround: 'if' is not followed by
>> whitespace.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > >> XMLConfiguration.java[1311:20]
>> > >> > >> (whitespace) WhitespaceAround: 'if' is not followed by
>> whitespace.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > XMLListReference.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > XMLListReference.java[45]
>> > >> > >> (design) FinalClass: Class XMLListReference should be
declared as
>> > >> final.
>> > >> > >> [ERROR]
>> > >> > >> src\main\java\org\apache\commons\configuration2\
>> > >> > YAMLConfiguration.java[0]
>> > >> > >> (misc) NewlineAtEndOfFile: File does not end with a newline.
>> > >> > >> [WARNING] checkstyle:check violations detected but
>> failOnViolation
>> > set
>> > >> > to
>> > >> > >> false
>> > >> > >>
>> > >> > >> Gary
>> > >> > >>
>> > >> > >
>> > >> >
>> > >> > ------------------------------------------------------------
>> ---------
>> > >> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> > >> > For additional commands, e-mail: dev-help@commons.apache.org
>> > >> >
>> > >> >
>> > >>
>> > >>
>> > >> --
>> > >> I like: Like Like - The likeliest place on the web
>> > >> <http://like-like.xenei.com>
>> > >> LinkedIn: http://www.linkedin.com/in/claudewarren
>> > >>
>> >
>> > ---------------------------------------------------------------------
>> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> > For additional commands, e-mail: dev-help@commons.apache.org
>> >
>> >
>>
>
>
>
> --
> I like: Like Like - The likeliest place on the web
> <http://like-like.xenei.com>
> LinkedIn: http://www.linkedin.com/in/claudewarren

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message