flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-6107) Add custom checkstyle for flink-streaming-java
Date Sat, 25 Mar 2017 14:07:42 GMT

    [ https://issues.apache.org/jira/browse/FLINK-6107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15941731#comment-15941731
] 

ASF GitHub Bot commented on FLINK-6107:
---------------------------------------

Github user greghogan commented on the issue:

    https://github.com/apache/flink/pull/3567
  
    @aljoscha, I likewise have no great preference for import order. I do think it is important
for the checkstyle to match IntelliJ's code style, either the default or a provided Flink
style.
    
    The default IntelliJ import style can be approximated:
    
    ```
    <module name="CustomImportOrder">
        <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC"/>
        <property name="specialImportsRegExp" value="^javax\."/>
        <property name="standardPackageRegExp" value="^java\."/>
        <property name="sortImportsInGroupAlphabetically" value="true"/>
        <property name="separateLineBetweenGroups" value="false"/>
    </module>
    ```
    
    That includes a blank line between `javax` and `java` imports. There is an [old ticket
with recent activity](https://github.com/checkstyle/checkstyle/issues/525) for this issue
to allow blank lines to be explicitly defined.
    
    That said, I'd go for the Google Style as used in this PR. IntelliJ can import from a
checkstyle configuration but I am not seeing any effect from this.


> Add custom checkstyle for flink-streaming-java
> ----------------------------------------------
>
>                 Key: FLINK-6107
>                 URL: https://issues.apache.org/jira/browse/FLINK-6107
>             Project: Flink
>          Issue Type: Improvement
>          Components: DataStream API
>            Reporter: Aljoscha Krettek
>            Assignee: Aljoscha Krettek
>
> There was some consensus on the ML (https://lists.apache.org/thread.html/94c8c5186b315c58c3f8aaf536501b99e8b92ee97b0034dee295ff6a@%3Cdev.flink.apache.org%3E)
that we want to have a more uniform code style. We should start module-by-module and by introducing
increasingly stricter rules. We have to be aware of the PR situation and ensure that we have
minimal breakage for contributors.
> This issue aims at adding a custom checkstyle.xml for {{flink-streaming-java}} that is
based on our current checkstyle.xml but adds these checks for Javadocs:
> {code}
> <!--
> JAVADOC CHECKS
> -->
> <!-- Checks for Javadoc comments.                     -->
> <!-- See http://checkstyle.sf.net/config_javadoc.html -->
> <module name="JavadocMethod">
>   <property name="scope" value="protected"/>
>   <property name="severity" value="error"/>
>   <property name="allowMissingJavadoc" value="true"/>
>   <property name="allowMissingParamTags" value="true"/>
>   <property name="allowMissingReturnTag" value="true"/>
>   <property name="allowMissingThrowsTags" value="true"/>
>   <property name="allowThrowsTagsForSubclasses" value="true"/>
>   <property name="allowUndeclaredRTE" value="true"/>
> </module>
> <!-- Check that paragraph tags are used correctly in Javadoc. -->
> <module name="JavadocParagraph"/>
> <module name="JavadocType">
>   <property name="scope" value="protected"/>
>   <property name="severity" value="error"/>
>   <property name="allowMissingParamTags" value="true"/>
> </module>
> <module name="JavadocStyle">
>   <property name="severity" value="error"/>
>   <property name="checkHtml" value="true"/>
> </module>
> {code}
> This checks:
>  - Every type has a type-level Javadoc
>  - Proper use of {{<p>}} in Javadocs
>  - First sentence must end with a proper punctuation mark
>  - Proper use (including closing) of HTML tags



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message