Compare commits
60 commits
Author | SHA1 | Date | |
---|---|---|---|
e16a3eac76 | |||
ef3e35d766 | |||
10f738bea8 | |||
ad7032d82f | |||
c9585f3a5c | |||
e8c901c6c1 | |||
f55e010286 | |||
610a042ced | |||
ccc04bf81d | |||
4e373bfd10 | |||
91a113ed5a | |||
1c8fc1d685 | |||
a8d595cce0 | |||
6cd5bc8e8f | |||
b326e9787c | |||
bddb869fe8 | |||
f040cfd9f9 | |||
34042de676 | |||
c6c80b6f3f | |||
534be59ae8 | |||
a490b80f42 | |||
41b6af3a45 | |||
1b986c7f21 | |||
b26c0ff129 | |||
1659308eb5 | |||
638d12c5c2 | |||
c4672d88ae | |||
69c0b6692d | |||
5d0147154b | |||
b332c6e885 | |||
440cd91c8a | |||
dc2656200b | |||
b357caf341 | |||
71141e0b3e | |||
c5e11dd1cb | |||
9aaad3381e | |||
02a626a756 | |||
9ddf93057a | |||
dca356b140 | |||
6994600afe | |||
c2779f7462 | |||
6f3e4442dd | |||
2c8c219b81 | |||
51fa6fbab2 | |||
11476127f0 | |||
2fd73691c2 | |||
660a4ea840 | |||
fc84ae9d60 | |||
b3dce4fa0a | |||
41169b88d9 | |||
0429bbec0a | |||
bf6cf48978 | |||
6b638fcabb | |||
43cc65ba1f | |||
1b419e2baa | |||
e1263fd3e6 | |||
0a2a2f4b03 | |||
c93c9ea2d0 | |||
6f11563739 | |||
f623921ff3 |
26 changed files with 340 additions and 128 deletions
20
.github/workflows/bld.yml
vendored
20
.github/workflows/bld.yml
vendored
|
@ -1,14 +1,16 @@
|
||||||
name: bld-ci
|
name: bld-ci
|
||||||
|
|
||||||
on: [push, pull_request, workflow_dispatch]
|
on: [ push, pull_request, workflow_dispatch ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-bld-project:
|
build-bld-project:
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
java-version: [17, 21, 22]
|
java-version: [ 17, 21, 24 ]
|
||||||
|
kotlin-version: [ 1.9.25, 2.0.21, 2.1.20 ]
|
||||||
|
os: [ ubuntu-latest, windows-latest, macos-latest ]
|
||||||
|
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout source repository
|
- name: Checkout source repository
|
||||||
|
@ -22,8 +24,16 @@ jobs:
|
||||||
distribution: "zulu"
|
distribution: "zulu"
|
||||||
java-version: ${{ matrix.java-version }}
|
java-version: ${{ matrix.java-version }}
|
||||||
|
|
||||||
|
- name: Download dependencies [examples]
|
||||||
|
working-directory: examples
|
||||||
|
run: ./bld download
|
||||||
|
|
||||||
|
- name: Compile and Run Checkstyle [examples]
|
||||||
|
working-directory: examples
|
||||||
|
run: ./bld compile checkstyle-custom
|
||||||
|
|
||||||
- name: Download dependencies
|
- name: Download dependencies
|
||||||
run: ./bld download
|
run: ./bld download
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: ./bld compile test
|
run: ./bld compile test
|
4
.github/workflows/pages.yml
vendored
4
.github/workflows/pages.yml
vendored
|
@ -47,11 +47,11 @@ jobs:
|
||||||
uses: actions/configure-pages@v3
|
uses: actions/configure-pages@v3
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v1
|
uses: actions/upload-pages-artifact@v3
|
||||||
with:
|
with:
|
||||||
# Upload generated Javadocs repository
|
# Upload generated Javadocs repository
|
||||||
path: "build/javadoc/"
|
path: "build/javadoc/"
|
||||||
|
|
||||||
- name: Deploy to GitHub Pages
|
- name: Deploy to GitHub Pages
|
||||||
id: deployment
|
id: deployment
|
||||||
uses: actions/deploy-pages@v1
|
uses: actions/deploy-pages@v4
|
||||||
|
|
5
.idea/codeStyles/codeStyleConfig.xml
generated
Normal file
5
.idea/codeStyles/codeStyleConfig.xml
generated
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
<component name="ProjectCodeStyleConfiguration">
|
||||||
|
<state>
|
||||||
|
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Erik's Code Style" />
|
||||||
|
</state>
|
||||||
|
</component>
|
13
.idea/icon.svg
generated
Normal file
13
.idea/icon.svg
generated
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg width="100%" height="100%" viewBox="0 0 179 108" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
|
||||||
|
<g transform="matrix(1,0,0,1,-210.511,-96.3382)">
|
||||||
|
<g transform="matrix(1,0,0,1,-23.3386,-649.816)">
|
||||||
|
<g transform="matrix(0.221288,0,0,0.24,73.9536,390.254)">
|
||||||
|
<path d="M722.568,1482.92L722.568,1921.1L808.968,1921.1L808.968,1888.7C822.168,1907.9 846.168,1930.1 893.568,1930.1C933.168,1930.1 961.968,1917.5 985.368,1893.5C1012.97,1865.9 1027.37,1827.5 1027.37,1786.1C1027.37,1741.7 1011.17,1705.1 985.368,1680.5C961.968,1658.3 928.968,1644.5 892.368,1644.5C862.968,1644.5 830.568,1654.1 808.968,1683.5L808.968,1482.92L722.568,1482.92ZM871.368,1718.9C888.768,1718.9 903.768,1723.7 917.568,1736.9C930.168,1748.9 938.568,1766.3 938.568,1787.9C938.568,1807.7 930.168,1825.1 917.568,1837.1C904.368,1849.7 887.568,1855.7 872.568,1855.7C856.368,1855.7 837.168,1849.1 823.368,1835.9C813.168,1826.3 803.568,1810.1 803.568,1787.9C803.568,1765.1 812.568,1749.5 822.768,1738.7C836.568,1724.3 852.768,1718.9 871.368,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
|
||||||
|
<rect x="1083.77" y="1482.92" width="86.4" height="438.182" style="fill:rgb(250,144,82);fill-rule:nonzero;"/>
|
||||||
|
<path d="M1531.37,1482.92L1444.97,1482.92L1444.97,1683.5C1423.37,1654.1 1390.97,1644.5 1361.57,1644.5C1324.97,1644.5 1291.97,1658.3 1268.57,1680.5C1242.77,1705.1 1226.57,1741.7 1226.57,1786.1C1226.57,1827.5 1240.97,1865.9 1268.57,1893.5C1291.97,1917.5 1320.77,1930.1 1360.37,1930.1C1407.77,1930.1 1431.77,1907.9 1444.97,1888.7L1444.97,1921.1L1531.37,1921.1L1531.37,1482.92ZM1382.57,1718.9C1401.17,1718.9 1417.37,1724.3 1431.17,1738.7C1441.37,1749.5 1450.37,1765.1 1450.37,1787.9C1450.37,1810.1 1440.77,1826.3 1430.57,1835.9C1416.77,1849.1 1397.57,1855.7 1381.37,1855.7C1366.37,1855.7 1349.57,1849.7 1336.37,1837.1C1323.77,1825.1 1315.37,1807.7 1315.37,1787.9C1315.37,1766.3 1323.77,1748.9 1336.37,1736.9C1350.17,1723.7 1365.17,1718.9 1382.57,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 2.4 KiB |
4
.idea/libraries/bld.xml
generated
4
.idea/libraries/bld.xml
generated
|
@ -2,12 +2,12 @@
|
||||||
<library name="bld">
|
<library name="bld">
|
||||||
<CLASSES>
|
<CLASSES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.0.1.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" />
|
||||||
</CLASSES>
|
</CLASSES>
|
||||||
<JAVADOC />
|
<JAVADOC />
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.0.1-sources.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<excluded>
|
<excluded>
|
||||||
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
||||||
|
|
4
.idea/libraries/compile.xml
generated
4
.idea/libraries/compile.xml
generated
|
@ -7,7 +7,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/compile" />
|
<root url="file://$PROJECT_DIR$/lib/compile" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
4
.idea/libraries/runtime.xml
generated
4
.idea/libraries/runtime.xml
generated
|
@ -8,7 +8,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
4
.idea/libraries/test.xml
generated
4
.idea/libraries/test.xml
generated
|
@ -8,7 +8,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/test" />
|
<root url="file://$PROJECT_DIR$/lib/test" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
|
@ -9,7 +9,7 @@
|
||||||
],
|
],
|
||||||
"java.configuration.updateBuildConfiguration": "automatic",
|
"java.configuration.updateBuildConfiguration": "automatic",
|
||||||
"java.project.referencedLibraries": [
|
"java.project.referencedLibraries": [
|
||||||
"${HOME}/.bld/dist/bld-2.0.1.jar",
|
"${HOME}/.bld/dist/bld-2.2.1.jar",
|
||||||
"lib/**/*.jar"
|
"lib/**/*.jar"
|
||||||
],
|
],
|
||||||
"java.compile.nullAnalysis.mode": "automatic"
|
"java.compile.nullAnalysis.mode": "automatic"
|
||||||
|
|
14
README.md
14
README.md
|
@ -2,12 +2,20 @@
|
||||||
|
|
||||||
[](https://opensource.org/licenses/Apache-2.0)
|
[](https://opensource.org/licenses/Apache-2.0)
|
||||||
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
|
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
|
||||||
[](https://rife2.com/bld)
|
[](https://rife2.com/bld)
|
||||||
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-checkstyle)
|
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-checkstyle)
|
||||||
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-checkstyle)
|
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-checkstyle)
|
||||||
[](https://github.com/rife2/bld-checkstyle/actions/workflows/bld.yml)
|
[](https://github.com/rife2/bld-checkstyle/actions/workflows/bld.yml)
|
||||||
|
|
||||||
To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
|
To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file:
|
||||||
|
|
||||||
|
```properties
|
||||||
|
bld.extension-checkstyle=com.uwyn.rife2:bld-checkstyle
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation.
|
||||||
|
|
||||||
|
## Check Source Code with Checkstyle
|
||||||
|
|
||||||
To check your code with Chesktyle, include the following in your build file:
|
To check your code with Chesktyle, include the following in your build file:
|
||||||
|
|
||||||
|
@ -37,5 +45,5 @@ not provided by the extension. For example:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
repositories = List.of(MAVEN_CENTRAL);
|
repositories = List.of(MAVEN_CENTRAL);
|
||||||
scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 18, 0)));
|
scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 23, 0)));
|
||||||
```
|
```
|
||||||
|
|
|
@ -7,9 +7,9 @@
|
||||||
<!-- BEST PRACTICES -->
|
<!-- BEST PRACTICES -->
|
||||||
<rule ref="category/java/bestpractices.xml">
|
<rule ref="category/java/bestpractices.xml">
|
||||||
<exclude name="AvoidPrintStackTrace"/>
|
<exclude name="AvoidPrintStackTrace"/>
|
||||||
<exclude name="JUnit4TestShouldUseTestAnnotation"/>
|
|
||||||
<exclude name="JUnitTestContainsTooManyAsserts"/>
|
|
||||||
<exclude name="GuardLogStatement"/>
|
<exclude name="GuardLogStatement"/>
|
||||||
|
<exclude name="UnitTestContainsTooManyAsserts"/>
|
||||||
|
<exclude name="UnitTestShouldUseTestAnnotation"/>
|
||||||
</rule>
|
</rule>
|
||||||
|
|
||||||
<rule ref="category/java/bestpractices.xml/MissingOverride">
|
<rule ref="category/java/bestpractices.xml/MissingOverride">
|
||||||
|
|
4
examples/.idea/libraries/bld.xml
generated
4
examples/.idea/libraries/bld.xml
generated
|
@ -2,12 +2,12 @@
|
||||||
<library name="bld">
|
<library name="bld">
|
||||||
<CLASSES>
|
<CLASSES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.0.1.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" />
|
||||||
</CLASSES>
|
</CLASSES>
|
||||||
<JAVADOC />
|
<JAVADOC />
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.0.1-sources.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<excluded>
|
<excluded>
|
||||||
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
||||||
|
|
4
examples/.idea/libraries/compile.xml
generated
4
examples/.idea/libraries/compile.xml
generated
|
@ -7,7 +7,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/compile" />
|
<root url="file://$PROJECT_DIR$/lib/compile" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
4
examples/.idea/libraries/runtime.xml
generated
4
examples/.idea/libraries/runtime.xml
generated
|
@ -8,7 +8,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
4
examples/.idea/libraries/test.xml
generated
4
examples/.idea/libraries/test.xml
generated
|
@ -8,7 +8,7 @@
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/test" />
|
<root url="file://$PROJECT_DIR$/lib/test" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" />
|
||||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" type="SOURCES" />
|
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" type="SOURCES" />
|
||||||
</library>
|
</library>
|
||||||
</component>
|
</component>
|
2
examples/.vscode/settings.json
vendored
2
examples/.vscode/settings.json
vendored
|
@ -9,7 +9,7 @@
|
||||||
],
|
],
|
||||||
"java.configuration.updateBuildConfiguration": "automatic",
|
"java.configuration.updateBuildConfiguration": "automatic",
|
||||||
"java.project.referencedLibraries": [
|
"java.project.referencedLibraries": [
|
||||||
"${HOME}/.bld/dist/bld-2.0.1.jar",
|
"${HOME}/.bld/dist/bld-2.2.1.jar",
|
||||||
"lib/**/*.jar"
|
"lib/**/*.jar"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
Binary file not shown.
|
@ -1,7 +1,7 @@
|
||||||
bld.downloadExtensionJavadoc=false
|
bld.downloadExtensionJavadoc=false
|
||||||
bld.downloadExtensionSources=true
|
bld.downloadExtensionSources=true
|
||||||
bld.downloadLocation=
|
bld.downloadLocation=
|
||||||
bld.extension-checkstyle=com.uwyn.rife2:bld-checkstyle:1.0.3
|
bld.extension-checkstyle=com.uwyn.rife2:bld-checkstyle:1.0.14
|
||||||
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
||||||
bld.sourceDirectories=
|
bld.sourceDirectories=
|
||||||
bld.version=2.0.1
|
bld.version=2.2.1
|
||||||
|
|
|
@ -5,6 +5,9 @@ import rife.bld.BuildCommand;
|
||||||
import rife.bld.extension.CheckstyleOperation;
|
import rife.bld.extension.CheckstyleOperation;
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
import java.util.logging.ConsoleHandler;
|
||||||
|
import java.util.logging.Level;
|
||||||
|
import java.util.logging.Logger;
|
||||||
|
|
||||||
import static rife.bld.dependencies.Repository.MAVEN_CENTRAL;
|
import static rife.bld.dependencies.Repository.MAVEN_CENTRAL;
|
||||||
import static rife.bld.dependencies.Scope.*;
|
import static rife.bld.dependencies.Scope.*;
|
||||||
|
@ -20,19 +23,29 @@ public class ExamplesBuild extends BaseProject {
|
||||||
|
|
||||||
autoDownloadPurge = true;
|
autoDownloadPurge = true;
|
||||||
downloadSources = true;
|
downloadSources = true;
|
||||||
|
|
||||||
repositories = List.of(MAVEN_CENTRAL);
|
repositories = List.of(MAVEN_CENTRAL);
|
||||||
|
|
||||||
scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 18, 0)));
|
scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 23, 0)));
|
||||||
|
|
||||||
testOperation().mainClass("com.example.ExamplesTest");
|
testOperation().mainClass("com.example.ExamplesTest");
|
||||||
}
|
}
|
||||||
|
|
||||||
public static void main(String[] args) {
|
public static void main(String[] args) {
|
||||||
|
// Enable detailed logging for the extensions
|
||||||
|
var level = Level.ALL;
|
||||||
|
var logger = Logger.getLogger("rife.bld.extension");
|
||||||
|
var consoleHandler = new ConsoleHandler();
|
||||||
|
|
||||||
|
consoleHandler.setLevel(level);
|
||||||
|
logger.addHandler(consoleHandler);
|
||||||
|
logger.setLevel(level);
|
||||||
|
logger.setUseParentHandlers(false);
|
||||||
|
|
||||||
new ExamplesBuild().start(args);
|
new ExamplesBuild().start(args);
|
||||||
}
|
}
|
||||||
|
|
||||||
@BuildCommand(summary = "Check code style")
|
@BuildCommand(summary = "Check code style using Sun coding conventions")
|
||||||
public void checkstyle() throws Exception {
|
public void checkstyle() throws Exception {
|
||||||
new CheckstyleOperation()
|
new CheckstyleOperation()
|
||||||
.fromProject(this)
|
.fromProject(this)
|
||||||
|
@ -40,4 +53,11 @@ public class ExamplesBuild extends BaseProject {
|
||||||
.execute();
|
.execute();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@BuildCommand(value = "checkstyle-custom", summary = "Check code style using custom coding conventions")
|
||||||
|
public void checkstyleCustom() throws Exception {
|
||||||
|
new CheckstyleOperation()
|
||||||
|
.fromProject(this)
|
||||||
|
.configurationFile("src/test/resources/checkstyle.xml")
|
||||||
|
.execute();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
10
examples/src/test/resources/checkstyle.xml
Normal file
10
examples/src/test/resources/checkstyle.xml
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
<!DOCTYPE module PUBLIC
|
||||||
|
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
||||||
|
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
||||||
|
<module name="Checker">
|
||||||
|
<module name="TreeWalker">
|
||||||
|
<module name="AvoidStarImport">
|
||||||
|
<property name="severity" value="warning" />
|
||||||
|
</module>
|
||||||
|
</module>
|
||||||
|
</module>
|
Binary file not shown.
|
@ -1,8 +1,8 @@
|
||||||
bld.downloadExtensionJavadoc=false
|
bld.downloadExtensionJavadoc=false
|
||||||
bld.downloadExtensionSources=true
|
bld.downloadExtensionSources=true
|
||||||
bld.downloadLocation=
|
bld.downloadLocation=
|
||||||
bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.2
|
bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.5
|
||||||
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.4
|
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.2
|
||||||
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
||||||
bld.sourceDirectories=
|
bld.sourceDirectories=
|
||||||
bld.version=2.0.1
|
bld.version=2.2.1
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -23,6 +23,7 @@ import rife.bld.publish.PublishLicense;
|
||||||
import rife.bld.publish.PublishScm;
|
import rife.bld.publish.PublishScm;
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
import static rife.bld.dependencies.Repository.*;
|
import static rife.bld.dependencies.Repository.*;
|
||||||
import static rife.bld.dependencies.Scope.compile;
|
import static rife.bld.dependencies.Scope.compile;
|
||||||
|
@ -33,20 +34,23 @@ public class CheckstyleOperationBuild extends Project {
|
||||||
public CheckstyleOperationBuild() {
|
public CheckstyleOperationBuild() {
|
||||||
pkg = "rife.bld.extension";
|
pkg = "rife.bld.extension";
|
||||||
name = "CheckstyleOperation";
|
name = "CheckstyleOperation";
|
||||||
version = version(1, 0, 3);
|
version = version(1, 0, 15, "SNAPSHOT");
|
||||||
|
|
||||||
javaRelease = 17;
|
javaRelease = 17;
|
||||||
|
|
||||||
downloadSources = true;
|
downloadSources = true;
|
||||||
autoDownloadPurge = true;
|
autoDownloadPurge = true;
|
||||||
|
|
||||||
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS);
|
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS);
|
||||||
|
|
||||||
scope(compile)
|
scope(compile)
|
||||||
.include(dependency("com.uwyn.rife2", "bld", version(2, 0, 1)));
|
.include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1)));
|
||||||
scope(test)
|
scope(test)
|
||||||
.include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 18, 0)))
|
.include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 23, 0)))
|
||||||
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 11, 0)))
|
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1)))
|
||||||
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 11, 0)))
|
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1)))
|
||||||
.include(dependency("org.assertj", "assertj-core", version(3, 26, 3)));
|
.include(dependency("org.assertj", "assertj-core", version(3, 27, 3)));
|
||||||
|
|
||||||
javadocOperation()
|
javadocOperation()
|
||||||
.javadocOptions()
|
.javadocOptions()
|
||||||
.author()
|
.author()
|
||||||
|
@ -56,28 +60,26 @@ public class CheckstyleOperationBuild extends Project {
|
||||||
|
|
||||||
publishOperation()
|
publishOperation()
|
||||||
.repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2"))
|
.repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2"))
|
||||||
|
.repository(repository("github"))
|
||||||
.info()
|
.info()
|
||||||
.groupId("com.uwyn.rife2")
|
.groupId("com.uwyn.rife2")
|
||||||
.artifactId("bld-checkstyle")
|
.artifactId("bld-checkstyle")
|
||||||
.description("bld Checkstyle Extension")
|
.description("bld Checkstyle Extension")
|
||||||
.url("https://github.com/rife2/bld-checkstyle")
|
.url("https://github.com/rife2/bld-checkstyle")
|
||||||
.developer(
|
.developer(new PublishDeveloper()
|
||||||
new PublishDeveloper()
|
.id("ethauvin")
|
||||||
.id("ethauvin")
|
.name("Erik C. Thauvin")
|
||||||
.name("Erik C. Thauvin")
|
.email("erik@thauvin.net")
|
||||||
.email("erik@thauvin.net")
|
.url("https://erik.thauvin.net/")
|
||||||
.url("https://erik.thauvin.net/")
|
|
||||||
)
|
)
|
||||||
.license(
|
.license(new PublishLicense()
|
||||||
new PublishLicense()
|
.name("The Apache License, Version 2.0")
|
||||||
.name("The Apache License, Version 2.0")
|
.url("https://www.apache.org/licenses/LICENSE-2.0.txt")
|
||||||
.url("https://www.apache.org/licenses/LICENSE-2.0.txt")
|
|
||||||
)
|
)
|
||||||
.scm(
|
.scm(new PublishScm()
|
||||||
new PublishScm()
|
.connection("scm:git:https://github.com/rife2/bld-checkstyle.git")
|
||||||
.connection("scm:git:https://github.com/rife2/bld-checkstyle.git")
|
.developerConnection("scm:git:git@github.com:rife2/bld-checkstyle.git")
|
||||||
.developerConnection("scm:git:git@github.com:rife2/bld-checkstyle.git")
|
.url("https://github.com/rife2/bld-checkstyle")
|
||||||
.url("https://github.com/rife2/bld-checkstyle")
|
|
||||||
)
|
)
|
||||||
.signKey(property("sign.key"))
|
.signKey(property("sign.key"))
|
||||||
.signPassphrase(property("sign.passphrase"));
|
.signPassphrase(property("sign.passphrase"));
|
||||||
|
@ -98,10 +100,13 @@ public class CheckstyleOperationBuild extends Project {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void test() throws Exception {
|
public void test() throws Exception {
|
||||||
new ExecOperation()
|
var os = System.getProperty("os.name");
|
||||||
.fromProject(this)
|
if (os != null && os.toLowerCase(Locale.US).contains("linux")) {
|
||||||
.command("scripts/cliargs.sh")
|
new ExecOperation()
|
||||||
.execute();
|
.fromProject(this)
|
||||||
|
.command("scripts/cliargs.sh")
|
||||||
|
.execute();
|
||||||
|
}
|
||||||
super.test();
|
super.test();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -23,6 +23,7 @@ import rife.bld.operations.exceptions.ExitStatusException;
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.nio.file.Path;
|
||||||
import java.util.*;
|
import java.util.*;
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
import java.util.concurrent.ConcurrentHashMap;
|
||||||
import java.util.logging.Level;
|
import java.util.logging.Level;
|
||||||
|
@ -84,7 +85,19 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints all debug logging of CheckStyle utility.
|
* Specifies the location of the file that defines the configuration modules. The location can either be a
|
||||||
|
* filesystem location, or a name passed to the {@link ClassLoader#getResource(String) ClassLoader.getResource() }
|
||||||
|
* method. A configuration file is required.
|
||||||
|
*
|
||||||
|
* @param file the file
|
||||||
|
* @return the checkstyle operation
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation configurationFile(Path file) {
|
||||||
|
return configurationFile(file.toFile().getAbsolutePath());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints all debug logging of Checkstyle utility.
|
||||||
*
|
*
|
||||||
* @param isDebug {@code true} or {@code false}
|
* @param isDebug {@code true} or {@code false}
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
|
@ -99,38 +112,48 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory/file to exclude from CheckStyle. The path can be the full, absolute path, or relative to the current
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
* path. Multiple excludes are allowed.
|
* path. Multiple excludes are allowed.
|
||||||
*
|
*
|
||||||
* @param path one or more paths
|
* @param path one or more paths
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #sourceDir(Collection)
|
* @see #excludeStrings(Collection)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation exclude(String... path) {
|
public CheckstyleOperation exclude(String... path) {
|
||||||
exclude_.addAll(Arrays.stream(path).map(File::new).toList());
|
return excludeStrings(List.of(path));
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory/file to exclude from CheckStyle. The path can be the full, absolute path, or relative to the current
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
* path. Multiple excludes are allowed.
|
* path. Multiple excludes are allowed.
|
||||||
*
|
*
|
||||||
* @param path one or more paths
|
* @param path one or more paths
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #sourceDir(Collection)
|
* @see #exclude(Collection)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation exclude(File... path) {
|
public CheckstyleOperation exclude(File... path) {
|
||||||
exclude_.addAll(List.of(path));
|
return exclude(List.of(path));
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory/file to exclude from CheckStyle. The path can be the full, absolute path, or relative to the current
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
|
* path. Multiple excludes are allowed.
|
||||||
|
*
|
||||||
|
* @param path one or more paths
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #excludePaths(Collection)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation exclude(Path... path) {
|
||||||
|
return excludePaths(List.of(path));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
* path. Multiple excludes are allowed.
|
* path. Multiple excludes are allowed.
|
||||||
*
|
*
|
||||||
* @param paths the paths
|
* @param paths the paths
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #exclude(String...)
|
* @see #exclude(File...)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation exclude(Collection<File> paths) {
|
public CheckstyleOperation exclude(Collection<File> paths) {
|
||||||
exclude_.addAll(paths);
|
exclude_.addAll(paths);
|
||||||
|
@ -138,19 +161,30 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory/file pattern to exclude from CheckStyle. Multiple exclude are allowed.
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
|
* path. Multiple excludes are allowed.
|
||||||
|
*
|
||||||
|
* @param paths the paths
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #exclude(Path...)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation excludePaths(Collection<Path> paths) {
|
||||||
|
return exclude(paths.stream().map(Path::toFile).toList());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Directory/file pattern to exclude from Checkstyle. Multiple exclude are allowed.
|
||||||
*
|
*
|
||||||
* @param regex the pattern to exclude
|
* @param regex the pattern to exclude
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #excludeRegex(Collection)
|
* @see #excludeRegex(Collection)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation excludeRegex(String... regex) {
|
public CheckstyleOperation excludeRegex(String... regex) {
|
||||||
excludeRegex_.addAll(List.of(regex));
|
return excludeRegex(List.of(regex));
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory/file pattern to exclude from CheckStyle. Multiple exclude are allowed.
|
* Directory/file pattern to exclude from Checkstyle. Multiple exclude are allowed.
|
||||||
*
|
*
|
||||||
* @param regex the patterns to exclude
|
* @param regex the patterns to exclude
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
|
@ -161,6 +195,18 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Directory/file to exclude from Checkstyle. The path can be the full, absolute path, or relative to the current
|
||||||
|
* path. Multiple excludes are allowed.
|
||||||
|
*
|
||||||
|
* @param paths the paths
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #exclude(String...)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation excludeStrings(Collection<String> paths) {
|
||||||
|
return exclude(paths.stream().map(File::new).toList());
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void execute() throws IOException, InterruptedException, ExitStatusException {
|
public void execute() throws IOException, InterruptedException, ExitStatusException {
|
||||||
if (project_ == null) {
|
if (project_ == null) {
|
||||||
|
@ -189,9 +235,9 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
args.add(javaTool());
|
args.add(javaTool());
|
||||||
|
|
||||||
args.add("-cp");
|
args.add("-cp");
|
||||||
args.add(String.format("%s:%s:%s:%s", new File(project_.libTestDirectory(), "*"),
|
args.add(String.format("%s%s%s%s%s%s%s", new File(project_.libTestDirectory(), "*"),
|
||||||
new File(project_.libCompileDirectory(), "*"), project_.buildMainDirectory(),
|
File.pathSeparator, new File(project_.libCompileDirectory(), "*"), File.pathSeparator,
|
||||||
project_.buildTestDirectory()));
|
project_.buildMainDirectory(), File.pathSeparator, project_.buildTestDirectory()));
|
||||||
args.add("com.puppycrawl.tools.checkstyle.Main");
|
args.add("com.puppycrawl.tools.checkstyle.Main");
|
||||||
|
|
||||||
options_.forEach((k, v) -> {
|
options_.forEach((k, v) -> {
|
||||||
|
@ -204,7 +250,8 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
if (!exclude_.isEmpty()) {
|
if (!exclude_.isEmpty()) {
|
||||||
for (var e : exclude_) {
|
for (var e : exclude_) {
|
||||||
if (e.exists()) {
|
if (e.exists()) {
|
||||||
args.add("-e " + e.getAbsolutePath());
|
args.add("-e");
|
||||||
|
args.add(e.getAbsolutePath());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -212,7 +259,8 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
if (!excludeRegex_.isEmpty()) {
|
if (!excludeRegex_.isEmpty()) {
|
||||||
for (var e : excludeRegex_) {
|
for (var e : excludeRegex_) {
|
||||||
if (isNotBlank(e)) {
|
if (isNotBlank(e)) {
|
||||||
args.add("-x " + e);
|
args.add("-x");
|
||||||
|
args.add(e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -284,6 +332,13 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Determines if a string is not blank.
|
||||||
|
*/
|
||||||
|
private boolean isNotBlank(String s) {
|
||||||
|
return s != null && !s.isBlank();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This option is used to print the Parse Tree of the Javadoc comment. The file has to contain only Javadoc comment
|
* This option is used to print the Parse Tree of the Javadoc comment. The file has to contain only Javadoc comment
|
||||||
* content excluding '/**' and '*/' at the beginning and at the end respectively. It can only be used on a
|
* content excluding '/**' and '*/' at the beginning and at the end respectively. It can only be used on a
|
||||||
|
@ -337,6 +392,18 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
return outputPath(file.getAbsolutePath());
|
return outputPath(file.getAbsolutePath());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the output file.
|
||||||
|
* <p>
|
||||||
|
* Defaults to stdout.
|
||||||
|
*
|
||||||
|
* @param file the output file
|
||||||
|
* @return the checkstyle operation
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation outputPath(Path file) {
|
||||||
|
return outputPath(file.toFile().getAbsolutePath());
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the property files to load.
|
* Sets the property files to load.
|
||||||
*
|
*
|
||||||
|
@ -361,35 +428,54 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Specified the file(s) or folder(s) containing the source files to check.
|
* Sets the property files to load.
|
||||||
*
|
*
|
||||||
* @param dir one or more directories
|
* @param file the file
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #sourceDir(Collection)
|
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation sourceDir(String... dir) {
|
public CheckstyleOperation propertiesFile(Path file) {
|
||||||
sourceDir_.addAll(Arrays.stream(dir).map(File::new).toList());
|
return propertiesFile(file.toFile().getAbsolutePath());
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Specified the file(s) or folder(s) containing the source files to check.
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
|
*
|
||||||
|
* @param dir one or more directories
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #sourceDirStrings(Collection)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation sourceDir(String... dir) {
|
||||||
|
return sourceDirStrings(List.of(dir));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
*
|
*
|
||||||
* @param dir one or more directories
|
* @param dir one or more directories
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #sourceDir(Collection)
|
* @see #sourceDir(Collection)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation sourceDir(File... dir) {
|
public CheckstyleOperation sourceDir(File... dir) {
|
||||||
sourceDir_.addAll(List.of(dir));
|
return sourceDir(List.of(dir));
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Specified the file(s) or folder(s) containing the source files to check.
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
|
*
|
||||||
|
* @param dir one or more directories
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #sourceDirPaths(Collection)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation sourceDir(Path... dir) {
|
||||||
|
return sourceDirPaths(List.of(dir));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
*
|
*
|
||||||
* @param dirs the directories
|
* @param dirs the directories
|
||||||
* @return the checkstyle operation
|
* @return the checkstyle operation
|
||||||
* @see #sourceDir(String...)
|
* @see #sourceDir(File...)
|
||||||
*/
|
*/
|
||||||
public CheckstyleOperation sourceDir(Collection<File> dirs) {
|
public CheckstyleOperation sourceDir(Collection<File> dirs) {
|
||||||
sourceDir_.addAll(dirs);
|
sourceDir_.addAll(dirs);
|
||||||
|
@ -405,6 +491,28 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
return sourceDir_;
|
return sourceDir_;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
|
*
|
||||||
|
* @param dirs the directories
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #sourceDir(Path...)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation sourceDirPaths(Collection<Path> dirs) {
|
||||||
|
return sourceDir(dirs.stream().map(Path::toFile).toList());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the file(s) or folder(s) containing the source files to check.
|
||||||
|
*
|
||||||
|
* @param dirs the directories
|
||||||
|
* @return the checkstyle operation
|
||||||
|
* @see #sourceDir(String...)
|
||||||
|
*/
|
||||||
|
public CheckstyleOperation sourceDirStrings(Collection<String> dirs) {
|
||||||
|
return sourceDir(dirs.stream().map(File::new).toList());
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints xpath suppressions at the file's line and column position. Argument is the line and column number
|
* Prints xpath suppressions at the file's line and column position. Argument is the line and column number
|
||||||
* (separated by a {@code :} ) in the file that the suppression should be generated for. The option cannot be
|
* (separated by a {@code :} ) in the file that the suppression should be generated for. The option cannot be
|
||||||
|
@ -485,11 +593,4 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
|
||||||
}
|
}
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
|
||||||
* Determines if a string is not blank.
|
|
||||||
*/
|
|
||||||
private boolean isNotBlank(String s) {
|
|
||||||
return s != null && !s.isBlank();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -17,7 +17,7 @@
|
||||||
package rife.bld.extension.checkstyle;
|
package rife.bld.extension.checkstyle;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The Checkstyle output format for XML, sarif and default (plaib) logger.
|
* The Checkstyle output format for XML, sarif and default (plain) logger.
|
||||||
*/
|
*/
|
||||||
public enum OutputFormat {
|
public enum OutputFormat {
|
||||||
XML("xml"),
|
XML("xml"),
|
||||||
|
@ -26,6 +26,9 @@ public enum OutputFormat {
|
||||||
|
|
||||||
public final String label;
|
public final String label;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the label of this output format.
|
||||||
|
*/
|
||||||
OutputFormat(String label) {
|
OutputFormat(String label) {
|
||||||
this.label = label;
|
this.label = label;
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -16,8 +16,11 @@
|
||||||
|
|
||||||
package rife.bld.extension;
|
package rife.bld.extension;
|
||||||
|
|
||||||
|
import org.assertj.core.api.AutoCloseableSoftAssertions;
|
||||||
import org.junit.jupiter.api.BeforeAll;
|
import org.junit.jupiter.api.BeforeAll;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.junit.jupiter.api.condition.EnabledOnOs;
|
||||||
|
import org.junit.jupiter.api.condition.OS;
|
||||||
import rife.bld.BaseProject;
|
import rife.bld.BaseProject;
|
||||||
import rife.bld.Project;
|
import rife.bld.Project;
|
||||||
import rife.bld.WebProject;
|
import rife.bld.WebProject;
|
||||||
|
@ -27,6 +30,7 @@ import rife.bld.operations.exceptions.ExitStatusException;
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.nio.file.Files;
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
import java.nio.file.Paths;
|
import java.nio.file.Paths;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.logging.ConsoleHandler;
|
import java.util.logging.ConsoleHandler;
|
||||||
|
@ -36,7 +40,6 @@ import java.util.logging.Logger;
|
||||||
import static org.assertj.core.api.Assertions.assertThat;
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
import static org.assertj.core.api.Assertions.assertThatCode;
|
import static org.assertj.core.api.Assertions.assertThatCode;
|
||||||
|
|
||||||
|
|
||||||
class CheckstyleOperationTest {
|
class CheckstyleOperationTest {
|
||||||
public static final String SRC_MAIN_JAVA = "src/main/java";
|
public static final String SRC_MAIN_JAVA = "src/main/java";
|
||||||
public static final String SRC_TEST_JAVA = "src/test/java";
|
public static final String SRC_TEST_JAVA = "src/test/java";
|
||||||
|
@ -64,6 +67,7 @@ class CheckstyleOperationTest {
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@EnabledOnOs(OS.LINUX)
|
||||||
void checkAllParameters() throws IOException {
|
void checkAllParameters() throws IOException {
|
||||||
var args = Files.readAllLines(Paths.get("src", "test", "resources", "checkstyle-args.txt"));
|
var args = Files.readAllLines(Paths.get("src", "test", "resources", "checkstyle-args.txt"));
|
||||||
|
|
||||||
|
@ -89,15 +93,17 @@ class CheckstyleOperationTest {
|
||||||
.treeWithJavadoc(true)
|
.treeWithJavadoc(true)
|
||||||
.executeConstructProcessCommandList();
|
.executeConstructProcessCommandList();
|
||||||
|
|
||||||
for (var p : args) {
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
var found = false;
|
for (var p : args) {
|
||||||
for (var a : params) {
|
var found = false;
|
||||||
if (a.startsWith(p)) {
|
for (var a : params) {
|
||||||
found = true;
|
if (a.startsWith(p)) {
|
||||||
break;
|
found = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
softly.assertThat(found).as(p + " not found.").isTrue();
|
||||||
}
|
}
|
||||||
assertThat(found).as(p + " not found.").isTrue();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -119,17 +125,30 @@ class CheckstyleOperationTest {
|
||||||
void exclude() {
|
void exclude() {
|
||||||
var foo = new File(SRC_MAIN_JAVA);
|
var foo = new File(SRC_MAIN_JAVA);
|
||||||
var bar = new File(SRC_TEST_JAVA);
|
var bar = new File(SRC_TEST_JAVA);
|
||||||
var op = new CheckstyleOperation().fromProject(new Project()).exclude(SRC_MAIN_JAVA, SRC_TEST_JAVA);
|
|
||||||
var e = "-e ";
|
var e = "-e ";
|
||||||
assertThat(op.executeConstructProcessCommandList()).as("strings")
|
|
||||||
|
var op = new CheckstyleOperation().fromProject(new Project()).exclude(SRC_MAIN_JAVA, SRC_TEST_JAVA);
|
||||||
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("String...")
|
||||||
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
|
|
||||||
|
op = new CheckstyleOperation().fromProject(new Project()).excludeStrings(List.of(SRC_MAIN_JAVA, SRC_TEST_JAVA));
|
||||||
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("List(String...)")
|
||||||
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
|
|
||||||
op = new CheckstyleOperation().fromProject(new Project()).exclude(foo, bar);
|
op = new CheckstyleOperation().fromProject(new Project()).exclude(foo, bar);
|
||||||
assertThat(op.executeConstructProcessCommandList()).as("files")
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("File...")
|
||||||
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
|
|
||||||
op = new CheckstyleOperation().fromProject(new Project()).exclude(List.of(foo, bar));
|
op = new CheckstyleOperation().fromProject(new Project()).exclude(List.of(foo, bar));
|
||||||
assertThat(op.executeConstructProcessCommandList()).as("list")
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("List(File...)")
|
||||||
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
|
|
||||||
|
op = new CheckstyleOperation().fromProject(new Project()).exclude(foo.toPath(), bar.toPath());
|
||||||
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("Path...")
|
||||||
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
|
|
||||||
|
op = new CheckstyleOperation().fromProject(new Project()).excludePaths(List.of(foo.toPath(), bar.toPath()));
|
||||||
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("List(Path...)")
|
||||||
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
.contains(e + foo.getAbsolutePath()).contains(e + bar.getAbsolutePath());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -137,10 +156,10 @@ class CheckstyleOperationTest {
|
||||||
void excludeRegex() {
|
void excludeRegex() {
|
||||||
var op = new CheckstyleOperation().fromProject(new Project()).excludeRegex(FOO, BAR);
|
var op = new CheckstyleOperation().fromProject(new Project()).excludeRegex(FOO, BAR);
|
||||||
var x = "-x ";
|
var x = "-x ";
|
||||||
assertThat(op.executeConstructProcessCommandList()).contains(x + FOO, x + BAR);
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).contains(x + FOO, x + BAR);
|
||||||
|
|
||||||
op = new CheckstyleOperation().fromProject(new Project()).excludeRegex(List.of(FOO, BAR));
|
op = new CheckstyleOperation().fromProject(new Project()).excludeRegex(List.of(FOO, BAR));
|
||||||
assertThat(op.executeConstructProcessCommandList()).as("as list").contains(x + FOO, x + BAR);
|
assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("as list").contains(x + FOO, x + BAR);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@ -150,8 +169,8 @@ class CheckstyleOperationTest {
|
||||||
var op = new CheckstyleOperation()
|
var op = new CheckstyleOperation()
|
||||||
.fromProject(new WebProject())
|
.fromProject(new WebProject())
|
||||||
.sourceDir(SRC_MAIN_JAVA, SRC_TEST_JAVA)
|
.sourceDir(SRC_MAIN_JAVA, SRC_TEST_JAVA)
|
||||||
.configurationFile("src/test/resources/google_checks.xml")
|
.configurationFile(Path.of("src/test/resources/google_checks.xml"))
|
||||||
.outputPath(tmpFile.getAbsolutePath());
|
.outputPath(tmpFile.toPath());
|
||||||
op.execute();
|
op.execute();
|
||||||
assertThat(tmpFile).exists();
|
assertThat(tmpFile).exists();
|
||||||
}
|
}
|
||||||
|
@ -236,6 +255,10 @@ class CheckstyleOperationTest {
|
||||||
void propertiesFile() {
|
void propertiesFile() {
|
||||||
var op = new CheckstyleOperation().fromProject(new Project()).propertiesFile(FOO);
|
var op = new CheckstyleOperation().fromProject(new Project()).propertiesFile(FOO);
|
||||||
assertThat(op.options().get("-p")).isEqualTo(FOO);
|
assertThat(op.options().get("-p")).isEqualTo(FOO);
|
||||||
|
|
||||||
|
var fooPath = Path.of(FOO);
|
||||||
|
op = op.propertiesFile(fooPath);
|
||||||
|
assertThat(op.options().get("-p")).isEqualTo(fooPath.toFile().getAbsolutePath());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@ -243,18 +266,32 @@ class CheckstyleOperationTest {
|
||||||
var foo = new File(FOO);
|
var foo = new File(FOO);
|
||||||
var bar = new File(BAR);
|
var bar = new File(BAR);
|
||||||
|
|
||||||
var op = new CheckstyleOperation().fromProject(new Project()).sourceDir(FOO);
|
var op = new CheckstyleOperation().fromProject(new Project()).sourceDir(FOO, BAR);
|
||||||
assertThat(op.sourceDir()).contains(foo);
|
assertThat(op.sourceDir()).as("String...").hasSize(2).contains(foo, bar);
|
||||||
|
op.sourceDir().clear();
|
||||||
|
|
||||||
|
op = op.sourceDirStrings(List.of(FOO, BAR));
|
||||||
|
assertThat(op.sourceDir()).as("List(String...)").hasSize(2).contains(foo, bar);
|
||||||
|
op.sourceDir().clear();
|
||||||
|
|
||||||
op = op.sourceDir(foo, bar);
|
op = op.sourceDir(foo, bar);
|
||||||
assertThat(op.sourceDir()).as("foo, bar").hasSize(2)
|
assertThat(op.sourceDir()).as("File...").hasSize(2).contains(foo, bar);
|
||||||
.contains(foo).contains(bar);
|
op.sourceDir().clear();
|
||||||
|
|
||||||
op = op.sourceDir(List.of(foo, bar));
|
op = op.sourceDir(List.of(foo, bar));
|
||||||
assertThat(op.sourceDir()).as("List.of(foo, bar)").hasSize(2)
|
assertThat(op.sourceDir()).as("List(File...)").hasSize(2).contains(foo, bar);
|
||||||
.contains(foo).contains(bar);
|
op.sourceDir().clear();
|
||||||
|
|
||||||
|
op = op.sourceDir(foo.toPath(), bar.toPath());
|
||||||
|
assertThat(op.sourceDir()).as("Path...").hasSize(2).contains(foo, bar);
|
||||||
|
op.sourceDir().clear();
|
||||||
|
|
||||||
|
op = op.sourceDirPaths(List.of(foo.toPath(), bar.toPath()));
|
||||||
|
assertThat(op.sourceDir()).as("List(Path...)").hasSize(2).contains(foo, bar);
|
||||||
|
op.sourceDir().clear();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void suppressionLineColumnNumber() {
|
void suppressionLineColumnNumber() {
|
||||||
var op = new CheckstyleOperation().fromProject(new Project()).suppressionLineColumnNumber(FOO + ':' + BAR);
|
var op = new CheckstyleOperation().fromProject(new Project()).suppressionLineColumnNumber(FOO + ':' + BAR);
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue