This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new 181aa1b4a9 [style]add IntelliJ code style xml (#9438)
181aa1b4a9 is described below
commit 181aa1b4a9a603d92c34dcefefb70c94bb2b4fc2
Author: morrySnow <[email protected]>
AuthorDate: Sun May 8 06:41:46 2022 +0800
[style]add IntelliJ code style xml (#9438)
---
build-support/IntelliJ-code-format.xml | 95 ++++++++++++++++++++++++++
docs/en/developer-guide/java-format-code.md | 2 +-
docs/zh-CN/developer-guide/java-format-code.md | 2 +-
3 files changed, 97 insertions(+), 2 deletions(-)
diff --git a/build-support/IntelliJ-code-format.xml
b/build-support/IntelliJ-code-format.xml
new file mode 100644
index 0000000000..04c4e7a681
--- /dev/null
+++ b/build-support/IntelliJ-code-format.xml
@@ -0,0 +1,95 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<code_scheme name="Doris" version="173">
+ <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="IMPORT_LAYOUT_TABLE">
+ <value>
+ <package name="org.apache.doris" withSubpackages="true" static="false"
/>
+ <emptyLine />
+ <package name="" withSubpackages="true" static="false" />
+ <emptyLine />
+ <package name="java" withSubpackages="true" static="false" />
+ <package name="javax" withSubpackages="true" static="false" />
+ <emptyLine />
+ <package name="" withSubpackages="true" static="true" />
+ </value>
+ </option>
+ <option name="ALIGN_MULTILINE_RECORDS" value="false" />
+ <option name="ALIGN_TYPES_IN_MULTI_CATCH" value="false" />
+ </JavaCodeStyleSettings>
+ <ScalaCodeStyleSettings>
+ <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
+ </ScalaCodeStyleSettings>
+ <editorconfig>
+ <option name="ENABLED" value="false" />
+ </editorconfig>
+ <codeStyleSettings language="JAVA">
+ <option name="RIGHT_MARGIN" value="120" />
+ <option name="KEEP_LINE_BREAKS" value="false" />
+ <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" />
+ <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
+ <option name="KEEP_BLANK_LINES_BETWEEN_PACKAGE_DECLARATION_AND_HEADER"
value="1" />
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" />
+ <option name="BLANK_LINES_BEFORE_PACKAGE" 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="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" />
+ <option name="CALL_PARAMETERS_WRAP" value="1" />
+ <option name="METHOD_PARAMETERS_WRAP" value="1" />
+ <option name="RESOURCE_LIST_WRAP" value="1" />
+ <option name="EXTENDS_LIST_WRAP" value="1" />
+ <option name="THROWS_LIST_WRAP" value="1" />
+ <option name="EXTENDS_KEYWORD_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="TERNARY_OPERATION_WRAP" value="1" />
+ <option name="FOR_STATEMENT_WRAP" value="1" />
+ <option name="ARRAY_INITIALIZER_WRAP" value="1" />
+ <option name="ASSIGNMENT_WRAP" value="1" />
+ <option name="ASSERT_STATEMENT_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" />
+ <option name="PARAMETER_ANNOTATION_WRAP" value="1" />
+ <option name="VARIABLE_ANNOTATION_WRAP" value="1" />
+ <option name="ENUM_CONSTANTS_WRAP" value="1" />
+ <arrangement>
+ <groups>
+ <group>
+ <type>GETTERS_AND_SETTERS</type>
+ <order>KEEP</order>
+ </group>
+ <group>
+ <type>OVERRIDDEN_METHODS</type>
+ <order>KEEP</order>
+ </group>
+ </groups>
+ </arrangement>
+ </codeStyleSettings>
+</code_scheme>
+
diff --git a/docs/en/developer-guide/java-format-code.md
b/docs/en/developer-guide/java-format-code.md
index 267211334a..1ae2996314 100644
--- a/docs/en/developer-guide/java-format-code.md
+++ b/docs/en/developer-guide/java-format-code.md
@@ -58,6 +58,6 @@ Click the plus sign under Configuration File, select `Use a
local Checkstyle fil
The automatic formatting function of `IDEA` is also recommended.
-Go to `Preferences->Editor->Code Style->Java` click the config sign and select
`Import Scheme`，select `CheckStyle Configuration`，and select the
`fe/check/checkstyle/checkstyle.xml` file.
+Go to `Preferences->Editor->Code Style->Java` click the config sign and select
`Import Scheme`，select `IntelliJ IDEA code style XML`，and select the
`build-support/IntelliJ-code-format.xml` file.
If you use VS Code to develop Java code, please install `Checkstyle for Java`
plugin, and config according to the
[document](https://code.visualstudio.com/docs/java/java-linting) and the
picture.
diff --git a/docs/zh-CN/developer-guide/java-format-code.md
b/docs/zh-CN/developer-guide/java-format-code.md
index f78f95af74..95dd61df78 100644
--- a/docs/zh-CN/developer-guide/java-format-code.md
+++ b/docs/zh-CN/developer-guide/java-format-code.md
@@ -56,7 +56,7 @@ javax
同时推荐使用 `IDEA` 的自动格式化功能。
-在 `Preferences->Editor->Code Style->Java` 的配置标识点击 `Import Scheme`，点击
`CheckStyle Configuration`，选择项目的 `fe/check/checkstyle/checkstyle.xml` 文件。
+在 `Preferences->Editor->Code Style->Java` 的配置标识点击 `Import Scheme`，点击 `IntelliJ
IDEA code style XML`，选择项目的 `build-support/IntelliJ-code-format.xml` 文件。
如果使用 VS Code 进行 Java 开发，请安装 `Checkstyle for Java`
插件，按照[文档](https://code.visualstudio.com/docs/java/java-linting)里的说明和动图进行配置。
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
