commit 8a07516e3780b2ca84647e04c82c693a52c10982 Author: Erik C. Thauvin Date: Mon Aug 28 00:55:08 2023 -0700 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f301bde --- /dev/null +++ b/.gitignore @@ -0,0 +1,58 @@ +.gradle +.DS_Store +build +lib/bld/** +!lib/bld/bld-wrapper.jar +!lib/bld/bld-wrapper.properties +lib/compile/ +lib/runtime/ +lib/standalone/ +lib/test/ + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests + +# Local Properties +local.properties \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/app.iml b/.idea/app.iml new file mode 100644 index 0000000..787b59b --- /dev/null +++ b/.idea/app.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/bld.iml b/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/copyright/Apache_License.xml b/.idea/copyright/Apache_License.xml new file mode 100644 index 0000000..15687f4 --- /dev/null +++ b/.idea/copyright/Apache_License.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml new file mode 100644 index 0000000..f2907f1 --- /dev/null +++ b/.idea/copyright/profiles_settings.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..1e01b48 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,8 @@ + + + + \ No newline at end of file diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml new file mode 100644 index 0000000..722b42e --- /dev/null +++ b/.idea/libraries/bld.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/compile.xml b/.idea/libraries/compile.xml new file mode 100644 index 0000000..9bd86aa --- /dev/null +++ b/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/runtime.xml b/.idea/libraries/runtime.xml new file mode 100644 index 0000000..2ae5c4b --- /dev/null +++ b/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/test.xml b/.idea/libraries/test.xml new file mode 100644 index 0000000..b80486a --- /dev/null +++ b/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..af10cee --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..55adcb9 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/runConfigurations/Run Tests.xml b/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..fffe37c --- /dev/null +++ b/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..3d4eb53 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Run Tests", + "request": "launch", + "mainClass": "rife.bld.extension.CheckstyleOperationTest" + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..c4bc81e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "java.project.sourcePaths": [ + "src/main/java", + "src/main/resources", + "src/test/java", + "src/bld/java" + ], + "java.configuration.updateBuildConfiguration": "automatic", + "java.project.referencedLibraries": [ + "${HOME}/.bld/dist/bld-1.7.2.jar", + "lib/compile/*.jar", + "lib/runtime/*.jar", + "lib/test/*.jar" + ] +} diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..49cc83d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md new file mode 100755 index 0000000..b8a7d0b --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# [bld](https://rife2.com/bldb) [Checkstyle](https://checkstyle.sourceforge.io/) Extension + +[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) +[![bld](https://img.shields.io/badge/1.7.2-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) +[![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-checkstyle/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-checkstyle) +[![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-checkstyle/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-checkstyle) +[![GitHub CI](https://github.com/rife2/bld-checkstyle/actions/workflows/bld.yml/badge.svg)](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). + +**TBD** \ No newline at end of file diff --git a/bld b/bld new file mode 100755 index 0000000..90ce8fa --- /dev/null +++ b/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build rife.bld.extension.CheckstyleOperationBuild "$@" \ No newline at end of file diff --git a/bld.bat b/bld.bat new file mode 100644 index 0000000..3458c39 --- /dev/null +++ b/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build rife.bld.extension.CheckstyleOperationBuild %* \ No newline at end of file diff --git a/config/pmd.xml b/config/pmd.xml new file mode 100644 index 0000000..c60ff7e --- /dev/null +++ b/config/pmd.xml @@ -0,0 +1,109 @@ + + + Erik's Ruleset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.gitignore b/examples/.gitignore new file mode 100644 index 0000000..a2805aa --- /dev/null +++ b/examples/.gitignore @@ -0,0 +1,55 @@ +.gradle +.DS_Store +build +lib/bld/** +!lib/bld/bld-wrapper.jar +!lib/bld/bld-wrapper.properties +lib/compile/ +lib/runtime/ +lib/standalone/ +lib/test/ + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests \ No newline at end of file diff --git a/examples/.idea/app.iml b/examples/.idea/app.iml new file mode 100644 index 0000000..787b59b --- /dev/null +++ b/examples/.idea/app.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/bld.iml b/examples/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/examples/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/bld.xml b/examples/.idea/libraries/bld.xml new file mode 100644 index 0000000..722b42e --- /dev/null +++ b/examples/.idea/libraries/bld.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/compile.xml b/examples/.idea/libraries/compile.xml new file mode 100644 index 0000000..9bd86aa --- /dev/null +++ b/examples/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/runtime.xml b/examples/.idea/libraries/runtime.xml new file mode 100644 index 0000000..2ae5c4b --- /dev/null +++ b/examples/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/test.xml b/examples/.idea/libraries/test.xml new file mode 100644 index 0000000..b80486a --- /dev/null +++ b/examples/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/misc.xml b/examples/.idea/misc.xml new file mode 100644 index 0000000..11f86d2 --- /dev/null +++ b/examples/.idea/misc.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/examples/.idea/modules.xml b/examples/.idea/modules.xml new file mode 100644 index 0000000..55adcb9 --- /dev/null +++ b/examples/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/runConfigurations/Run Main.xml b/examples/.idea/runConfigurations/Run Main.xml new file mode 100644 index 0000000..6c2648a --- /dev/null +++ b/examples/.idea/runConfigurations/Run Main.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/examples/.idea/runConfigurations/Run Tests.xml b/examples/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..c2657f9 --- /dev/null +++ b/examples/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/examples/.vscode/launch.json b/examples/.vscode/launch.json new file mode 100644 index 0000000..faaad8b --- /dev/null +++ b/examples/.vscode/launch.json @@ -0,0 +1,17 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Run Main", + "request": "launch", + "mainClass": "com.example.ExamplesMain" + }, + { + "type": "java", + "name": "Run Tests", + "request": "launch", + "mainClass": "com.example.ExamplesTest" + } + ] +} diff --git a/examples/.vscode/settings.json b/examples/.vscode/settings.json new file mode 100644 index 0000000..c4bc81e --- /dev/null +++ b/examples/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "java.project.sourcePaths": [ + "src/main/java", + "src/main/resources", + "src/test/java", + "src/bld/java" + ], + "java.configuration.updateBuildConfiguration": "automatic", + "java.project.referencedLibraries": [ + "${HOME}/.bld/dist/bld-1.7.2.jar", + "lib/compile/*.jar", + "lib/runtime/*.jar", + "lib/test/*.jar" + ] +} diff --git a/examples/bld b/examples/bld new file mode 100755 index 0000000..762c8a2 --- /dev/null +++ b/examples/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build com.example.ExamplesBuild "$@" \ No newline at end of file diff --git a/examples/bld.bat b/examples/bld.bat new file mode 100644 index 0000000..e2dec1b --- /dev/null +++ b/examples/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build com.example.ExamplesBuild %* \ No newline at end of file diff --git a/examples/lib/bld/bld-wrapper.jar b/examples/lib/bld/bld-wrapper.jar new file mode 100644 index 0000000..7e43d78 Binary files /dev/null and b/examples/lib/bld/bld-wrapper.jar differ diff --git a/examples/lib/bld/bld-wrapper.properties b/examples/lib/bld/bld-wrapper.properties new file mode 100644 index 0000000..04b8dcd --- /dev/null +++ b/examples/lib/bld/bld-wrapper.properties @@ -0,0 +1,7 @@ +bld.downloadExtensionJavadoc=false +bld.downloadExtensionSources=true +bld.extensions=com.uwyn.rife2:bld-checkstyle:0.9.0-SNAPSHOT +bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_RELEASES +bld.downloadLocation= +bld.sourceDirectories= +bld.version=1.7.2 diff --git a/examples/src/bld/java/com/example/ExamplesBuild.java b/examples/src/bld/java/com/example/ExamplesBuild.java new file mode 100644 index 0000000..9ce6fc8 --- /dev/null +++ b/examples/src/bld/java/com/example/ExamplesBuild.java @@ -0,0 +1,39 @@ +package com.example; + +import rife.bld.BaseProject; +import rife.bld.BuildCommand; +import rife.bld.extension.CheckstyleOperation; + +import java.util.List; + +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Scope.*; + +public class ExamplesBuild extends BaseProject { + public ExamplesBuild() { + pkg = "com.example"; + name = "Examples"; + mainClass = "com.example.ExamplesMain"; + version = version(0, 1, 0); + + downloadSources = true; + repositories = List.of(MAVEN_CENTRAL); + + scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 12, 2))); + + testOperation().mainClass("com.example.ExamplesTest"); + } + + public static void main(String[] args) { + new ExamplesBuild().start(args); + } + + @BuildCommand(summary = "Check code style") + public void checkstyle() throws Exception { + new CheckstyleOperation() + .fromProject(this) + .configurationFile("src/test/resources/sun_checks.xml") + .execute(); + } + +} \ No newline at end of file diff --git a/examples/src/main/java/com/example/ExamplesMain.java b/examples/src/main/java/com/example/ExamplesMain.java new file mode 100644 index 0000000..1c6a403 --- /dev/null +++ b/examples/src/main/java/com/example/ExamplesMain.java @@ -0,0 +1,11 @@ +package com.example; + +public class ExamplesMain { + public String getMessage() { + return "Hello World!"; + } + + public static void main(String[] args) { + System.out.println(new ExamplesMain().getMessage()); + } +} \ No newline at end of file diff --git a/examples/src/test/java/com/example/ExamplesTest.java b/examples/src/test/java/com/example/ExamplesTest.java new file mode 100644 index 0000000..650551e --- /dev/null +++ b/examples/src/test/java/com/example/ExamplesTest.java @@ -0,0 +1,15 @@ +package com.example; + +public class ExamplesTest { + void verifyHello() { + if (!"Hello World!".equals(new ExamplesMain().getMessage())) { + throw new AssertionError(); + } else { + System.out.println("Succeeded"); + } + } + + public static void main(String[] args) { + new ExamplesTest().verifyHello(); + } +} \ No newline at end of file diff --git a/examples/src/test/resources/sun_checks.xml b/examples/src/test/resources/sun_checks.xml new file mode 100644 index 0000000..1278ab7 --- /dev/null +++ b/examples/src/test/resources/sun_checks.xml @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar new file mode 100644 index 0000000..b390afd Binary files /dev/null and b/lib/bld/bld-wrapper.jar differ diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties new file mode 100644 index 0000000..6a39ad1 --- /dev/null +++ b/lib/bld/bld-wrapper.properties @@ -0,0 +1,8 @@ +bld.downloadExtensionJavadoc=false +bld.downloadExtensionSources=true +bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.2 +bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.0 +bld.repositories=MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +bld.downloadLocation= +bld.sourceDirectories= +bld.version=1.7.2 diff --git a/src/bld/java/rife/bld/extension/CheckstyleOperationBuild.java b/src/bld/java/rife/bld/extension/CheckstyleOperationBuild.java new file mode 100644 index 0000000..01aa77a --- /dev/null +++ b/src/bld/java/rife/bld/extension/CheckstyleOperationBuild.java @@ -0,0 +1,95 @@ +/* + * Copyright 2023 the original author or authors. + * + * 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. + */ + +package rife.bld.extension; + +import rife.bld.BuildCommand; +import rife.bld.Project; +import rife.bld.publish.PublishDeveloper; +import rife.bld.publish.PublishLicense; +import rife.bld.publish.PublishScm; + +import java.io.IOException; +import java.util.List; + +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Repository.RIFE2_RELEASES; +import static rife.bld.dependencies.Scope.*; +import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; + +public class CheckstyleOperationBuild extends Project { + public CheckstyleOperationBuild() { + pkg = "rife.bld.extension"; + name = "CheckstyleOperation"; + version = version(0, 9, 0, "SNAPSHOT"); + + javaRelease = 17; + downloadSources = true; + autoDownloadPurge = true; + repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + scope(compile) + .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 2))); + scope(test) + .include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 12, 2))) + .include(dependency("org.jsoup", "jsoup", version(1, 16, 1))) + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0))) + .include(dependency("org.assertj:assertj-joda-time:2.2.0")); + javadocOperation() + .javadocOptions() + .docLint(NO_MISSING) + .link("https://rife2.github.io/bld/") + .link("https://rife2.github.io/rife2/"); + + publishOperation() + .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) + .info() + .groupId("com.uwyn.rife2") + .artifactId("bld-checkstyle") + .description("bld Checkstyle Extensions") + .url("https://github.com/rife2/bld-checkstyle") + .developer(new PublishDeveloper().id("ethauvin").name("Erik C. Thauvin").email("erik@thauvin.net") + .url("https://erik.thauvin.net/")) + .license(new PublishLicense().name("The Apache License, Version 2.0") + .url("http://www.apache.org/licenses/LICENSE-2.0.txt")) + .scm(new PublishScm().connection("scm:git:https://github.com/rife2/bld-checkstyle.git") + .developerConnection("scm:git:git@github.com:rife2/bld-checkstyle.git") + .url("https://github.com/rife2/bld-checkstyle")) + .signKey(property("sign.key")) + .signPassphrase(property("sign.passphrase")); + } + + public static void main(String[] args) { + new CheckstyleOperationBuild().start(args); + } + + @BuildCommand(summary = "Generates JaCoCo Reports") + public void jacoco() throws IOException { + new JacocoReportOperation() + .fromProject(this) + .execute(); + } + + @BuildCommand(summary = "Runs PMD analysis") + public void pmd() { + new PmdOperation() + .fromProject(this) + .failOnViolation(true) + .ruleSets("config/pmd.xml") + .execute(); + } +} \ No newline at end of file diff --git a/src/main/java/rife/bld/extension/CheckstyleOperation.java b/src/main/java/rife/bld/extension/CheckstyleOperation.java new file mode 100644 index 0000000..b36c7bb --- /dev/null +++ b/src/main/java/rife/bld/extension/CheckstyleOperation.java @@ -0,0 +1,277 @@ +/* + * Copyright 2023 the original author or authors. + * + * 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. + */ + +package rife.bld.extension; + +import rife.bld.BaseProject; +import rife.bld.operations.AbstractProcessOperation; + +import java.nio.file.Path; +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.logging.Logger; + +/** + * Static code analysis using Checkstyle. + * + * @author Erik C. Thauvin + * @since 1.0 + */ +public class CheckstyleOperation extends AbstractProcessOperation { + private static final Logger LOGGER = Logger.getLogger(CheckstyleOperation.class.getName()); + /** + * The command line options. + */ + protected final List options = new ArrayList<>(); + /** + * The command line options with arguments. + */ + protected final Map optionsWithArg = new ConcurrentHashMap<>(); + /** + * The source files(s) or folder(s). + */ + protected final Set sourceDirs = new TreeSet<>(); + private BaseProject project_; + + /** + * Shows Abstract Syntax Tree(AST) branches that match given XPath query. + */ + public CheckstyleOperation branchMatchingXpath(String xPathQuery) { + optionsWithArg.put("-b", xPathQuery); + return this; + } + + /** + * 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. + */ + public CheckstyleOperation configurationFile(String file) { + optionsWithArg.put("-c", file); + return this; + } + + /** + * Prints all debug logging of CheckStyle utility. + */ + public CheckstyleOperation debug(boolean isDebug) { + if (isDebug) { + options.add("-d"); + } else { + options.remove("-d"); + } + 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. + */ + public CheckstyleOperation exclude(String... path) { + for (var p : path) { + optionsWithArg.put("-e", p); + } + return this; + } + + /** + * Directory/file pattern to exclude from CheckStyle. Multiple excludes are allowed. + */ + public CheckstyleOperation excludedPathPattern(String pattern) { + optionsWithArg.put("-x", pattern); + return this; + } + + /** + * Part of the {@link #execute} operation, constructs the command list + * to use for building the process. + * + * @since 1.5 + */ + @Override + protected List executeConstructProcessCommandList() { + if (project_ == null) { + LOGGER.severe("A project must be specified."); + } else if (sourceDirs.isEmpty()) { + sourceDirs.add(project_.srcMainJavaDirectory().getPath()); + sourceDirs.add(project_.srcTestJavaDirectory().getPath()); + } + + final List args = new ArrayList<>(); + args.add(javaTool()); + args.add("-cp"); + args.add(String.format("%s:%s:%s:%s", Path.of(project_.libTestDirectory().getPath(), "*"), + Path.of(project_.libCompileDirectory().getPath(), "*"), project_.buildMainDirectory(), + project_.buildTestDirectory())); + args.add("com.puppycrawl.tools.checkstyle.Main"); + args.addAll(options); + optionsWithArg.forEach((k, v) -> { + args.add(k); + args.add(v); + }); + + args.addAll(sourceDirs); + + return args; + } + + /** + * Configures the {@link BaseProject}. + */ + @Override + public CheckstyleOperation fromProject(BaseProject project) { + project_ = project; + return this; + } + + /** + * Allows ignored modules to be run. + */ + public CheckstyleOperation executeIgnoredModules(boolean isAllowIgnoreModules) { + if (isAllowIgnoreModules) { + options.add("-E"); + } else { + options.remove("-E"); + } + return this; + } + + /** + * Specifies the output format. Valid values: {@code xml}, {@code sarif}, {@code plain} for the XML, sarif and + * default logger respectively. Defaults to {@code plain}. + */ + public CheckstyleOperation format(String format) { + optionsWithArg.put("-f", format); + return this; + } + + /** + * Generates to output a suppression xml to use to suppress all violations from user's config. Instead of printing + * every violation, all violations will be caught and single suppressions xml file will be printed out. + * Used only with the {@link #configurationFile(String) configurationFile} option. Output location can be specified + * with the {@link #output(String) output} option. + */ + public CheckstyleOperation generateXpathSuppression(boolean xPathSuppression) { + if (xPathSuppression) { + options.add("-g"); + } else { + options.remove("-g"); + } + return this; + } + + /** + * Prints Parse Tree of the Javadoc comment. The file have to contain only Javadoc comment content + * without including '/**' and '*/' at the beginning and at the end respectively. The option cannot + * be used other options and requires exactly one file to run on to be specified. + */ + public CheckstyleOperation javadocTree(boolean isTree) { + if (isTree) { + options.add("-j"); + } else { + options.remove("-j"); + } + return this; + } + + /** + * 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 + * used with other options and requires exactly one file to run on to be specified. + *

+ * ATTENTION: generated result will have few queries, joined by pipe(|). Together they will match all AST nodes + * on specified line and column. You need to choose only one and recheck that it works. Usage of all of them is also + * ok, but might result in undesirable matching and suppress other issues. + */ + public CheckstyleOperation lineColumn(String lineColumn) { + optionsWithArg.put("-s", lineColumn); + return this; + } + + /** + * Sets the output file. Defaults to stdout. + */ + public CheckstyleOperation output(String file) { + optionsWithArg.put("-o", file); + return this; + } + + /** + * Sets the property files to load. + */ + public CheckstyleOperation propertiesFile(String file) { + optionsWithArg.put("-p", file); + return this; + } + + /** + * Specified the file(s) or folder(s) containing the source files to check. + */ + public CheckstyleOperation sourceDir(String... dir) { + sourceDirs.addAll(Arrays.asList(dir)); + return this; + } + + /** + * Sets the length of the tab character. Used only with the {@link #lineColumn(String) lineColum} option. + * Default value is {@code 8}. + */ + public CheckstyleOperation tabWith(int length) { + optionsWithArg.put("-w", String.valueOf(length)); + return this; + } + + /** + * Prints Abstract Syntax Tree(AST) of the checked file. The option cannot be used other options and requires + * exactly one file to run on to be specified. + */ + public CheckstyleOperation tree(boolean isTree) { + if (isTree) { + options.add("-t"); + } else { + options.remove("-t"); + } + return this; + } + + /** + * Prints Abstract Syntax Tree(AST) with comment nodes of the checked file. The option cannot be used with other + * options and requires exactly one file to run on to be specified. + */ + public CheckstyleOperation treeWithComments(boolean isTree) { + if (isTree) { + options.add("-T"); + } else { + options.remove("-T"); + } + return this; + } + + /** + * Prints Abstract Syntax Tree(AST) with Javadoc nodes and comment nodes of the checked file. Attention that line + * number and columns will not be the same as it is a file due to the fact that each javadoc comment is parsed + * separately from java file. The option cannot be used with other options and requires exactly one file to run on + * to be specified. + */ + public CheckstyleOperation treeWithJavadoc(boolean isTree) { + if (isTree) { + options.add("-J"); + } else { + options.remove("-J"); + } + return this; + } +} \ No newline at end of file diff --git a/src/test/java/rife/bld/extension/CheckstyleOperationTest.java b/src/test/java/rife/bld/extension/CheckstyleOperationTest.java new file mode 100644 index 0000000..650dc1f --- /dev/null +++ b/src/test/java/rife/bld/extension/CheckstyleOperationTest.java @@ -0,0 +1,185 @@ +/* + * Copyright 2023 the original author or authors. + * + * 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. + */ + +package rife.bld.extension; + +import org.junit.jupiter.api.Test; +import rife.bld.BaseProject; +import rife.bld.Project; +import rife.bld.WebProject; +import rife.bld.operations.exceptions.ExitStatusException; + +import java.io.File; +import java.io.IOException; + +import static org.assertj.core.api.Assertions.assertThat; + + +class CheckstyleOperationTest { + private static final String BAR = "bar"; + private static final String FOO = "foo"; + + @Test + void branchMatchingXpath() { + var op = new CheckstyleOperation().fromProject(new Project()).branchMatchingXpath(FOO); + assertThat(op.optionsWithArg.get("-b")).isEqualTo(FOO); + } + + @Test + void configurationFile() { + var op = new CheckstyleOperation().fromProject(new Project()).configurationFile(FOO); + assertThat(op.optionsWithArg.get("-c")).isEqualTo(FOO); + } + + @Test + void debug() { + var op = new CheckstyleOperation().fromProject(new Project()).debug(true); + assertThat(op.options.contains("-d")).as("add").isTrue(); + op = op.debug(false); + assertThat(op.options.contains("-d")).as("remove").isFalse(); + } + + @Test + void exclude() { + var op = new CheckstyleOperation().fromProject(new Project()).exclude(FOO); + assertThat(op.optionsWithArg.get("-e")).isEqualTo(FOO); + } + + @Test + void excludedPathPattern() { + var op = new CheckstyleOperation().fromProject(new Project()).excludedPathPattern(FOO); + assertThat(op.optionsWithArg.get("-x")).isEqualTo(FOO); + } + + @Test + void execute() throws IOException, ExitStatusException, InterruptedException { + var tmpFile = File.createTempFile("checkstyle", ".txt"); + tmpFile.deleteOnExit(); + var op = new CheckstyleOperation() + .fromProject(new WebProject()) + .sourceDir("src/main/java", "src/test/java") + .configurationFile("src/test/resources/google_checks.xml") + .output(tmpFile.getAbsolutePath()); + op.execute(); + assertThat(tmpFile).exists(); + } + + @Test + void executeConstructProcessCommandList() { + var op = new CheckstyleOperation().fromProject(new BaseProject()) + .configurationFile("config/checkstyle.xml") + .branchMatchingXpath("xpath") + .propertiesFile("config/checkstyle.properties") + .debug(true) + .executeIgnoredModules(true) + .sourceDir("src/main/java", "src/test/java"); + assertThat(String.join(" ", op.executeConstructProcessCommandList())) + .startsWith("java -cp ") + .endsWith( + "com.puppycrawl.tools.checkstyle.Main " + + "-d -E " + + "-p config/checkstyle.properties " + + "-b xpath " + + "-c config/checkstyle.xml " + + "src/main/java src/test/java"); + } + + @Test + void executeIgnoredModules() { + var op = new CheckstyleOperation().fromProject(new Project()).executeIgnoredModules(true); + assertThat(op.options.contains("-E")).as("add").isTrue(); + op = op.executeIgnoredModules(false); + assertThat(op.options.contains("-E")).as("remove").isFalse(); + } + + @Test + void format() { + var op = new CheckstyleOperation().fromProject(new Project()).format(FOO); + assertThat(op.optionsWithArg.get("-f")).isEqualTo(FOO); + } + + @Test + void generateXpathSuppression() { + var op = new CheckstyleOperation().fromProject(new Project()).generateXpathSuppression(true); + assertThat(op.options.contains("-g")).as("add").isTrue(); + op = op.generateXpathSuppression(false); + assertThat(op.options.contains("-g")).as("remove").isFalse(); + } + + @Test + void javadocTree() { + var op = new CheckstyleOperation().fromProject(new Project()).javadocTree(true); + assertThat(op.options.contains("-j")).as("add").isTrue(); + op = op.javadocTree(false); + assertThat(op.options.contains("-j")).as("remove").isFalse(); + } + + @Test + void lineColumn() { + var op = new CheckstyleOperation().fromProject(new Project()).lineColumn(FOO); + assertThat(op.optionsWithArg.get("-s")).isEqualTo(FOO); + } + + @Test + void output() { + var op = new CheckstyleOperation().fromProject(new Project()).output(FOO); + assertThat(op.optionsWithArg.get("-o")).isEqualTo(FOO); + } + + @Test + void propertiesFile() { + var op = new CheckstyleOperation().fromProject(new Project()).propertiesFile(FOO); + assertThat(op.optionsWithArg.get("-p")).isEqualTo(FOO); + } + + @Test + void sourceDir() { + var op = new CheckstyleOperation().fromProject(new Project()).sourceDir(FOO); + assertThat(op.sourceDirs).contains(FOO); + op = op.sourceDir(FOO, BAR); + assertThat(op.sourceDirs).as("foo, bar").hasSize(2).contains(FOO).contains(BAR); + } + + @Test + void tabWith() { + var op = new CheckstyleOperation().fromProject(new Project()).tabWith(9); + assertThat(op.optionsWithArg.get("-w")).isEqualTo("9"); + } + + @Test + void tree() { + var op = new CheckstyleOperation().fromProject(new Project()).tree(true); + assertThat(op.options.contains("-t")).as("add").isTrue(); + op = op.tree(false); + assertThat(op.options.contains("-t")).as("remove").isFalse(); + } + + @Test + void treeWithComments() { + var op = new CheckstyleOperation().fromProject(new Project()).treeWithComments(true); + assertThat(op.options.contains("-T")).as("add").isTrue(); + op = op.treeWithComments(false); + assertThat(op.options.contains("-T")).as("remove").isFalse(); + } + + @Test + void treeWithJavadoc() { + var op = new CheckstyleOperation().fromProject(new Project()).treeWithJavadoc(true); + assertThat(op.options.contains("-J")).as("add").isTrue(); + op = op.treeWithJavadoc(false); + assertThat(op.options.contains("-J")).as("remove").isFalse(); + } +} \ No newline at end of file diff --git a/src/test/resources/google_checks.xml b/src/test/resources/google_checks.xml new file mode 100644 index 0000000..bc47e7e --- /dev/null +++ b/src/test/resources/google_checks.xml @@ -0,0 +1,382 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +