Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Customize checkstyle to make it more lenient. #869

Merged
merged 3 commits into from

2 participants

David Hudson Christian Meier
David Hudson

While there are still many checkstyle violations, most of them are formatting issues which I can handle fairly quickly.

David Hudson

Hi kristian. Can you look at this? Thanks.

Christian Meier
Collaborator

could you remove the .gitignore commit since I do have no overview of its impact. the iml files could go into your global gitignore. the lib/jruby-original.jar it feels it should not pop up. or are all those files generated by the mvn site execution ?

David Hudson

Thanks. I'll fix the commit.

David Hudson

I have reverted the change on .gitignore.

Christian Meier mkristian merged commit 7f5a592 into from
David Hudson jendave deleted the branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 9, 2013
  1. David Hudson
  2. David Hudson
Commits on Jul 10, 2013
  1. David Hudson

    Revert "Ignore some generated files"

    jendave authored
    This reverts commit 09dc1dd.
This page is out of date. Refresh to see the latest.
2  core/pom.xml
View
@@ -32,6 +32,7 @@
<developerConnection>scm:git:ssh://git@github.com/jruby/jruby.git</developerConnection>
<url>http://github.com/jruby/jruby</url>
</scm>
+
<dependencies>
<dependency>
<groupId>junit</groupId>
@@ -229,6 +230,7 @@
<!-- any version which is on maven repo will do -->
<tzdata.jar.version>2013c</tzdata.jar.version>
<tzdata.scope>provided</tzdata.scope>
+ <main.basedir>${project.parent.basedir}</main.basedir>
</properties>
<build>
<defaultGoal>package</defaultGoal>
215 docs/style_checks.xml
View
@@ -0,0 +1,215 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+ "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+ "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+
+ Checkstyle configuration that checks the sun coding conventions from:
+
+ - the Java Language Specification at
+ http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+ - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+ - the Javadoc guidelines at
+ http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+ - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+ - some best practices
+
+ Checkstyle is very configurable. Be sure to read the documentation at
+ http://checkstyle.sf.net (or in your downloaded distribution).
+
+ Most Checks are configurable, be sure to consult the documentation.
+
+ To completely disable a check, just comment it out or delete it from the file.
+
+ Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+ <!--
+ If you set the basedir property below, then all reported file
+ names will be relative to the specified directory. See
+ http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+ <property name="basedir" value="${basedir}"/>
+ -->
+
+ <!-- Checks that a package-info.java file exists for each package. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+ <!-- <module name="JavadocPackage"/> -->
+
+ <!-- Checks whether files end with a new line. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+ <module name="NewlineAtEndOfFile"><property name="lineSeparator" value="lf"/></module>
+
+ <!-- Checks that property files contain the same keys. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+ <module name="Translation"/>
+
+ <!-- Checks for Size Violations. -->
+ <!-- See http://checkstyle.sf.net/config_sizes.html -->
+ <!-- <module name="FileLength"/> -->
+
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="FileTabCharacter"/>
+
+ <!-- Miscellaneous other checks. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html -->
+ <module name="RegexpSingleline">
+ <property name="format" value="(^|[^\*])\s+$"/>
+ <property name="minimum" value="0"/>
+ <property name="maximum" value="0"/>
+ <property name="message" value="Line has trailing spaces."/>
+ </module>
+
+ <module name="TreeWalker">
+ <property name="cacheFile" value="${cacheFile}"/>
+ <!-- Checks for Javadoc comments. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+ <module name="JavadocMethod">
+ <property name="scope" value="package"/>
+ </module>
+ <module name="JavadocType">
+ <property name="scope" value="package"/>
+ </module>
+ <module name="JavadocVariable">
+ <property name="scope" value="package"/>
+ </module>
+ <module name="JavadocStyle"/>
+
+
+ <!-- Checks for Naming Conventions. -->
+ <!-- See http://checkstyle.sf.net/config_naming.html -->
+ <module name="ConstantName"/>
+ <module name="LocalFinalVariableName"/>
+ <module name="LocalVariableName"/>
+ <module name="MemberName"/>
+
+ <!-- Allow test_ methods to have underscores in them. -->
+ <module name="MethodName">
+ <property name="format" value="^[a-z][a-zA-Z0-9]*$|^test_[_a-zA-Z0-9]*$"/>
+ </module>
+
+ <module name="PackageName"/>
+ <module name="ParameterName"/>
+ <module name="StaticVariableName"/>
+ <module name="TypeName"/>
+
+
+ <!-- Checks for Headers -->
+ <!-- See http://checkstyle.sf.net/config_header.html -->
+ <!-- <module name="Header"> -->
+ <!-- The follow property value demonstrates the ability -->
+ <!-- to have access to ANT properties. In this case it uses -->
+ <!-- the ${basedir} property to allow Checkstyle to be run -->
+ <!-- from any directory within a project. See property -->
+ <!-- expansion, -->
+ <!-- http://checkstyle.sf.net/config.html#properties -->
+ <!-- <property -->
+ <!-- name="headerFile" -->
+ <!-- value="${basedir}/java.header"/> -->
+ <!-- </module> -->
+
+ <!-- Following interprets the header file as regular expressions. -->
+ <!-- <module name="RegexpHeader"/> -->
+
+
+ <!-- Checks for imports -->
+ <!-- See http://checkstyle.sf.net/config_import.html -->
+ <module name="AvoidStarImport"/>
+ <module name="IllegalImport"/>
+ <!-- defaults to sun.* packages -->
+ <module name="RedundantImport"/>
+ <module name="UnusedImports"/>
+
+
+ <!-- Checks for Size Violations. -->
+ <!-- See http://checkstyle.sf.net/config_sizes.html -->
+ <!-- <module name="LineLength">
+ <property name="max" value="180"/>
+ </module>
+ <module name="MethodLength"/>
+ <module name="ParameterNumber"/> -->
+
+
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="EmptyForIteratorPad"/>
+ <module name="GenericWhitespace"/>
+ <module name="MethodParamPad"/>
+ <module name="NoWhitespaceAfter">
+ <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
+ </module>
+ <module name="NoWhitespaceBefore"/>
+ <module name="OperatorWrap"/>
+ <module name="ParenPad"/>
+ <module name="TypecastParenPad"/>
+ <module name="WhitespaceAfter"/>
+ <module name="WhitespaceAround"/>
+
+
+ <!-- Modifier Checks -->
+ <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+ <module name="ModifierOrder"/>
+ <module name="RedundantModifier"/>
+
+
+ <!-- Checks for blocks. You know, those {}'s -->
+ <!-- See http://checkstyle.sf.net/config_blocks.html -->
+ <module name="AvoidNestedBlocks"/>
+
+ <!-- Allow empty blocks. <module name="EmptyBlock"/> -->
+
+ <module name="LeftCurly">
+ <!-- Place left curly at EOL for one-line clauses,
+ and on next line for multi-line clauses.
+ -->
+ <!-- <property name="option" value="nlow" /> -->
+ </module>
+
+ <module name="NeedBraces"/>
+
+ <!-- Allow for right curly to appear on same or next line. <module name="RightCurly"/> -->
+
+
+ <!-- Checks for common coding problems -->
+ <!-- See http://checkstyle.sf.net/config_coding.html -->
+ <!-- <module name="AvoidInlineConditionals"/> -->
+ <module name="DoubleCheckedLocking"/>
+ <!-- MY FAVOURITE -->
+ <module name="EmptyStatement"/>
+ <module name="EqualsHashCode"/>
+ <!-- <module name="HiddenField"/> -->
+ <module name="IllegalInstantiation"/>
+ <module name="InnerAssignment"/>
+ <!-- <module name="MagicNumber"/> -->
+ <module name="MissingSwitchDefault"/>
+ <module name="RedundantThrows"/>
+ <module name="SimplifyBooleanExpression"/>
+ <module name="SimplifyBooleanReturn"/>
+
+ <!-- Checks for class design -->
+ <!-- See http://checkstyle.sf.net/config_design.html -->
+ <!-- <module name="DesignForExtension"/> -->
+ <module name="FinalClass"/>
+ <!-- <module name="HideUtilityClassConstructor"/> -->
+ <module name="InterfaceIsType"/>
+ <module name="VisibilityModifier"/>
+
+
+ <!-- Miscellaneous other checks. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html -->
+ <module name="ArrayTypeStyle"/>
+ <!-- <module name="FinalParameters"/> -->
+ <!-- <module name="TodoComment"/> -->
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
1  ext/openssl/pom.xml
View
@@ -18,6 +18,7 @@
<bc.version>1.47</bc.version>
<openssl.dir>${project.basedir}/../../lib/ruby/shared</openssl.dir>
<base.java.version>1.6</base.java.version>
+ <main.basedir>${project.parent.parent.basedir}</main.basedir>
</properties>
<dependencies>
1  ext/readline/pom.xml
View
@@ -16,6 +16,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<readline.dir>${project.basedir}/../../lib/ruby/shared/readline</readline.dir>
<base.java.version>1.6</base.java.version>
+ <main.basedir>${project.parent.parent.basedir}</main.basedir>
</properties>
<dependencies>
2  pom.xml
View
@@ -30,6 +30,7 @@
<rdoc.version>3.12</rdoc.version>
<json.version>1.7.3</json.version>
<base.java.version>1.6</base.java.version>
+ <main.basedir>${project.basedir}</main.basedir>
</properties>
<scm>
@@ -198,6 +199,7 @@
</reportSet>
</reportSets>
<configuration>
+ <configLocation>${main.basedir}/docs/style_checks.xml</configLocation>
<propertyExpansion>
cacheFile=${project.build.directory}/checkstyle-cachefile
</propertyExpansion>
Something went wrong with that request. Please try again.