You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by zj...@apache.org on 2018/01/30 00:47:37 UTC
zeppelin git commit: ZEPPELIN-3137. Improve code style check
Repository: zeppelin
Updated Branches:
refs/heads/master 81e73cd8d -> 49786a771
ZEPPELIN-3137. Improve code style check
### What is this PR for?
Although currently zeppelin has code check style, it is very weak. Such as unused import is not detected. The is the first PR for adding code style check. It just improve the code style check file , but just disable it for now. I have created subtask under ZEPPELIN-3137 for each module. This `checkstyle.xml` is from spark project. I think code style of spark is also fit for zeppelin project, just remove some spark related content in this `checkstyle.xml`
### What type of PR is it?
[ Improvement]
### Todos
* [ ] - Task
### What is the Jira issue?
* https://issues.apache.org/jira/browse/ZEPPELIN-3137
### How should this be tested?
* Travis build pass
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: Jeff Zhang <zj...@apache.org>
Closes #2727 from zjffdu/ZEPPELIN-3137 and squashes the following commits:
a41bd32 [Jeff Zhang] address comment
9935281 [Jeff Zhang] ZEPPELIN-3137. Add code style check
Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/49786a77
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/49786a77
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/49786a77
Branch: refs/heads/master
Commit: 49786a7717bec0345aaac895d09736b6c6605610
Parents: 81e73cd
Author: Jeff Zhang <zj...@apache.org>
Authored: Tue Jan 16 16:16:40 2018 +0800
Committer: Jeff Zhang <zj...@apache.org>
Committed: Tue Jan 30 08:47:31 2018 +0800
----------------------------------------------------------------------
_tools/checkstyle.xml | 16 +++++++++++++---
pom.xml | 10 +++++++++-
2 files changed, 22 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/49786a77/_tools/checkstyle.xml
----------------------------------------------------------------------
diff --git a/_tools/checkstyle.xml b/_tools/checkstyle.xml
index cdb8fbf..d7eaaf9 100644
--- a/_tools/checkstyle.xml
+++ b/_tools/checkstyle.xml
@@ -58,10 +58,11 @@ limitations under the License.
<!-- Checks for redundant import statements. -->
<property name="severity" value="error"/>
</module>
- <!-- <module name="ImportOrder"> Checks for out of order import statements
- <property name="severity" value="warning"/> <property name="groups" value="com.google,android,junit,net,org,java,javax"/>
+ <module name="ImportOrder"> Checks for out of order import statements
+ <property name="severity" value="warning"/> <property name="groups" value="com.google,junit,net,org,java,javax,*,org.apache.zeppelin"/>
This ensures that static imports go first <property name="option" value="top"/>
- <property name="tokens" value="STATIC_IMPORT, IMPORT"/> </module> -->
+ <property name="tokens" value="STATIC_IMPORT, IMPORT"/>
+ </module>
<!-- JAVADOC CHECKS -->
<!-- Checks for Javadoc comments. -->
@@ -279,5 +280,14 @@ limitations under the License.
<property name="basicOffset" value="2"/>
<property name="caseIndent" value="2"/>
</module>
+
+ <module name="EmptyCatchBlock">
+ <property name="exceptionVariableName" value="expected"/>
+ </module>
+ <module name="CommentsIndentation"/>
+ <module name="UnusedImports"/>
+ <module name="RedundantImport"/>
+ <module name="RedundantModifier"/>
+ <module name="AvoidStarImport"/>
</module>
</module>
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/49786a77/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 880bea6..725db41 100644
--- a/pom.xml
+++ b/pom.xml
@@ -385,9 +385,17 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.17</version>
<configuration>
+ <skip>true</skip>
+ <failOnViolation>false</failOnViolation>
+ <includeTestSourceDirectory>true</includeTestSourceDirectory>
+ <sourceDirectories>${basedir}/src/main/java,${basedir}/src/main/scala</sourceDirectories>
+ <testSourceDirectory>${basedir}/src/test/java</testSourceDirectory>
<configLocation>_tools/checkstyle.xml</configLocation>
- <enableRSS>false</enableRSS>
+ <outputFile>${basedir}/target/checkstyle-output.xml</outputFile>
+ <inputEncoding>${project.build.sourceEncoding}</inputEncoding>
+ <outputEncoding>${project.reporting.outputEncoding}</outputEncoding>
</configuration>
<executions>
<execution>