-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Motivation: To ensure code consistency and quality through the adoption of Checkstyle Modification: Added Checkstyle plugin and configuration, updated code to comply with new coding standards. Set version as INTERNAL on internal modules Result: Enhanced code quality and consistency across the project, facilitating easier contributions and maintenance.
- Loading branch information
Showing
37 changed files
with
382 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| ~ Copyright 2024 asyncer.io projects | ||
| ~ | ||
| ~ Licensed 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 | ||
| ~ | ||
| ~ https://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. | ||
| --> | ||
|
|
||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>io.asyncer</groupId> | ||
| <artifactId>build-tools</artifactId> | ||
| <version>INTERNAL</version> | ||
| </project> |
10 changes: 10 additions & 0 deletions
10
build-tools/src/main/resources/io/asyncer/checkstyle-suppressions.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE suppressions PUBLIC | ||
| "-//Puppy Crawl//DTD Suppressions 1.1//EN" | ||
| "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd"> | ||
| <suppressions> | ||
| <suppress files="[/\\]target[/\\]" checks=".*"/> | ||
| <suppress files="[/\\].mvn[/\\]" checks=".*"/> | ||
| <suppress files="[/\\].idea[/\\]" checks=".*"/> | ||
| <suppress files="[/\\].git[/\\]" checks=".*"/> | ||
| </suppressions> |
203 changes: 203 additions & 0 deletions
203
build-tools/src/main/resources/io/asyncer/checkstyle.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE module PUBLIC | ||
| "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" | ||
| "https://checkstyle.org/dtds/configuration_1_3.dtd"> | ||
|
|
||
| <!-- | ||
| Checkstyle configuration that checks the sun coding conventions from: | ||
| - the Java Language Specification at | ||
| https://docs.oracle.com/javase/specs/jls/se11/html/index.html | ||
| - the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html | ||
| - the Javadoc guidelines at | ||
| https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html | ||
| - the JDK Api documentation https://docs.oracle.com/en/java/javase/11/ | ||
| - some best practices | ||
| Checkstyle is very configurable. Be sure to read the documentation at | ||
| https://checkstyle.org (or in your downloaded distribution). | ||
| Most Checks are configurable, be sure to consult the documentation. | ||
| To completely disable a check, just comment it out or delete it from the file. | ||
| To suppress certain violations please review suppression filters. | ||
| Finally, it is worth reading the documentation. | ||
| --> | ||
|
|
||
| <module name="Checker"> | ||
| <!-- | ||
| If you set the basedir property below, then all reported file | ||
| names will be relative to the specified directory. See | ||
| https://checkstyle.org/config.html#Checker | ||
| <property name="basedir" value="${basedir}"/> | ||
| --> | ||
| <property name="severity" value="error"/> | ||
|
|
||
| <property name="fileExtensions" value="java, properties, xml"/> | ||
|
|
||
| <!-- Excludes all 'module-info.java' files --> | ||
| <!-- See https://checkstyle.org/filefilters/index.html --> | ||
| <module name="BeforeExecutionExclusionFileFilter"> | ||
| <property name="fileNamePattern" value="module\-info\.java$"/> | ||
| </module> | ||
|
|
||
| <!-- https://checkstyle.org/filters/suppressionfilter.html --> | ||
| <module name="SuppressionFilter"> | ||
| <property name="file" value="${org.checkstyle.sun.suppressionfilter.config}" | ||
| default="checkstyle-suppressions.xml"/> | ||
| <property name="optional" value="true"/> | ||
| </module> | ||
|
|
||
| <!-- Checks that a package-info.java file exists for each package. --> | ||
| <!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage --> | ||
| <module name="JavadocPackage"/> | ||
|
|
||
| <!-- enables @SuppressWarning("checkstyle:xxxx") --> | ||
| <module name="SuppressWarningsFilter" /> | ||
|
|
||
| <!-- Checks whether files end with a new line. --> | ||
| <!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html --> | ||
| <module name="NewlineAtEndOfFile"/> | ||
|
|
||
| <!-- Checks that property files contain the same keys. --> | ||
| <!-- See https://checkstyle.org/checks/misc/translation.html --> | ||
| <module name="Translation"/> | ||
|
|
||
| <!-- Checks for Size Violations. --> | ||
| <!-- See https://checkstyle.org/checks/sizes/index.html --> | ||
| <module name="FileLength"/> | ||
| <module name="LineLength"> | ||
| <property name="max" value="120"/> | ||
| <property name="fileExtensions" value="java"/> | ||
| </module> | ||
|
|
||
| <!-- Checks for whitespace --> | ||
| <!-- See https://checkstyle.org/checks/whitespace/index.html --> | ||
| <module name="FileTabCharacter"/> | ||
|
|
||
| <!-- Miscellaneous other checks. --> | ||
| <!-- See https://checkstyle.org/checks/misc/index.html --> | ||
| <module name="RegexpSingleline"> | ||
| <property name="format" value="\s+$"/> | ||
| <property name="minimum" value="0"/> | ||
| <property name="maximum" value="0"/> | ||
| <property name="message" value="Line has trailing spaces."/> | ||
| </module> | ||
|
|
||
| <!-- Checks for Headers --> | ||
| <!-- See https://checkstyle.org/checks/header/index.html --> | ||
| <!-- <module name="Header"> --> | ||
| <!-- <property name="headerFile" value="${checkstyle.header.file}"/> --> | ||
| <!-- <property name="fileExtensions" value="java"/> --> | ||
| <!-- </module> --> | ||
|
|
||
| <module name="RegexpSingleline"> | ||
| <property name="format" value="^(\s|\*|#)*Copyright\s+[0-9]+\s+asyncer.io projects\s*$"/> | ||
| <property name="message" value="license header missing"/> | ||
| <property name="minimum" value="1"/> | ||
| <property name="maximum" value="1"/> | ||
| </module> | ||
|
|
||
|
|
||
| <module name="TreeWalker"> | ||
|
|
||
| <!-- Checks for Javadoc comments. --> | ||
| <!-- See https://checkstyle.org/checks/javadoc/index.html --> | ||
| <module name="InvalidJavadocPosition"/> | ||
| <module name="JavadocStyle"> | ||
| <property name="checkFirstSentence" value="false"/> | ||
| </module> | ||
|
|
||
| <!-- enables @SuppressWarning("checkstyle:xxxx") --> | ||
| <module name="SuppressWarningsHolder" /> | ||
| <!-- <module name="MissingJavadocMethod"/>--> | ||
|
|
||
| <!-- Checks for Naming Conventions. --> | ||
| <!-- See https://checkstyle.org/checks/naming/index.html --> | ||
| <!-- <module name="ConstantName"/>--> | ||
| <module name="LocalFinalVariableName"/> | ||
| <module name="LocalVariableName"/> | ||
| <module name="MemberName"/> | ||
| <module name="MethodName"/> | ||
| <module name="PackageName"/> | ||
| <module name="ParameterName"/> | ||
| <module name="StaticVariableName"/> | ||
| <module name="TypeName"/> | ||
|
|
||
| <!-- Checks for imports --> | ||
| <!-- See https://checkstyle.org/checks/imports/index.html --> | ||
| <module name="AvoidStarImport"/> | ||
| <module name="IllegalImport"/> <!-- defaults to sun.* packages --> | ||
| <module name="RedundantImport"/> | ||
| <module name="UnusedImports"> | ||
| <property name="processJavadoc" value="true"/> | ||
| </module> | ||
|
|
||
| <!-- Checks for Size Violations. --> | ||
| <!-- See https://checkstyle.org/checks/sizes/index.html --> | ||
| <!-- <module name="MethodLength"/>--> | ||
| <!-- <module name="ParameterNumber"/>--> | ||
|
|
||
| <!-- Checks for whitespace --> | ||
| <!-- See https://checkstyle.org/checks/whitespace/index.html --> | ||
| <module name="EmptyForIteratorPad"/> | ||
| <module name="GenericWhitespace"/> | ||
| <module name="MethodParamPad"/> | ||
| <module name="ParenPad"/> | ||
| <module name="TypecastParenPad"/> | ||
| <module name="WhitespaceAfter"/> | ||
| <module name="WhitespaceAround"/> | ||
|
|
||
| <!-- Modifier Checks --> | ||
| <!-- See https://checkstyle.org/checks/modifier/index.html --> | ||
| <module name="ModifierOrder"/> | ||
| <module name="RedundantModifier"/> | ||
|
|
||
| <!-- Checks for blocks. You know, those {}'s --> | ||
| <!-- See https://checkstyle.org/checks/blocks/index.html --> | ||
| <module name="AvoidNestedBlocks"> | ||
| <property name="allowInSwitchCase" value="true"/> | ||
| </module> | ||
| <module name="EmptyBlock"/> | ||
| <module name="LeftCurly"/> | ||
| <module name="NeedBraces"/> | ||
| <module name="RightCurly"/> | ||
|
|
||
| <!-- Checks for common coding problems --> | ||
| <!-- See https://checkstyle.org/checks/coding/index.html --> | ||
| <module name="EmptyStatement"/> | ||
| <module name="EqualsHashCode"/> | ||
| <module name="IllegalInstantiation"/> | ||
| <module name="SimplifyBooleanExpression"/> | ||
| <module name="SimplifyBooleanReturn"/> | ||
|
|
||
| <!-- Checks for class design --> | ||
| <!-- See https://checkstyle.org/checks/design/index.html --> | ||
| <module name="DesignForExtension"/> | ||
| <module name="FinalClass"/> | ||
| <module name="HideUtilityClassConstructor"/> | ||
| <module name="InterfaceIsType"/> | ||
|
|
||
| <!-- Miscellaneous other checks. --> | ||
| <!-- See https://checkstyle.org/checks/misc/index.html --> | ||
| <module name="ArrayTypeStyle"/> | ||
| <!-- <module name="FinalParameters"/>--> | ||
| <!-- <module name="TodoComment"/>--> | ||
| <module name="UpperEll"/> | ||
|
|
||
| <!-- https://checkstyle.org/filters/suppressionxpathfilter.html --> | ||
| <module name="SuppressionXpathFilter"> | ||
| <property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}" | ||
| default="checkstyle-xpath-suppressions.xml"/> | ||
| <property name="optional" value="true"/> | ||
| </module> | ||
| </module> | ||
| </module> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.