[jira] [Comment Edited] (HUDI-354) Introduce stricter comment and code style validation rules
[
https://issues.apache.org/jira/browse/HUDI-354?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16982033#comment-16982033
]
lamber-ken edited comment on HUDI-354 at 11/26/19 1:53 AM:
---
Because of it's a big work to do for each new checkstyle rule, so I create a
new issue which working for ImportOrder rule.
[https://issues.apache.org/jira/projects/HUDI/issues/HUDI-363]
was (Author: lamber-ken):
Because of it's a big work to do for each new checkstyle rule, so I create a
new issue which working for ImportOrder rule.
> Introduce stricter comment and code style validation rules
> --
>
> Key: HUDI-354
> URL: https://issues.apache.org/jira/browse/HUDI-354
> Project: Apache Hudi (incubating)
> Issue Type: Task
>Reporter: vinoyang
>Priority: Major
> Attachments: Screenshot 2019-11-22 at 4.58.58 PM.png, Screenshot
> 2019-11-22 at 5.02.32 PM.png
>
>
> This is an umbrella issue used to track apply some stricter comment and code
> style validation rules for the whole project. The rules list below:
> # All public classes must add class-level comments;
> # All comments must end with a clear "."
> # In the import statement of the class, clearly distinguish (by blank lines)
> the import of Java SE and the import of non-java SE. Currently, I saw at
> least two projects(Spark and Flink) that implement this rule. Flink
> implements stricter rules than Spark. It is divided into several blocks from
> top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE
> import -> static import), each block are sorted according to the natural
> sequence of letters;
> # Reconfirm the method and whether the comment is consistency;
> Each project sub-module mappings to one subtask.
> How to find all the invalidated points?
> * Add the XML code snippet into {{PROJECT_ROOT/style/checkstyle.xml}} :
> {code:java}
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>value="Import {0} appears after other imports that it should precede"/>
>
>
>
>
>value="Redundant import {0}."/>
>
>
>
>
> {code}
> * Make sure you have installed CheckStyle-IDEA plugin and activated for the
> project.
> * Scan the project module you want to refactor and fix all the issues one by
> one.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (HUDI-354) Introduce stricter comment and code style validation rules
[
https://issues.apache.org/jira/browse/HUDI-354?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16979877#comment-16979877
]
lamber-ken edited comment on HUDI-354 at 11/22/19 5:50 AM:
---
hi, [~yanghua]
I create a sub-task to add these rules and will test whether the ci is ok or
not.
I think we also should add maven-enforcer-plugin to limit the maven version
like flink-project, WDYT?
was (Author: lamber-ken):
hi, [~yanghua]
I create a sub-task to add these rules and will test the ci if ok.
I think we also should add maven-enforcer-plugin to limit the maven version
like flink-project, WDYT?
> Introduce stricter comment and code style validation rules
> --
>
> Key: HUDI-354
> URL: https://issues.apache.org/jira/browse/HUDI-354
> Project: Apache Hudi (incubating)
> Issue Type: Task
>Reporter: vinoyang
>Priority: Major
>
> This is an umbrella issue used to track apply some stricter comment and code
> style validation rules for the whole project. The rules list below:
> # All public classes must add class-level comments;
> # All comments must end with a clear "."
> # In the import statement of the class, clearly distinguish (by blank lines)
> the import of Java SE and the import of non-java SE. Currently, I saw at
> least two projects(Spark and Flink) that implement this rule. Flink
> implements stricter rules than Spark. It is divided into several blocks from
> top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE
> import -> static import), each block are sorted according to the natural
> sequence of letters;
> # Reconfirm the method and whether the comment is consistency;
> Each project sub-module mappings to one subtask.
> How to find all the invalidated points?
> * Add the XML code snippet into {{PROJECT_ROOT/style/checkstyle.xml}} :
> {code:java}
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>value="Import {0} appears after other imports that it should precede"/>
>
>
>
>
>value="Redundant import {0}."/>
>
>
>
>
> {code}
> * Make sure you have installed CheckStyle-IDEA plugin and activated for the
> project.
> * Scan the project module you want to refactor and fix all the issues one by
> one.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (HUDI-354) Introduce stricter comment and code style validation rules
[
https://issues.apache.org/jira/browse/HUDI-354?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16979351#comment-16979351
]
Gurudatt Kulkarni edited comment on HUDI-354 at 11/21/19 3:11 PM:
--
[~yanghua] There some rules that clash with already existing rules that are
present in checkstyle.xml. Eg. Check hudi-cli Main.java. Do we have to totally
remove the current style configs?
CustomImportOrder / ImportOrder
was (Author: gurudatt):
[~yanghua] There some rules that clash with already existing rules that are
present in checkstyle.xml. Eg. Check hudi-cli Main.java.
CustomImportOrder / ImportOrder
> Introduce stricter comment and code style validation rules
> --
>
> Key: HUDI-354
> URL: https://issues.apache.org/jira/browse/HUDI-354
> Project: Apache Hudi (incubating)
> Issue Type: Task
>Reporter: vinoyang
>Priority: Major
>
> This is an umbrella issue used to track apply some stricter comment and code
> style validation rules for the whole project. The rules list below:
> # All public classes must add class-level comments;
> # All comments must end with a clear "."
> # In the import statement of the class, clearly distinguish (by blank lines)
> the import of Java SE and the import of non-java SE. Currently, I saw at
> least two projects(Spark and Flink) that implement this rule. Flink
> implements stricter rules than Spark. It is divided into several blocks from
> top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE
> import -> static import), each block are sorted according to the natural
> sequence of letters;
> # Reconfirm the method and whether the comment is consistency;
> Each project sub-module mappings to one subtask.
> How to find all the invalidated points?
> * Add the XML code snippet into {{PROJECT_ROOT/style/checkstyle.xml}} :
> {code:java}
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>value="Import {0} appears after other imports that it should precede"/>
>
>
>
>
>value="Redundant import {0}."/>
>
>
>
>
> {code}
> * Make sure you have installed CheckStyle-IDEA plugin and activated for the
> project.
> * Scan the project module you want to refactor and fix all the issues one by
> one.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (HUDI-354) Introduce stricter comment and code style validation rules
[
https://issues.apache.org/jira/browse/HUDI-354?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16979143#comment-16979143
]
lamber-ken edited comment on HUDI-354 at 11/21/19 10:13 AM:
right, I tried maven-3.2.5 and maven-3.5.4 version.
was (Author: lamber-ken):
right
> Introduce stricter comment and code style validation rules
> --
>
> Key: HUDI-354
> URL: https://issues.apache.org/jira/browse/HUDI-354
> Project: Apache Hudi (incubating)
> Issue Type: Task
>Reporter: vinoyang
>Priority: Major
>
> This is an umbrella issue used to track apply some stricter comment and code
> style validation rules for the whole project. The rules list below:
> # All public classes must add class-level comments;
> # All comments must end with a clear "."
> # In the import statement of the class, clearly distinguish (by blank lines)
> the import of Java SE and the import of non-java SE. Currently, I saw at
> least two projects(Spark and Flink) that implement this rule. Flink
> implements stricter rules than Spark. It is divided into several blocks from
> top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE
> import -> static import), each block are sorted according to the natural
> sequence of letters;
> # Reconfirm the method and whether the comment is consistency;
> Each project sub-module mappings to one subtask.
> How to find all the invalidated points?
> * Add the XML code snippet into {{PROJECT_ROOT/style/checkstyle.xml}} :
> {code:java}
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>value="Import {0} appears after other imports that it should precede"/>
>
>
>
>
>value="Redundant import {0}."/>
>
>
>
>
> {code}
> * Make sure you have installed CheckStyle-IDEA plugin and activated for the
> project.
> * Scan the project module you want to refactor and fix all the issues one by
> one.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (HUDI-354) Introduce stricter comment and code style validation rules
[
https://issues.apache.org/jira/browse/HUDI-354?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16979133#comment-16979133
]
lamber-ken edited comment on HUDI-354 at 11/21/19 9:46 AM:
---
hi, I test in my local env just now, it did not affect the build process flow
{code:java}
mvn checkstyle:check
{code}
{code:java}
{code}
was (Author: lamber-ken):
hi, I test in my local env just now, it did affect the build process flow
{code:java}
mvn checkstyle:check
{code}
{code:java}
{code}
> Introduce stricter comment and code style validation rules
> --
>
> Key: HUDI-354
> URL: https://issues.apache.org/jira/browse/HUDI-354
> Project: Apache Hudi (incubating)
> Issue Type: Task
>Reporter: vinoyang
>Priority: Major
>
> This is an umbrella issue used to track apply some stricter comment and code
> style validation rules for the whole project. The rules list below:
> # All public classes must add class-level comments;
> # All comments must end with a clear "."
> # In the import statement of the class, clearly distinguish (by blank lines)
> the import of Java SE and the import of non-java SE. Currently, I saw at
> least two projects(Spark and Flink) that implement this rule. Flink
> implements stricter rules than Spark. It is divided into several blocks from
> top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE
> import -> static import), each block are sorted according to the natural
> sequence of letters;
> # Reconfirm the method and whether the comment is consistency;
> Each project sub-module mappings to one subtask.
> How to find all the invalidated points?
> * Add the XML code snippet into {{PROJECT_ROOT/style/checkstyle.xml}} :
> {code:java}
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>value="Import {0} appears after other imports that it should precede"/>
>
>
>
>
>value="Redundant import {0}."/>
>
>
>
>
> {code}
> * Make sure you have installed CheckStyle-IDEA plugin and activated for the
> project.
> * Scan the project module you want to refactor and fix all the issues one by
> one.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
