Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add bld PMD Extension to Tools / Integrations #4669

Merged
merged 1 commit into from Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/_data/sidebars/pmd_sidebar.yml
Expand Up @@ -124,6 +124,9 @@ entries:
- title: PMD Java API
output: web, pdf
url: /pmd_userdocs_tools_java_api.html
- title: bld PMD Extension
output: web, pdf
url: /pmd_userdocs_tools_bld.html
- title: CI integrations
output: web, pdf
url: /pmd_userdocs_tools_ci.html
Expand Down
31 changes: 31 additions & 0 deletions docs/pages/pmd/userdocs/tools/bld.md
@@ -0,0 +1,31 @@
---
title: bld PMD Extension
tags: [userdocs, tools]
permalink: pmd_userdocs_tools_bld.html
last_updated: September 2023
---

> [bld](https://rife2.com/bld) is a new build system that allows you to write your build logic in pure Java.

It has a [PMD Extension](https://github.com/rife2/bld-pmd) for it.

To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).

To check all source code using the [java quickstart rule](pmd_rules_java.html), add the following to your build file

```java
@BuildCommand
public void pmd() throws Exception {
new PmdOperation()
.fromProject(this)
.execute();
}
```

```shell
./bld pmd test
```

* Homepage: <https://rife2.com/bld>
* Documentation: <https://github.com/rife2/bld/wiki>
* PMD Extension: <https://github.com/rife2/bld-pmd>