You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eventmesh.apache.org by mi...@apache.org on 2021/10/08 12:27:45 UTC
[incubator-eventmesh] branch develop updated: Update the checkstyle
file and remove code style file (#552)
This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh.git
The following commit(s) were added to refs/heads/develop by this push:
new 36ea9a6 Update the checkstyle file and remove code style file (#552)
36ea9a6 is described below
commit 36ea9a67f1d95c3f0fe47eb75a5e746ef85c9083
Author: Wenjun Ruan <we...@apache.org>
AuthorDate: Fri Oct 8 20:27:37 2021 +0800
Update the checkstyle file and remove code style file (#552)
---
.github/workflows/ci.yml | 2 +-
CONTRIBUTING.md | 42 +++--
CONTRIBUTING.zh-CN.md | 42 +++--
build.gradle | 1 -
style/checkStyle-suppressions.xml | 25 ---
style/checkStyle.xml | 332 ++++++++++++++++++++++++++++++++++++--
style/codeStyle.xml | 143 ----------------
7 files changed, 383 insertions(+), 204 deletions(-)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 1c40819..ff1c87e 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -91,7 +91,7 @@ jobs:
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
java -jar ./checkstyle.jar -c ./style/checkStyle.xml -f xml ./eventmesh-* \
- | ./reviewdog -f=checkstyle -reporter=github-pr-check -filter-mode=nofilter -fail-on-error
+ | ./reviewdog -f=checkstyle -reporter=github-pr-check -filter-mode=added -fail-on-error
license-check:
name: License Check
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0a59e0c..348ce6b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,7 +7,16 @@ or missing, please leave comments / suggestions.
### Setting up your development environment
-You should have JDK installed in your operating system.
+You should have JDK installed in your develop environment.
+
+### Code style
+
+Import [EventMesh CheckStyle](./style/checkStyle.xml) file to your IDE.
+
+For IDEA, you can import check style file by:
+```shell
+Editor -> Code Style -> Java -> Scheme -> Import Scheme -> CheckStyle Configuration
+```
## Contributing
@@ -25,8 +34,19 @@ Here are the workflow for contributors:
1. Fork to your own
2. Clone fork to local repository
+```shell
+git clone git@github.com:yourgithub/incubator-eventmesh.git
+```
3. Create a new branch and work on it
+```shell
+git checkout -b fix_patch_xx
+```
4. Keep your branch in sync
+```shell
+git remote add upstream git@github.com:apache/incubator-eventmesh.git
+git fetch upstream develop:upstream_develop
+git rebase upstream_develop
+```
5. Commit your changes (make sure your commit message concise)
6. Push your commits to your forked repository
7. Create a pull request
@@ -34,10 +54,8 @@ Here are the workflow for contributors:
Please follow [the pull request template](./.github/PULL_REQUEST_TEMPLATE.md). Please make sure the PR has a
corresponding issue. [GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
-After creating a PR, one or more reviewers will be assigned to the pull request. The reviewers will review the code.
-
-Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits. The final commit
-message should be clear and concise.
+After creating a PR, one or more committers will help to review the pull request, after approve, this PR will be merged in to
+EventMesh repository, and the related Issue will be closed.
### Open an issue / PR
@@ -59,18 +77,18 @@ changes to a few individual PRs.
All code should be well reviewed by one or more committers. Some principles:
-- Readability: Important code should be well-documented. Comply with our code style.
+- Readability: Important code should be well-documented. Comply with our [code style](./style/checkStyle.xml).
- Elegance: New functions, classes or components should be well-designed.
- Testability: Important code should be well-tested (high unit test coverage).
### License review
-Eventmesh follows [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) policy. All source files should
-have the Apache License header added to the file header. Eventmesh uses the [apache/skywalking-eyes](https://github.com/apache/skywalking-eyes) to check
-the source file header. And Eventmesh uses [Gradle-License-Report](https://github.com/jk1/Gradle-License-Report) plugin to check for third-part dependencies.
-When you need to add a three-part dependency, you need to register the newly added dependency in tool/license/allowed-licenses.txt, you can execute `./gradlew clean checkLicense` to judge
-whether there exist dependencies isn't added, and the newly added three-part libraries need to meet [ASF 3RD PARTY LICENSE POLICY](https://apache.org/legal/resolved.html).
-It is highly recommended communicating with Eventmesh community before you need to add a three-part library.
+EventMesh follows [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) policy. All source files should
+have the Apache License header added to the file header. EventMesh uses the [apache/skywalking-eyes](https://github.com/apache/skywalking-eyes) to check
+the source file header, and EventMesh uses [Gradle-License-Report](https://github.com/jk1/Gradle-License-Report) plugin to check for third-part dependencies.
+When you need to add a three-part dependency, you need to register the newly added dependency in tool/license/allowed-licenses.txt, you can execute `./gradlew clean checkLicense` to judge
+whether there exist dependencies have been added, and the newly added three-part libraries need to meet [ASF 3RD PARTY LICENSE POLICY](https://apache.org/legal/resolved.html).
+It is highly recommended communicating with EventMesh community before you need to add a three-part library.
## Community
diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
index 7f8f74b..1a5ed68 100644
--- a/CONTRIBUTING.zh-CN.md
+++ b/CONTRIBUTING.zh-CN.md
@@ -6,13 +6,20 @@
### 设置您的开发环境
-您应该在操作系统中安装了JDK。
+您应该在开发环境中安装了JDK。
+
+### Code Style
+
+将 [EventMesh CheckStyle](./style/checkStyle.xml) 文件导入开发者工具。如果你使用IDEA，你可以通过以下步骤导入：
+```shell
+Editor -> Code Style -> Java -> Scheme -> Import Scheme -> CheckStyle Configuration
+```
## 贡献
-无论是对于拼写错误，BUG修复还是重要的新功能，我们总是很乐意为您做出贡献。 请不要犹豫，提出问题或发送请求请求。
+无论是对于拼写错误，BUG修复还是重要的新功能，我们总是很乐意接受您的贡献。请不要犹豫，在Github Issue上提出或者通过邮件列表进行讨论。
-我们非常重视文档以及与其他项目的集成。 我们很高兴接受这些方面的改进。
+我们非常重视文档以及与其他项目的集成，我们很高兴接受这些方面的改进。
### GitHub工作流程
@@ -22,8 +29,19 @@
1. Fork到您个人仓库
2. 克隆到本地存储库
+```shell
+git clone git@github.com:yourgithub/incubator-eventmesh.git
+```
3. 创建一个新分支并对其进行处理
-4. 保持分支同步
+```shell
+git checkout -b fix_patch_xx
+```
+4. 保持分支与主库同步
+```shell
+git remote add upstream git@github.com:apache/incubator-eventmesh.git
+git fetch upstream develop:upstream_develop
+git rebase upstream_develop
+```
5. 提交您的更改(确保您的提交消息简明扼要)
6. 将您的提交推送到分叉的存储库
7. 创建PR合并请求
@@ -31,9 +49,7 @@
请遵循[Pull Requests模板](./.github/PULL_REQUEST_TEMPLATE.md).
请确保PR对应有相应的问题. [GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
-创建PR后，将为拉取请求分配一个或多个审阅者。 审阅者将审阅代码。
-
-在合并PR之前，请压缩所有修订审阅反馈，拼写错误，合并的内容和基于基础的提交内容。 最终的提交消息应该清晰简洁。
+创建PR后，社区会有committer成员帮助review，review通过之后，PR将会合并到主库，相应的Issue会被关闭。
### 打开问题/ PR
@@ -50,20 +66,20 @@
### 代码审查
-所有代码应由一个或多个提交者进行良好的审查。一些原则:
+所有代码应由一个或多个committer进行良好的审查。一些原则:
-- 可读性: 重要代码应有详细记录。符合我们的代码风格
+- 可读性: 重要代码应有详细记录。符合我们的[代码风格](./style/checkStyle.xml)
- 优雅: 新功能，类或组件应经过精心设计
- 可测试性: 重要代码应经过良好测试（较高的单元测试覆盖率）
### License审查
-Eventmesh遵循[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 政策。
-所有的源代码文件应该在文件头部添加Apache License header，Eventmesh会使用[apache/skywalking-eyes](https://github.com/apache/skywalking-eyes)
-对源代码文件头进行校验。Eventmesh使用[Gradle-License-Report](https://github.com/jk1/Gradle-License-Report)插件
+EventMesh遵循[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 政策。
+所有的源代码文件应该在文件头部添加Apache License header，EventMesh会使用[apache/skywalking-eyes](https://github.com/apache/skywalking-eyes)
+对源代码文件头进行校验。EventMesh使用[Gradle-License-Report](https://github.com/jk1/Gradle-License-Report)插件
检查第三方依赖，当你需要添加三方依赖时，你需要将新添加的依赖注册在tool/license/allowed-licenses.txt中，你可以通过执行`./gradlew clean checkLicense`命令可以判断当前是否有license尚未添加，
同时新添加的三方库需要满足[Apache对于第三方的政策](https://apache.org/legal/resolved.html)。
-非常建议在需要添加三方依赖之前与Eventmesh社区进行沟通。
+非常建议在需要添加三方依赖之前与EventMesh社区进行沟通。
## 社区
diff --git a/build.gradle b/build.gradle
index 3576ad7..889d2d5 100644
--- a/build.gradle
+++ b/build.gradle
@@ -426,7 +426,6 @@ subprojects {
dependency "org.powermock:powermock-module-junit4:2.0.2"
dependency "org.powermock:powermock-api-mockito2:2.0.2"
-
dependency 'org.springframework.boot:spring-boot-starter-data-jdbc:2.5.4'
dependency 'org.springframework.boot:spring-boot-starter-data-jpa:2.5.4'
dependency 'org.springframework.boot:spring-boot-starter-jdbc:2.5.4'
diff --git a/style/checkStyle-suppressions.xml b/style/checkStyle-suppressions.xml
deleted file mode 100644
index fd4a42f..0000000
--- a/style/checkStyle-suppressions.xml
+++ /dev/null
@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ 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.
- ~
- -->
-<!DOCTYPE suppressions PUBLIC
- "-//Puppy Crawl//DTD Suppressions 1.0//EN"
- "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
-
-<suppressions>
-
-</suppressions>
\ No newline at end of file
diff --git a/style/checkStyle.xml b/style/checkStyle.xml
index dc98c99..98ec78f 100644
--- a/style/checkStyle.xml
+++ b/style/checkStyle.xml
@@ -22,10 +22,9 @@
"http://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
- <module name="SuppressionFilter">
- <property name="file" value="./style/checkStyle-suppressions.xml"/>
- <property name="optional" value="false"/>
- </module>
+ <property name="charset" value="UTF-8"/>
+ <property name="severity" value="warning"/>
+ <property name="fileExtensions" value="java, properties, xml, gradle"/>
<module name="RegexpSingleline">
<property name="format" value="System\..+\.println"/>
@@ -45,14 +44,329 @@
<property name="message" value="Chinese characters are not allowed!"/>
</module>
+ <module name="BeforeExecutionExclusionFileFilter">
+ <property name="fileNamePattern" value="./eventmesh-runtime/conf/sChat2.jks$"/>
+ </module>
+
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+
+ <module name="LineLength">
+ <property name="fileExtensions" value="java"/>
+ <property name="max" value="100"/>
+ <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+ </module>
+
<module name="TreeWalker">
- <module name="PackageName">
- <property name="format" value="^(org)\.apache(\.[a-zA-Z][a-zA-Z0-9]*)+$"/>
+ <module name="OuterTypeFilename"/>
+ <module name="IllegalTokenText">
+ <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+ <property name="format"
+ value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+ <property name="message"
+ value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</module>
- </module>
+ <module name="AvoidEscapedUnicodeCharacters">
+ <property name="allowEscapesForControlCharacters" value="true"/>
+ <property name="allowByTailComment" value="true"/>
+ <property name="allowNonPrintableEscapes" value="true"/>
+ </module>
+ <module name="AvoidStarImport"/>
+ <module name="ImportOrder">
+ <property name="staticGroups" value="org.apache.eventmesh,org.apache,java,javax,org,com"/>
+ <property name="separatedStaticGroups" value="true"/>
+ <property name="groups" value="org.apache.eventmesh,org.apache,java,javax,org,com"/>
+ <property name="ordered" value="true"/>
+ <property name="separated" value="true"/>
+ <property name="option" value="top"/>
+ <property name="sortStaticImportsAlphabetically" value="true"/>
+ </module>
+ <module name="OneTopLevelClass"/>
+ <module name="NoLineWrap">
+ <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
+ </module>
+ <module name="EmptyBlock">
+ <property name="option" value="TEXT"/>
+ <property name="tokens"
+ value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+ </module>
+ <module name="NeedBraces">
+ <property name="tokens"
+ value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
+ </module>
+ <module name="LeftCurly">
+ <property name="tokens"
+ value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
+ INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
+ LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
+ LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
+ OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
+ </module>
+ <module name="RightCurly">
+ <property name="id" value="RightCurlySame"/>
+ <property name="tokens"
+ value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
+ LITERAL_DO"/>
+ </module>
+ <module name="RightCurly">
+ <property name="id" value="RightCurlyAlone"/>
+ <property name="option" value="alone"/>
+ <property name="tokens"
+ value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
+ INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
+ COMPACT_CTOR_DEF"/>
+ </module>
+ <module name="SuppressionXpathSingleFilter">
+ <property name="id" value="RightCurlyAlone"/>
+ <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
+ or preceding-sibling::*[last()][self::LCURLY]]"/>
+ </module>
+ <module name="WhitespaceAfter">
+ <property name="tokens"
+ value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
+ LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
+ </module>
+ <module name="WhitespaceAround">
+ <property name="allowEmptyConstructors" value="true"/>
+ <property name="allowEmptyLambdas" value="true"/>
+ <property name="allowEmptyMethods" value="true"/>
+ <property name="allowEmptyTypes" value="true"/>
+ <property name="allowEmptyLoops" value="true"/>
+ <property name="ignoreEnhancedForColon" value="false"/>
+ <property name="tokens"
+ value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
+ BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
+ LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
+ LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
+ LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
+ NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
+ SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
+ <message key="ws.notFollowed"
+ value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
+ <message key="ws.notPreceded"
+ value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
+ </module>
+ <module name="OneStatementPerLine"/>
+ <module name="MultipleVariableDeclarations"/>
+ <module name="ArrayTypeStyle"/>
+ <module name="MissingSwitchDefault"/>
+ <module name="FallThrough"/>
+ <module name="UpperEll"/>
+ <module name="ModifierOrder"/>
+ <module name="EmptyLineSeparator">
+ <property name="allowNoEmptyLineBetweenFields" value="true"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapDot"/>
+ <property name="tokens" value="DOT"/>
+ <property name="option" value="nl"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapComma"/>
+ <property name="tokens" value="COMMA"/>
+ <property name="option" value="EOL"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapEllipsis"/>
+ <property name="tokens" value="ELLIPSIS"/>
+ <property name="option" value="EOL"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapArrayDeclarator"/>
+ <property name="tokens" value="ARRAY_DECLARATOR"/>
+ <property name="option" value="EOL"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapMethodRef"/>
+ <property name="tokens" value="METHOD_REF"/>
+ <property name="option" value="nl"/>
+ </module>
+ <module name="PackageName">
+ <property name="format" value="^(org)\.apache.eventmesh(\.[a-zA-Z][a-zA-Z0-9]*)+$"/>
+ <message key="name.invalidPattern"
+ value="Package name ''{0}'' must match pattern ''{1}''."/>
- <module name="BeforeExecutionExclusionFileFilter">
- <property name="fileNamePattern" value="./eventmesh-runtime/conf/sChat2.jks$"/>
+ </module>
+ <module name="TypeName">
+ <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
+ ANNOTATION_DEF, RECORD_DEF"/>
+ <message key="name.invalidPattern"
+ value="Type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="MemberName">
+ <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+ <message key="name.invalidPattern"
+ value="Member name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="ParameterName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Parameter name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="LambdaParameterName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="CatchParameterName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="LocalVariableName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Local variable name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="PatternVariableName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="ClassTypeParameterName">
+ <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+ <message key="name.invalidPattern"
+ value="Class type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="RecordComponentName">
+ <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+ <message key="name.invalidPattern"
+ value="Record component name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="RecordTypeParameterName">
+ <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+ <message key="name.invalidPattern"
+ value="Record type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="MethodTypeParameterName">
+ <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+ <message key="name.invalidPattern"
+ value="Method type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="InterfaceTypeParameterName">
+ <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+ <message key="name.invalidPattern"
+ value="Interface type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="NoFinalizer"/>
+ <module name="GenericWhitespace">
+ <message key="ws.followed"
+ value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+ <message key="ws.preceded"
+ value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+ <message key="ws.illegalFollow"
+ value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+ <message key="ws.notPreceded"
+ value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+ </module>
+ <module name="Indentation">
+ <property name="basicOffset" value="4"/>
+ <property name="braceAdjustment" value="2"/>
+ <property name="caseIndent" value="2"/>
+ <property name="throwsIndent" value="4"/>
+ <property name="lineWrappingIndentation" value="4"/>
+ <property name="arrayInitIndent" value="2"/>
+ </module>
+ <module name="AbbreviationAsWordInName">
+ <property name="ignoreFinal" value="false"/>
+ <property name="allowedAbbreviationLength" value="0"/>
+ <property name="tokens"
+ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
+ PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
+ RECORD_COMPONENT_DEF"/>
+ </module>
+ <module name="OverloadMethodsDeclarationOrder"/>
+ <module name="VariableDeclarationUsageDistance"/>
+ <module name="MethodParamPad">
+ <property name="tokens"
+ value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
+ SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
+ </module>
+ <module name="NoWhitespaceBefore">
+ <property name="tokens"
+ value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
+ LABELED_STAT, METHOD_REF"/>
+ <property name="allowLineBreaks" value="true"/>
+ </module>
+ <module name="ParenPad">
+ <property name="tokens"
+ value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
+ EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
+ LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
+ METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
+ RECORD_DEF"/>
+ </module>
+ <module name="OperatorWrap">
+ <property name="option" value="NL"/>
+ <property name="tokens"
+ value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
+ LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
+ TYPE_EXTENSION_AND "/>
+ </module>
+ <module name="AnnotationLocation">
+ <property name="id" value="AnnotationLocationMostCases"/>
+ <property name="tokens"
+ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
+ RECORD_DEF, COMPACT_CTOR_DEF"/>
+ </module>
+ <module name="AnnotationLocation">
+ <property name="id" value="AnnotationLocationVariables"/>
+ <property name="tokens" value="VARIABLE_DEF"/>
+ <property name="allowSamelineMultipleAnnotations" value="true"/>
+ </module>
+ <module name="NonEmptyAtclauseDescription"/>
+ <module name="InvalidJavadocPosition"/>
+ <module name="JavadocTagContinuationIndentation"/>
+ <module name="SummaryJavadoc">
+ <property name="forbiddenSummaryFragments"
+ value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+ </module>
+ <module name="JavadocParagraph"/>
+ <module name="RequireEmptyLineBeforeBlockTagGroup"/>
+ <module name="AtclauseOrder">
+ <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
+ <property name="target"
+ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+ </module>
+ <module name="JavadocMethod">
+ <property name="accessModifiers" value="public"/>
+ <property name="allowMissingParamTags" value="true"/>
+ <property name="allowMissingReturnTag" value="true"/>
+ <property name="allowedAnnotations" value="Override, Test"/>
+ <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
+ </module>
+ <module name="MissingJavadocMethod">
+ <property name="scope" value="public"/>
+ <property name="minLineCount" value="2"/>
+ <property name="allowedAnnotations" value="Override, Test"/>
+ <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
+ COMPACT_CTOR_DEF"/>
+ </module>
+ <module name="MissingJavadocType">
+ <property name="scope" value="protected"/>
+ <property name="tokens"
+ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
+ RECORD_DEF, ANNOTATION_DEF"/>
+ <property name="excludeScope" value="nothing"/>
+ </module>
+ <module name="MethodName">
+ <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+ <message key="name.invalidPattern"
+ value="Method name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="SingleLineJavadoc"/>
+ <module name="EmptyCatchBlock">
+ <property name="exceptionVariableName" value="expected"/>
+ </module>
+ <module name="CommentsIndentation">
+ <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
+ </module>
+ <module name="SuppressionXpathFilter">
+ <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
+ default="checkstyle-xpath-suppressions.xml" />
+ <property name="optional" value="true"/>
+ </module>
</module>
</module>
diff --git a/style/codeStyle.xml b/style/codeStyle.xml
deleted file mode 100644
index 6b60186..0000000
--- a/style/codeStyle.xml
+++ /dev/null
@@ -1,143 +0,0 @@
-<!--
- ~ 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="EventMesh">
- <option name="USE_SAME_INDENTS" value="true"/>
- <option name="IGNORE_SAME_INDENTS_FOR_LANGUAGES" value="true"/>
- <option name="OTHER_INDENT_OPTIONS">
- <value>
- <option name="INDENT_SIZE" value="4"/>
- <option name="CONTINUATION_INDENT_SIZE" value="4"/>
- <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="PREFER_LONGER_NAMES" value="false"/>
- <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000"/>
- <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000"/>
- <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
- <value/>
- </option>
- <option name="IMPORT_LAYOUT_TABLE">
- <value>
- <package name="" withSubpackages="true" static="false"/>
- <emptyLine/>
- <package name="" withSubpackages="true" static="true"/>
- </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_KEEP_INVALID_TAGS" value="false"/>
- <option name="JD_DO_NOT_WRAP_ONE_LINE_COMMENTS" value="true"/>
- <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
- <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
- <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
- <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
- <option name="WHILE_ON_NEW_LINE" value="true"/>
- <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
- <option name="ALIGN_MULTILINE_FOR" value="false"/>
- <option name="SPACE_AFTER_TYPE_CAST" value="true"/>
- <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true"/>
- <option name="METHOD_PARAMETERS_WRAP" value="1"/>
- <option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true"/>
- <option name="LABELED_STATEMENT_WRAP" value="1"/>
- <option name="WRAP_COMMENTS" value="true"/>
- <option name="METHOD_ANNOTATION_WRAP" value="1"/>
- <option name="CLASS_ANNOTATION_WRAP" value="1"/>
- <option name="FIELD_ANNOTATION_WRAP" value="1"/>
- <JavaCodeStyleSettings>
- <option name="CLASS_NAMES_IN_JAVADOC" value="3"/>
- </JavaCodeStyleSettings>
- <XML>
- <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true"/>
- </XML>
- <ADDITIONAL_INDENT_OPTIONS fileType="haml">
- <option name="INDENT_SIZE" value="2"/>
- </ADDITIONAL_INDENT_OPTIONS>
- <codeStyleSettings language="Groovy">
- <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
- <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
- <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
- <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
- <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
- <option name="ALIGN_MULTILINE_FOR" value="false"/>
- <option name="METHOD_PARAMETERS_WRAP" value="1"/>
- <option name="METHOD_ANNOTATION_WRAP" value="1"/>
- <option name="CLASS_ANNOTATION_WRAP" value="1"/>
- <option name="FIELD_ANNOTATION_WRAP" value="1"/>
- <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
- <indentOptions>
- <option name="CONTINUATION_INDENT_SIZE" value="4"/>
- </indentOptions>
- </codeStyleSettings>
- <codeStyleSettings language="HOCON">
- <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
- <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
- </codeStyleSettings>
- <codeStyleSettings language="JAVA">
- <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
- <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
- <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
- <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
- <option name="WHILE_ON_NEW_LINE" value="true"/>
- <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
- <option name="ALIGN_MULTILINE_FOR" value="false"/>
- <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true"/>
- <option name="METHOD_PARAMETERS_WRAP" value="1"/>
- <option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true"/>
- <option name="LABELED_STATEMENT_WRAP" value="1"/>
- <option name="METHOD_ANNOTATION_WRAP" value="1"/>
- <option name="CLASS_ANNOTATION_WRAP" value="1"/>
- <option name="FIELD_ANNOTATION_WRAP" value="1"/>
- <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
- <indentOptions>
- <option name="CONTINUATION_INDENT_SIZE" value="4"/>
- </indentOptions>
- </codeStyleSettings>
- <codeStyleSettings language="JSON">
- <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
- <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
- </codeStyleSettings>
- <codeStyleSettings language="Scala">
- <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
- <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
- <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
- <option name="WHILE_ON_NEW_LINE" value="true"/>
- <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
- <option name="ALIGN_MULTILINE_FOR" value="false"/>
- <option name="METHOD_PARAMETERS_WRAP" value="1"/>
- <option name="METHOD_ANNOTATION_WRAP" value="1"/>
- <option name="CLASS_ANNOTATION_WRAP" value="1"/>
- <option name="FIELD_ANNOTATION_WRAP" value="1"/>
- <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
- <indentOptions>
- <option name="INDENT_SIZE" value="4"/>
- <option name="CONTINUATION_INDENT_SIZE" value="4"/>
- <option name="TAB_SIZE" value="4"/>
- </indentOptions>
- </codeStyleSettings>
- <codeStyleSettings language="XML">
- <indentOptions>
- <option name="CONTINUATION_INDENT_SIZE" value="4"/>
- </indentOptions>
- </codeStyleSettings>
-</code_scheme>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: commits-help@eventmesh.apache.org