Skip to content

Commit 0d358c4

Browse files
author
Morgan Davies
authored
Cleanup excessive linter checks (#2609)
* Cleanup excessive linter checks Commiters have identified that the super linter checks are excessively strict, so this pr attempts to summarise and eliminate checks that appear non-blocking to the Adoptium community Signed-off-by: Morgan Davies <[email protected]> * Disable rules for build template * They're mostly to do with how the build template is lain out which doesn't matter as values get replaced when it is executed Signed-off-by: Morgan Davies <[email protected]> * Cleanup of markdown files A lot of these are simple changes but the rules that were flagged are valid issues imo (the only one not being so is MD029 which is handled automatically by github so there is no need to enforce it) Signed-off-by: Morgan Davies <[email protected]> * Disable shellcheck on build template This file is modified by build.sh so it shouldn't really be linted Signed-off-by: Morgan Davies <[email protected]> * Linter regex exclude pointing to wrong location * Add lang tag to Azure Readme * Add initial checkstyle java linter config * This allows us to exclude and configure linter rules * Add jscpd config * This is warning us about code clones in the test files which are not actually clones as they implement different parameters Signed-off-by: Morgan Davies <[email protected]> * Disable the more strict java rules * Common standards are to include a comment on why they have been disabled Signed-off-by: Morgan Davies <[email protected]> * Commenting the rules out didn't work, try disabling them using the xml class * Java config file should have underscore * Expand jscpd to cover backward paths too * Use a suppression config file * Missing doctype declaration and correct format * Add filepaths * Move suppression filter out of treewalker * Cleanup reamaining shell errors * Ignore tab warnings * Tabs and spaces generally do the same thing Signed-off-by: Morgan Davies <[email protected]> * Fix CudaEnabled & FeatureTest lint issues * Fix JdkPlatform & StreamUtils lint jobs * Missing periods and final keyword * Disable perl linting for now * Spawned an issue to address seperatly * Revert enable of VALIDATE_ALL_CODEBASE * Delete java-tool * Hasn't been touched in 3 years * Generating lots of errors
1 parent aa9ac3c commit 0d358c4

File tree

21 files changed

+374
-1432
lines changed

21 files changed

+374
-1432
lines changed

‎.azure-devops/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Supported Versions/Platforms:
1212
| jdk15 hotspot | ✔️ | ✔️ | ❌ |
1313
| jdk-tip hotspot| ✔️ | ✔️ | ❌ |
1414

15-
1615
## Requirements
1716

1817
1. Azure DevOps Account
@@ -22,11 +21,11 @@ If you don't have an Azure DevOps organization, you can start from
2221

2322
2. Required Pipeline Variables:
2423

25-
1. `JAVA_TO_BUILD`: jdk8u | jdk11u | jdk14u | jdk15u | jdk
24+
- `JAVA_TO_BUILD`: jdk8u | jdk11u | jdk14u | jdk15u | jdk
2625

2726
3. Optional Pipeline Variables:
2827

29-
1. `EXTRA_MAKEJDK_ANY_PLATFORM_OPTIONS`: other options in makejdk-any-platform.sh
28+
- `EXTRA_MAKEJDK_ANY_PLATFORM_OPTIONS`: other options in makejdk-any-platform.sh
3029

3130
## Quick Start
3231

@@ -36,7 +35,7 @@ If you don't have an Azure DevOps organization, you can start from
3635

3736
2. Create a new Pipeline by using an **Existing Azure Pipeline YAML file**
3837
and choose `.azure-devops/pipelines.yml` file.
39-
38+
4039
Plase set the `JAVA_TO_BUILD` variable in the review step.
4140

4241
3. Start the pipeline and you can download the artifacts once the jobs complete.
@@ -75,7 +74,7 @@ This may add a maintenance cost over time as upstream changes may conflicts with
7574

7675
Second, you can create another YAML step template and save it to `build/shared/set_filename.yml` and add it to the `build.yml` file.
7776

78-
```
77+
```yml
7978
steps:
8079
- template: ./steps/shared/before.yml
8180
- template: ./steps/shared/set_filename.yml
@@ -86,8 +85,8 @@ steps:
8685
8786
By doing this you will not get any merge conflicts when you pull the changes from upstream.
8887
89-
<!---
88+
<!---
9089
Links.
9190
--->
9291
[azdo_main]: https://azure.microsoft.com/en-ca/services/devops/
93-
[azdo_make_project_public]: https://docs.microsoft.com/en-us/azure/devops/organizations/public/make-project-public
92+
[azdo_make_project_public]: https://docs.microsoft.com/en-us/azure/devops/organizations/public/make-project-public

‎.github/linters/.jscpd.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"threshold": 0,
3+
"reporters": [
4+
"consoleFull"
5+
],
6+
"ignore": [
7+
"**/__snapshots__/**",
8+
"**/test/**"
9+
],
10+
"absolute": true
11+
}

‎.github/linters/.markdown-lint.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@
2020
MD013: false # Line length is usually not important and the 80 char limit is way too small anyway
2121
MD026: false # Trailing punctuation in header
2222
MD033: false # Inline HTML is important for multilines and checkboxes within markdown tables
23-
MD034: false # no-bare-urls Bare URL used
23+
MD034: false # no-bare-urls Bare URL used
24+
MD029: false # Markdown automatically calculates the ordered list order

‎.github/linters/sun_checks.xml

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
8+
Checkstyle configuration that checks the sun coding conventions from:
9+
10+
- the Java Language Specification at
11+
https://docs.oracle.com/javase/specs/jls/se11/html/index.html
12+
13+
- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
14+
15+
- the Javadoc guidelines at
16+
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
17+
18+
- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
19+
20+
- some best practices
21+
22+
Checkstyle is very configurable. Be sure to read the documentation at
23+
https://checkstyle.org (or in your downloaded distribution).
24+
25+
Most Checks are configurable, be sure to consult the documentation.
26+
27+
To completely disable a check, just comment it out or delete it from the file.
28+
To suppress certain violations please review suppression filters.
29+
30+
Finally, it is worth reading the documentation.
31+
32+
-->
33+
34+
<module name="Checker">
35+
<!--
36+
If you set the basedir property below, then all reported file
37+
names will be relative to the specified directory. See
38+
https://checkstyle.org/config.html#Checker
39+
40+
<property name="basedir" value="${basedir}"/>
41+
-->
42+
<property name="severity" value="error"/>
43+
44+
<property name="fileExtensions" value="java, properties, xml"/>
45+
46+
<!-- Excludes all 'module-info.java' files -->
47+
<!-- See https://checkstyle.org/config_filefilters.html -->
48+
<module name="BeforeExecutionExclusionFileFilter">
49+
<property name="fileNamePattern" value="module\-info\.java$"/>
50+
</module>
51+
52+
<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
53+
<module name="SuppressionFilter">
54+
<property name="file" value="${org.checkstyle.sun.suppressionfilter.config}" default="checkstyle-suppressions.xml" />
55+
<property name="optional" value="true"/>
56+
</module>
57+
58+
<!-- Checks that a package-info.java file exists for each package. -->
59+
<!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
60+
<module name="JavadocPackage"/>
61+
62+
<!-- Checks whether files end with a new line. -->
63+
<!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
64+
<module name="NewlineAtEndOfFile"/>
65+
66+
<!-- Checks that property files contain the same keys. -->
67+
<!-- See https://checkstyle.org/config_misc.html#Translation -->
68+
<module name="Translation"/>
69+
70+
<!-- Miscellaneous other checks. -->
71+
<!-- See https://checkstyle.org/config_misc.html -->
72+
<module name="RegexpSingleline">
73+
<property name="format" value="\s+$"/>
74+
<property name="minimum" value="0"/>
75+
<property name="maximum" value="0"/>
76+
<property name="message" value="Line has trailing spaces."/>
77+
</module>
78+
79+
<!-- Enables @SuppressWarnings Support -->
80+
<module name="SuppressWarningsFilter"/>
81+
82+
<!-- Suppress checks with config file -->
83+
<module name="SuppressionFilter">
84+
<property name="file" value=".github/linters/suppressed-java.xml"/>
85+
</module>
86+
87+
<module name="TreeWalker">
88+
89+
<!-- Checks for Javadoc comments. -->
90+
<!-- See https://checkstyle.org/config_javadoc.html -->
91+
<module name="InvalidJavadocPosition"/>
92+
<module name="JavadocMethod"/>
93+
<module name="JavadocType"/>
94+
<module name="JavadocStyle"/>
95+
<module name="MissingJavadocMethod"/>
96+
<!-- Enables @SuppressWarnings Support -->
97+
<module name="SuppressWarningsHolder"/>
98+
99+
<!-- Checks for Naming Conventions. -->
100+
<!-- See https://checkstyle.org/config_naming.html -->
101+
<module name="ConstantName"/>
102+
<module name="LocalFinalVariableName"/>
103+
<module name="LocalVariableName"/>
104+
<module name="MemberName"/>
105+
<module name="MethodName"/>
106+
<module name="PackageName"/>
107+
<module name="ParameterName"/>
108+
<module name="StaticVariableName"/>
109+
<module name="TypeName"/>
110+
111+
<!-- Checks for imports -->
112+
<!-- See https://checkstyle.org/config_imports.html -->
113+
<module name="AvoidStarImport"/>
114+
<module name="IllegalImport"/>
115+
<!-- defaults to sun.* packages -->
116+
<module name="RedundantImport"/>
117+
<module name="UnusedImports">
118+
<property name="processJavadoc" value="false"/>
119+
</module>
120+
121+
<!-- Checks for Size Violations. -->
122+
<!-- See https://checkstyle.org/config_sizes.html -->
123+
<module name="MethodLength"/>
124+
<module name="ParameterNumber"/>
125+
126+
<!-- Checks for whitespace -->
127+
<!-- See https://checkstyle.org/config_whitespace.html -->
128+
<module name="EmptyForIteratorPad"/>
129+
<module name="GenericWhitespace"/>
130+
<module name="MethodParamPad"/>
131+
<module name="NoWhitespaceAfter"/>
132+
<module name="NoWhitespaceBefore"/>
133+
<module name="OperatorWrap"/>
134+
<module name="ParenPad"/>
135+
<module name="TypecastParenPad"/>
136+
<module name="WhitespaceAfter"/>
137+
<module name="WhitespaceAround"/>
138+
139+
<!-- Modifier Checks -->
140+
<!-- See https://checkstyle.org/config_modifiers.html -->
141+
<module name="ModifierOrder"/>
142+
<module name="RedundantModifier"/>
143+
144+
<!-- Checks for blocks. You know, those {}'s -->
145+
<!-- See https://checkstyle.org/config_blocks.html -->
146+
<module name="AvoidNestedBlocks"/>
147+
<module name="EmptyBlock"/>
148+
<module name="LeftCurly"/>
149+
<module name="NeedBraces"/>
150+
<module name="RightCurly"/>
151+
152+
<!-- Checks for common coding problems -->
153+
<!-- See https://checkstyle.org/config_coding.html -->
154+
<module name="EmptyStatement"/>
155+
<module name="EqualsHashCode"/>
156+
<module name="HiddenField"/>
157+
<module name="IllegalInstantiation"/>
158+
<module name="InnerAssignment"/>
159+
<module name="MissingSwitchDefault"/>
160+
<module name="MultipleVariableDeclarations"/>
161+
<module name="SimplifyBooleanExpression"/>
162+
<module name="SimplifyBooleanReturn"/>
163+
164+
<!-- Checks for class design -->
165+
<!-- See https://checkstyle.org/config_design.html -->
166+
<module name="DesignForExtension"/>
167+
<module name="FinalClass"/>
168+
<module name="HideUtilityClassConstructor"/>
169+
<module name="InterfaceIsType"/>
170+
<module name="VisibilityModifier"/>
171+
172+
<!-- Miscellaneous other checks. -->
173+
<!-- See https://checkstyle.org/config_misc.html -->
174+
<module name="ArrayTypeStyle"/>
175+
<module name="FinalParameters"/>
176+
<module name="UpperEll"/>
177+
178+
<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
179+
<module name="SuppressionXpathFilter">
180+
<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}" default="checkstyle-xpath-suppressions.xml" />
181+
<property name="optional" value="true"/>
182+
</module>
183+
184+
</module>
185+
186+
</module>

‎.github/linters/suppressed-java.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0"?>
2+
3+
<!DOCTYPE suppressions PUBLIC
4+
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
5+
"https://checkstyle.org/dtds/suppressions_1_2.dtd"
6+
>
7+
8+
<suppressions>
9+
<suppress files="." checks="MagicNumber" /> <!-- Disabled because magic numbers are not generally abused and are more useful being allowed -->
10+
<suppress files="." checks="TodoComment" /> <!-- We shouldn't have to be reminded about todo's on every linter iteration, we have IDE"s that do that! -->
11+
<suppress files="." checks="JavadocVariable" /> <!-- Disabled as we don't need comments on every single new variable -->
12+
<suppress files="." checks="FileLength" /> <!-- These two are disabled as we don't care if line or file size is too big -->
13+
<suppress files="." checks="LineLength" />
14+
<suppress files="." checks="Header" /> <!-- Disabled as we don't use headers in our project for the test files -->
15+
<suppress files="." checks="FileTabCharacter" /> <!-- Disabled as it generally doesn't matter if tabs are disabled or not -->
16+
</suppressions>

‎.github/workflows/linter.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,6 @@ jobs:
5050
VALIDATE_ALL_CODEBASE: false
5151
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5252
# Markdown lint complains about the issue templates
53-
FILTER_REGEX_EXCLUDE: .github/workflows/ISSUE_TEMPLATE/*
53+
FILTER_REGEX_EXCLUDE: .github/ISSUE_TEMPLATE/*
54+
# TODO: Disable the perl linter as there are lots of errors that are not really understood, see https://github.com/adoptium/temurin-build/issues/2612
55+
VALIDATE_PERL: false

0 commit comments

Comments
 (0)