What is the code style of the InLong? #3082

healchow · 2022-03-12T05:44:46Z

healchow
Mar 12, 2022
Collaborator

What is the code style of the InLong?

InLong 项目遵循什么样的代码规范？开发者提交代码时需要注意哪些呢？

Mar 12, 2022

Currently, the code style of the project is consistent with most open source projects.

When using IDEA, it is recommended to add the following Code Style.

<code_scheme name="InLong-CodeStyle" version="173">
    <option name="OTHER_INDENT_OPTIONS">
        <value>
            <option name="INDENT_SIZE" value="4"/>
            <option name="CONTINUATION_INDENT_SIZE" value="8"/>
            <option name="TAB_SIZE" value="4"/>
            <option name="USE_TAB_CHARACTER" value="false"/>
            <option name="SMART_TABS" value="false"/>
            <option name="LABEL_INDENT_SIZE" value="0"/>
            <option name="LABEL_INDENT_ABSOLUTE" value="false"/>
            <option name="USE_REL…

View full answer

healchow · 2022-03-12T05:45:57Z

healchow
Mar 12, 2022
Collaborator Author

Currently, the code style of the project is consistent with most open source projects.

When using IDEA, it is recommended to add the following Code Style.

<code_scheme name="InLong-CodeStyle" version="173">
    <option name="OTHER_INDENT_OPTIONS">
        <value>
            <option name="INDENT_SIZE" value="4"/>
            <option name="CONTINUATION_INDENT_SIZE" value="8"/>
            <option name="TAB_SIZE" value="4"/>
            <option name="USE_TAB_CHARACTER" value="false"/>
            <option name="SMART_TABS" value="false"/>
            <option name="LABEL_INDENT_SIZE" value="0"/>
            <option name="LABEL_INDENT_ABSOLUTE" value="false"/>
            <option name="USE_RELATIVE_INDENTS" value="false"/>
        </value>
    </option>
    <option name="FORMATTER_TAGS_ENABLED" value="true"/>
    <JSCodeStyleSettings version="0">
        <option name="INDENT_CHAINED_CALLS" value="false"/>
    </JSCodeStyleSettings>
    <JavaCodeStyleSettings>
        <option name="INSERT_INNER_CLASS_IMPORTS" value="true"/>
        <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
        <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
        <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
            <value/>
        </option>
        <option name="JD_ALIGN_PARAM_COMMENTS" value="false"/>
        <option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false"/>
        <option name="JD_P_AT_EMPTY_LINES" value="false"/>
        <option name="JD_PRESERVE_LINE_FEEDS" value="true"/>
        <option name="JD_INDENT_ON_CONTINUATION" value="true"/>
    </JavaCodeStyleSettings>
    <Python>
        <option name="USE_CONTINUATION_INDENT_FOR_ARGUMENTS" value="true"/>
    </Python>
    <ScalaCodeStyleSettings>
        <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true"/>
    </ScalaCodeStyleSettings>
    <TypeScriptCodeStyleSettings version="0">
        <option name="INDENT_CHAINED_CALLS" value="false"/>
    </TypeScriptCodeStyleSettings>
    <XML>
        <option name="XML_ALIGN_ATTRIBUTES" value="false"/>
    </XML>
    <codeStyleSettings language="CSS">
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="ECMA Script Level 4">
        <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
        <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
        <option name="ALIGN_MULTILINE_FOR" value="false"/>
        <option name="CALL_PARAMETERS_WRAP" value="1"/>
        <option name="METHOD_PARAMETERS_WRAP" value="1"/>
        <option name="EXTENDS_LIST_WRAP" value="1"/>
        <option name="BINARY_OPERATION_WRAP" value="1"/>
        <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true"/>
        <option name="TERNARY_OPERATION_WRAP" value="1"/>
        <option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true"/>
        <option name="FOR_STATEMENT_WRAP" value="1"/>
        <option name="ARRAY_INITIALIZER_WRAP" value="1"/>
        <option name="IF_BRACE_FORCE" value="3"/>
        <option name="DOWHILE_BRACE_FORCE" value="3"/>
        <option name="WHILE_BRACE_FORCE" value="3"/>
        <option name="FOR_BRACE_FORCE" value="3"/>
    </codeStyleSettings>
    <codeStyleSettings language="HTML">
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="JAVA">
        <option name="RIGHT_MARGIN" value="120"/>
        <option name="LINE_COMMENT_AT_FIRST_COLUMN" value="false"/>
        <option name="BLOCK_COMMENT_AT_FIRST_COLUMN" value="false"/>
        <option name="LINE_COMMENT_ADD_SPACE" value="true"/>
        <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
        <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
        <option name="BLANK_LINES_BEFORE_PACKAGE" value="1"/>
        <option name="BLANK_LINES_AFTER_CLASS_HEADER" value="1"/>
        <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
        <option name="ALIGN_MULTILINE_RESOURCES" value="false"/>
        <option name="ALIGN_MULTILINE_FOR" value="false"/>
        <option name="CALL_PARAMETERS_WRAP" value="1"/>
        <option name="METHOD_PARAMETERS_WRAP" value="1"/>
        <option name="EXTENDS_LIST_WRAP" value="1"/>
        <option name="THROWS_KEYWORD_WRAP" value="1"/>
        <option name="METHOD_CALL_CHAIN_WRAP" value="1"/>
        <option name="BINARY_OPERATION_WRAP" value="1"/>
        <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true"/>
        <option name="TERNARY_OPERATION_WRAP" value="1"/>
        <option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true"/>
        <option name="FOR_STATEMENT_WRAP" value="1"/>
        <option name="ARRAY_INITIALIZER_WRAP" value="1"/>
        <option name="WRAP_COMMENTS" value="true"/>
        <option name="IF_BRACE_FORCE" value="3"/>
        <option name="DOWHILE_BRACE_FORCE" value="3"/>
        <option name="WHILE_BRACE_FORCE" value="3"/>
        <option name="FOR_BRACE_FORCE" value="3"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="4"/>
            <option name="CONTINUATION_INDENT_SIZE" value="8"/>
            <option name="TAB_SIZE" value="4"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="JSON">
        <indentOptions>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="JavaScript">
        <option name="RIGHT_MARGIN" value="80"/>
        <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
        <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
        <option name="ALIGN_MULTILINE_FOR" value="false"/>
        <option name="CALL_PARAMETERS_WRAP" value="1"/>
        <option name="METHOD_PARAMETERS_WRAP" value="1"/>
        <option name="BINARY_OPERATION_WRAP" value="1"/>
        <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true"/>
        <option name="TERNARY_OPERATION_WRAP" value="1"/>
        <option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true"/>
        <option name="FOR_STATEMENT_WRAP" value="1"/>
        <option name="ARRAY_INITIALIZER_WRAP" value="1"/>
        <option name="IF_BRACE_FORCE" value="3"/>
        <option name="DOWHILE_BRACE_FORCE" value="3"/>
        <option name="WHILE_BRACE_FORCE" value="3"/>
        <option name="FOR_BRACE_FORCE" value="3"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="PROTO">
        <option name="RIGHT_MARGIN" value="80"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="CONTINUATION_INDENT_SIZE" value="2"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="protobuf">
        <option name="RIGHT_MARGIN" value="120"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="CONTINUATION_INDENT_SIZE" value="2"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="Python">
        <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
        <option name="RIGHT_MARGIN" value="80"/>
        <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="SASS">
        <indentOptions>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="SCSS">
        <indentOptions>
            <option name="CONTINUATION_INDENT_SIZE" value="4"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="TypeScript">
        <indentOptions>
            <option name="INDENT_SIZE" value="2"/>
            <option name="TAB_SIZE" value="2"/>
        </indentOptions>
    </codeStyleSettings>
    <codeStyleSettings language="XML">
        <option name="RIGHT_MARGIN" value="120"/>
        <indentOptions>
            <option name="INDENT_SIZE" value="4"/>
            <option name="CONTINUATION_INDENT_SIZE" value="8"/>
            <option name="TAB_SIZE" value="4"/>
        </indentOptions>
    </codeStyleSettings>
</code_scheme>

0 replies

healchow · 2022-03-12T06:03:08Z

healchow
Mar 12, 2022
Collaborator Author

Notice:

Open the Preferences of your IDEA, and import the configuration in the following order.

Make sure your [Import Layout] is the same as in the image below.

Recommended:

It is recommended to install the [Save Action] plugin for automatic code formatting, it helps to automatically format new or modified files according to the above code specification.

After installation, modify and use the following configuration here:

0 replies

ijihang · 2022-03-24T12:18:05Z

ijihang
Mar 24, 2022

I have a suggestion,use spotless plugin and Google Java Code Formatting

6 replies

healchow Apr 24, 2022
Collaborator Author

Thanks for your suggestion!
Could you please add this plugin into our project and CI?

healchow May 2, 2022
Collaborator Author

Hello ijihang.

After a try, I found that the Google Java Code Formatting is not suitable for our Project.

For example, the indent of Java code in the Google format file is 2, but our indentation is 4 spaces, which is the same as most Java projects.

jun0315 Jul 27, 2022

@healchow Hi healchow, spotless supports custom code style, which is compatible with our current format. If we use spotless in the project, we can use mvn spotless:apply to automatically format the code to maintain uniformity. At the same time, we can use mvn spotless:check to check whether the new code conforms to the specification in CI.

healchow Jul 27, 2022
Collaborator Author

@jun0315 Could you please contribute this check for the InLong project?

jun0315 Jul 27, 2022

@healchow Okay, I have created the issue and I will contribute it. :D

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

What is the code style of the InLong? #3082

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 3 comments 6 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

What is the code style of the InLong? #3082

healchow Mar 12, 2022 Collaborator

Replies: 3 comments · 6 replies

healchow Mar 12, 2022 Collaborator Author

healchow Mar 12, 2022 Collaborator Author

ijihang Mar 24, 2022

healchow Apr 24, 2022 Collaborator Author

healchow May 2, 2022 Collaborator Author

jun0315 Jul 27, 2022

healchow Jul 27, 2022 Collaborator Author

jun0315 Jul 27, 2022

healchow
Mar 12, 2022
Collaborator

Replies: 3 comments 6 replies

healchow
Mar 12, 2022
Collaborator Author

healchow
Mar 12, 2022
Collaborator Author

ijihang
Mar 24, 2022

healchow Apr 24, 2022
Collaborator Author

healchow May 2, 2022
Collaborator Author

healchow Jul 27, 2022
Collaborator Author