You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by lh...@apache.org on 2025/08/28 20:53:40 UTC
(pulsar-site) branch main updated: Fix and improve instructions for setting up checkstyle in IntelliJ
This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new fb539971acc Fix and improve instructions for setting up checkstyle in IntelliJ
fb539971acc is described below
commit fb539971acc65ce3c416a5c7a2a659ecb433877f
Author: Lari Hotari <lh...@users.noreply.github.com>
AuthorDate: Thu Aug 28 23:39:58 2025 +0300
Fix and improve instructions for setting up checkstyle in IntelliJ
---
contribute/setup-ide.md | 8 +++++++-
static/assets/intellij-checkstyle.png | Bin 0 -> 107447 bytes
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/contribute/setup-ide.md b/contribute/setup-ide.md
index 140c9ba6477..6c697712d76 100644
--- a/contribute/setup-ide.md
+++ b/contribute/setup-ide.md
@@ -63,10 +63,16 @@ Some configuration in the Maven build is conditional based on the JDK version. I
2. Select **Use a local checkstyle file**.
3. Set **File** to **buildtools/src/main/resources/pulsar/checkstyle.xml**.
4. Select **Store relative to project location**.
- 5. Click **Next** → **Next** → **Finish**.
+ 5. Click **Next**
+ 6. For suppressions, set the absolute path of **buildtools/src/main/resources/pulsar/suppressions.xml** file. In the shell you can find it out with `echo $PWD/buildtools/src/main/resources/pulsar/suppressions.xml` command.
+ 7. Click **Next** → **Finish**.
6. Activate the configuration you just added by toggling the corresponding box.
7. Click **OK**.
+You can scan individual files by activating CheckStyle UI in the left side bar. The icon is a pencil.
+
+
+
### Further configuration
* When working on the Pulsar core modules in IntelliJ, reduce the number of active projects in IntelliJ to speed up IDE actions and reduce unrelated IDE warnings.
diff --git a/static/assets/intellij-checkstyle.png b/static/assets/intellij-checkstyle.png
new file mode 100644
index 00000000000..e7241e59493
Binary files /dev/null and b/static/assets/intellij-checkstyle.png differ