-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathindex.html
More file actions
961 lines (705 loc) · 33.3 KB
/
index.html
File metadata and controls
961 lines (705 loc) · 33.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/index.xml.vm at 2026-02-28
| Rendered using Apache Maven Fluido Skin 2.0.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>Checkstyle 13.3.0 – checkstyle</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-2.0.1.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-2.0.1.min.js"></script>
<script type="text/javascript" src="./js/checkstyle.js" defer async></script>
<script type="text/javascript" src="./js/anchors.js" defer async></script>
<script type="text/javascript"
src="./js/google-analytics.js" defer async></script>
<script type="text/javascript"
src="./js/copy-clipboard.js" defer async></script>
<link rel="icon" href="./images/favicon.png" type="image/x-icon" />
<link rel="shortcut icon" href="./images/favicon.ico" type="image/ico" />
</head>
<body>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h1><a href="./"><img class="class java.lang.Object" src="images/header-checkstyle-logo.png" alt="Checkstyle" /></a></h1></div></div>
<div class="pull-right"><div id="bannerRight"><h1><img class="class java.lang.Object" src="images/header-right-ruler.png" /></h1></div></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-02-28</li>
<li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 13.3.0</li>
<li class="pull-right"><a>toTop</a></li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span4">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">About</li>
<li class="active"><a>Checkstyle</a></li>
<li><a href="releasenotes.html">Release Notes</a></li>
<li><a href="consulting.html">Consulting</a></li>
<li><a href="sponsoring.html">Sponsoring</a></li>
<li class="nav-header">Documentation</li>
<li><a href="config.html"><span class="icon-chevron-down"></span>Configuration</a>
<ul class="nav nav-list">
<li><a href="property_types.html">Property Types</a></li>
<li><a href="config_system_properties.html">System Properties</a></li>
</ul></li>
<li><a href="running.html"><span class="icon-chevron-down"></span>Running</a>
<ul class="nav nav-list">
<li><a href="anttask.html">Ant Task</a></li>
<li><a href="cmdline.html">Command Line</a></li>
<li><a href="result_reports.html">Result Reports</a></li>
</ul></li>
<li><a href="checks.html"><span class="icon-chevron-down"></span>Checks</a>
<ul class="nav nav-list">
<li><a href="checks/annotation/index.html"><span class="icon-chevron-right"></span>Annotations</a></li>
<li><a href="checks/blocks/index.html"><span class="icon-chevron-right"></span>Block Checks</a></li>
<li><a href="checks/design/index.html"><span class="icon-chevron-right"></span>Class Design</a></li>
<li><a href="checks/coding/index.html"><span class="icon-chevron-right"></span>Coding</a></li>
<li><a href="checks/header/index.html"><span class="icon-chevron-right"></span>Headers</a></li>
<li><a href="checks/imports/index.html"><span class="icon-chevron-right"></span>Imports</a></li>
<li><a href="checks/javadoc/index.html"><span class="icon-chevron-right"></span>Javadoc Comments</a></li>
<li><a href="checks/metrics/index.html"><span class="icon-chevron-right"></span>Metrics</a></li>
<li><a href="checks/misc/index.html"><span class="icon-chevron-right"></span>Miscellaneous</a></li>
<li><a href="checks/modifier/index.html"><span class="icon-chevron-right"></span>Modifiers</a></li>
<li><a href="checks/naming/index.html"><span class="icon-chevron-right"></span>Naming Conventions</a></li>
<li><a href="checks/regexp/index.html"><span class="icon-chevron-right"></span>Regexp</a></li>
<li><a href="checks/sizes/index.html"><span class="icon-chevron-right"></span>Size Violations</a></li>
<li><a href="checks/whitespace/index.html"><span class="icon-chevron-right"></span>Whitespace</a></li>
</ul></li>
<li><a href="filters/index.html"><span class="icon-chevron-right"></span>Filters</a></li>
<li><a href="filefilters/index.html"><span class="icon-chevron-right"></span>File Filters</a></li>
<li><a href="style_configs.html"><span class="icon-chevron-down"></span>Style Configurations</a>
<ul class="nav nav-list">
<li><a href="google_style.html">Google's Style</a></li>
<li><a href="openjdk_style.html">OpenJDK's Style</a></li>
<li><a href="sun_style.html">Sun's Style</a></li>
</ul></li>
<li class="nav-header">Developers</li>
<li><a href="extending.html"><span class="icon-chevron-down"></span>Extending Checkstyle</a>
<ul class="nav nav-list">
<li><a href="writingchecks.html">Writing Checks</a></li>
<li><a href="writingjavadocchecks.html">Writing Javadoc Checks</a></li>
<li><a href="writingfilters.html">Writing Filters</a></li>
<li><a href="writingfilefilters.html">Writing File Filters</a></li>
<li><a href="writinglisteners.html">Writing Listeners</a></li>
</ul></li>
<li><a href="contributing.html">Contributing</a></li>
<li><a href="beginning_development.html"><span class="icon-chevron-down"></span>Beginning Development</a>
<ul class="nav nav-list">
<li><a href="eclipse.html">Eclipse IDE</a></li>
<li><a href="netbeans.html">NetBeans IDE</a></li>
<li><a href="idea.html">IntelliJ IDE</a></li>
</ul></li>
<li><a href="apidocs/index.html">Javadoc</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html"><span class="icon-chevron-down"></span>Project Information</a>
<ul class="nav nav-list">
<li><a href="dependencies.html">Dependencies</a></li>
<li><a href="dependency-info.html">Maven Coordinates</a></li>
<li><a href="dependency-management.html">Dependency Management</a></li>
<li><a href="distribution-management.html">Distribution Management</a></li>
<li class="active"><a>About</a></li>
<li><a href="issue-management.html">Issue Management</a></li>
<li><a href="licenses.html">Licenses</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="plugin-management.html">Plugin Management</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="scm.html">Source Code Management</a></li>
<li><a href="summary.html">Summary</a></li>
<li><a href="team.html">Team</a></li>
</ul></li>
<li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<a href="https://github.com/checkstyle/checkstyle" class="builtBy"><img class="builtBy" src="images/github_logo_social_coding_outlined.png" alt="GitHub" /></a>
<a href="https://twitter.com/checkstyle_java/" class="builtBy"><img class="builtBy" src="images/twitter_button.png" alt="Twitter" /></a>
<a href="https://stackoverflow.com/questions/tagged/checkstyle" class="builtBy"><img class="builtBy" src="images/stackoverflow.jpeg" alt="Stackoverflow" /></a>
<a href="https://groups.google.com/forum/#!forum/checkstyle" class="builtBy"><img class="builtBy" src="images/groups.png" alt="GoogleGroups" /></a>
<a href="https://www.ej-technologies.com/products/jprofiler/overview.html" class="builtBy"><img class="builtBy" src="https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" alt="JProfiler" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span8">
<section><a id="Overview"></a>
<h1>Overview</h1>
<p>
Checkstyle is a development tool to help programmers write Java code
that adheres to a coding standard. It automates the process of
checking Java code to spare humans of this boring (but important)
task. This makes it ideal for projects that want to enforce a coding
standard.
</p>
<p>
Checkstyle is highly configurable and can be made to support almost
any coding standard. Example configuration files are supplied
supporting the
<a href="styleguides/sun-code-conventions-19990420/CodeConvTOC.doc.html">
Sun Code Conventions</a> and
<a href="styleguides/google-java-style-20250426/javaguide.html">
Google Java Style</a>.
</p>
<p>
A good example of a report that can be produced using Checkstyle and
<a href="https://maven.apache.org/" class="externalLink">Maven</a> can be <a href="https://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle.html" class="externalLink">seen here</a>
.
</p>
</section>
<section><a id="Features"></a>
<h1>Features</h1>
<p>
Checkstyle can check many aspects of your source code.
It can find class design problems, method design problems.
It also has the ability to check code layout and formatting issues.
</p>
<p>
For a detailed list of available checks please refer to the <a href="checks.html">Checks</a> page.
</p>
</section>
<section><a id="Download"></a>
<h1>Download</h1>
<p>
The latest release of Checkstyle can be downloaded from <a href="https://github.com/checkstyle/checkstyle/releases/" class="externalLink">the
GitHub releases page</a>, or
<a href="http://search.maven.org/#search|gav|1|g%3A%22com.puppycrawl.tools%22%20AND%20a%3A%22checkstyle%22" class="externalLink">
Maven central</a>.
</p>
<p>
If you want to live on the bleeding edge, you can <a href="https://github.com/checkstyle/checkstyle" class="externalLink">checkout</a>
the current development code from GitHub and compile
yourself. Or use <a href="https://jitpack.io/" class="externalLink">jitpack.io</a> to build
and get artifacts you need (you can even build your forked repo).
</p>
</section>
<section><a id="Previous_Version_Documentation"></a>
<h1>Previous Version Documentation</h1>
<p>
The current website contains the documentation for the latest release only.
We only support this latest version.
<br />
You can find documentation for most old versions using a URL format like
https://checkstyle.sourceforge.io/version/X.X where "X.X" is the version number.<br />
Example:
<a href="https://checkstyle.sourceforge.io/version/6.18/" class="externalLink">
https://checkstyle.sourceforge.io/version/6.18
</a>
for version 6.18.
</p>
</section>
<section><a id="Development_Cycle"></a>
<h1>Development Cycle</h1>
<b>Release:</b><br />
<ul>
<li>happens at the end of each month if functional changes exist in the
<a href="https://github.com/checkstyle/checkstyle/commits/master" class="externalLink">
master branch of our repo</a>
</li>
<li>can happen by request by any user who is impacted,
but it is not always guaranteed.</li>
</ul>
<p>
Checkstyle is following its own view of
Hybrid Romantic and Semantic Versioning: This is in the form of
"<b>First</b>.<b>Second</b>.<b>Third</b>"
</p>
<p>
<b>First</b> digit is representing Romantic version.
When it is the only number increasing, the maintainers marked it as
a noticeably large breaking compatibility
or major conceptual change which occurred from their perspective.<br />
<b>Second</b> digit is Semantic version which is a combination of major and minor.
When it is the only number increasing, it means that
either some breaking compatibility happened
or new features/modules were introduced.<br />
<b>Third</b> digit is Semantic version which is the patch version.
When it is the only number increasing, it means that only defects are fixed.
</p>
<p>
Checkstyle is not using <a href="https://semver.org/" class="externalLink">Semantic Versioning</a>
due to the reason explained at
<a href="https://github.com/checkstyle/checkstyle/issues/3709" class="externalLink">issue #3709</a>.
</p>
</section>
<section><a id="JRE_and_JDK"></a>
<h1>JRE and JDK</h1>
<p>
Runtime of Checkstyle is limited only by minimal version or JRE.
</p>
<div class="wrapper">
<table class="table table-striped">
<tr class="a">
<th>Checkstyle version</th>
<th>JRE version</th>
</tr>
<tr class="b">
<td>
13.x
</td>
<td>
21 and above
</td>
</tr>
<tr class="a">
<td>
11.x
</td>
<td>
17 and above
</td>
</tr>
<tr class="b">
<td>
10.x
</td>
<td>
11 and above
</td>
</tr>
<tr class="a">
<td>
7.x, 8.x, 9.x
</td>
<td>
8 and above
</td>
</tr>
<tr class="b">
<td>
6.x
</td>
<td>
6 and above
</td>
</tr>
<tr class="a">
<td>
5.x
</td>
<td>
5 and above
</td>
</tr>
</table>
</div>
<p>
Checkstyle currently is confirmed to be buildable by all JDKs from 21 through 23.
Most recent JDKs may be supported. Please
<a href="https://checkstyle.org/report_issue.html" class="externalLink">report an issue</a>
if there are any problems with recent JDKs.
</p>
</section>
<section><a id="Supported_Java_Language_Version"></a>
<h1>Supported Java Language Version</h1>
<p>
Checkstyle can parse all Java language features introduced
in <a href="https://docs.oracle.com/javase/specs/jls/se22/html/index.html" class="externalLink">Java 22</a>
and below. We may support preview features depending on community demand,
but please note that support for a given preview feature may change at any time.
</p>
<p>
Please <a href="report_issue.html">report an issue</a> if you
encounter any issues with the support of the latest Java language features.
</p>
</section>
<section><a id="Limitations"></a>
<h1>Limitations</h1>
<p>
Checkstyle is a single file static analysis tool, for more details please read
the full list of <a href="writingchecks.html#Limitations">limitations</a>.
</p>
</section>
<section><a id="Additional_Checks"></a>
<h1>Additional Checks</h1>
<p>
There are other projects that provide additional checks:
</p>
<div class="wrapper">
<table class="table table-striped">
<tr class="a">
<th>Project name</th>
<th>Link</th>
<th>Remarks</th>
</tr>
<tr class="b">
<td>
<a href="https://checkstyle-addons.thomasjensen.com/" class="externalLink">Checkstyle addons</a>
</td>
<td>
<a href="https://github.com/checkstyle-addons/checkstyle-addons/releases/latest" class="externalLink">
checkstyle-addons
</a>
</td>
<td>Provides additional custom rules and enhancements for Checkstyle.</td>
</tr>
<tr class="a">
<td>
<a href="https://sevntu-checkstyle.github.io/sevntu.checkstyle/" class="externalLink">SevNTU checkstyle</a>
</td>
<td>
<a href="https://github.com/sevntu-checkstyle/sevntu.checkstyle/releases" class="externalLink">
sevntu-checkstyle
</a>
</td>
<td>Offers a collection of advanced static analysis checks for Java code.</td>
</tr>
<tr class="b">
<td>
<a href="https://github.com/tfij/check-tfij-style" class="externalLink">check-tfij-style</a>
</td>
<td>
<a href="https://github.com/tfij/check-tfij-style/releases" class="externalLink">
check-tfij-style
</a>
</td>
<td>Provides opinionated Checkstyle rules based on best practices.</td>
</tr>
</table>
</div>
</section>
<section><a id="Related_Tools"></a>
<h1>Related Tools</h1>
<p>
Checkstyle is most useful if you integrate it into your build process or
your development environment. The distribution includes:
</p>
<ul>
<li>An <a href="anttask.html">Ant task</a>.</li>
<li>A <a href="cmdline.html">command line</a> interface (CLI).</li>
</ul>
<p>
Additionally plug-ins are written by third-parties. Some of them are
still based on the Checkstyle 2.4 release, although there have been
many improvements since then. The known plug-ins are:
</p>
<a id="Related_Tools_Active_Tools"></a><section id="Related_Tools_Active_Tools"><a id="Active_Tools"></a>
<h2>Active Tools</h2>
<div class="wrapper">
<table class="table table-striped">
<tr class="a">
<th>IDE / Build tool</th>
<th>Main/Initial Author</th>
<th>Available from</th>
<th>Remarks</th>
</tr>
<tr class="b">
<td>
<a href="https://www.codacy.com/" class="externalLink">Codacy</a>
</td>
<td>João Machado</td>
<td>
<a href="https://github.com/codacy/codacy-checkstyle/" class="externalLink">
codacy-checkstyle
</a>
</td>
<td>
Provides analysis per commit and per pull request. Supports CheckStyle
config files.
</td>
</tr>
<tr class="a">
<td><a href="https://www.eclipse.org/" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>Christian Wulf</td>
<td>
<a href="https://github.com/ChristianWulf/qa-eclipse-plugin" class="externalLink">
Lightweight Eclipse Plugin for Quality Assurance Tools
</a>
</td>
<td>Alternative to the Eclipse-CS plugin.
Allows to use custom checks directly without providing
an Eclipse Fragment plugin for that purpose.
</td>
</tr>
<tr class="b">
<td><a href="https://www.eclipse.org/" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>David Schneider</td>
<td>
<a href="https://checkstyle.org/eclipse-cs/#!/" class="externalLink">Eclipse-CS Home Page</a>
</td>
<td>
In 2007 was awarded
<a href="https://www.eclipse.org/org/press-release/20070306eclipsecommunityawards.php" class="externalLink">
Best Open Source Eclipse-based Developer tool
</a>.
</td>
</tr>
<tr class="a">
<td><a href="https://gradle.org" class="externalLink">Gradle</a></td>
<td>Hans Dockter (initial author)</td>
<td>Checkstyle supported out of the box</td>
<td>
<a href="https://docs.gradle.org/current/userguide/checkstyle_plugin.html" class="externalLink">
Gradle Checkstyle docs
</a>
</td>
</tr>
<tr class="b">
<td><a href="https://www.jetbrains.com/idea/" class="externalLink">IntelliJ IDEA</a></td>
<td>James Shiell</td>
<td>
<a href="https://github.com/jshiell/checkstyle-idea" class="externalLink">
Checkstyle-idea Project Page
</a>
</td>
<td>Provides real-time and on-demand scanning.</td>
</tr>
<tr class="a">
<td><a href="https://www.jgrasp.org/" class="externalLink">jGRASP</a></td>
<td>Larry Barowski</td>
<td><a href="https://www.jgrasp.org/" class="externalLink">jGRASP Home Page</a></td>
<td>Integrates Checkstyle for code analysis and displays
results within the IDE.
</td>
</tr>
<tr class="b">
<td><a href="https://www.eclipse.org/" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>Roman Ivanov</td>
<td>
<a href="https://github.com/sevntu-checkstyle" class="externalLink">Project Page</a>
</td>
<td>
Extension for Eclipse-CS plugin and also an incubator for
Checkstyle checks that are not present in main stream of
Checkstyle. See the
<a href="https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki" class="externalLink">Wiki</a>
and
<a href="http://sevntu-checkstyle.github.io/sevntu.checkstyle/" class="externalLink">Blog</a>
.
</td>
</tr>
<tr class="a">
<td><a href="https://www.eclipse.org/" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>Jan Burkhardt</td>
<td>
<a href="https://github.com/bjrke/JSR305CheckstylePlugin" class="externalLink">Project Page</a>
</td>
<td>
Extension for Eclipse-CS plugin which ensures nullness annotations on
methods and constructors (JSR305).
</td>
</tr>
<tr class="b">
<td><a href="https://bitbucket.org/atlassian/bamboo-checkstyle-plugin" class="externalLink">
Bamboo Checkstyle plug-in</a></td>
<td>Atlassian (formerly by Ross Rowe and Stephan Paulicke)</td>
<td><a href="https://bitbucket.org/atlassian/bamboo-checkstyle-plugin" class="externalLink">
Bamboo Checkstyle plug-in Home Page</a></td>
<td>An add-on that will parse and record CheckStyle reports and report your
style violations over time.</td>
</tr>
<tr class="a">
<td>
<a href="https://codeclimate.com/" class="externalLink">Code Climate</a>
</td>
<td>Sivakumar Kailasam</td>
<td>
<a href="https://github.com/sivakumar-kailasam/codeclimate-checkstyle" class="externalLink">
codeclimate-checkstyle
</a>
</td>
<td>Supports Checkstyle configuration files and integrates with Code
Climate's automated code review system.
</td>
</tr>
<tr class="b">
<td>
<a href="https://github.com/nikitasavinov/checkstyle-action#checkstyle-github-action" class="externalLink">
Checkstyle GitHub Actions</a>
</td>
<td>Nikita Savinov</td>
<td><a href="https://github.com/marketplace/actions/run-java-checkstyle" class="externalLink">
Github-action Marketplace</a></td>
<td>It runs checkstyle on your Pull Requests using
<a href="https://github.com/features/actions" class="externalLink">github-actions</a> and
<a href="https://github.com/reviewdog/reviewdog" class="externalLink">reviewdog</a>
</td>
</tr>
<tr class="a">
<td><a href="https://wiki.jenkins.io/display/JENKINS/Checkstyle+Plugin" class="externalLink">Jenkins
Checkstyle plug-in</a></td>
<td>Jenkins Community</td>
<td><a href="https://wiki.jenkins.io/display/JENKINS/Checkstyle+Plugin" class="externalLink">Jenkins
Checkstyle plug-in Home Page</a></td>
<td>This plug-in is supported by the Static Analysis Collector plug-in that
collects different analysis results and shows the results in aggregated trend
graphs.</td>
</tr>
<tr class="b">
<td><a href="https://maven.apache.org/" class="externalLink">Maven</a></td>
<td>Vincent Massol</td>
<td>Checkstyle supported out of the box</td>
<td><a href="https://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle.html" class="externalLink">
example report</a></td>
</tr>
<tr class="a">
<td><a href="http://tide.olympe.in/" class="externalLink">tIDE</a></td>
<td>Olympe Team</td>
<td>Built in</td>
<td>Includes built-in Checkstyle support for code analysis during development.</td>
</tr>
<tr class="b">
<td><a href="https://netbeans.apache.org/front/main/index.html" class="externalLink">NetBeans</a></td>
<td>Petr Hejl</td>
<td>
<a href="https://www.sickboy.cz/checkstyle/" class="externalLink">Checkstyle Beans</a>
</td>
<td>
Problems with source code are displayed as annotations of
the source
</td>
</tr>
<tr class="a">
<td><a href="https://netbeans.apache.org/front/main/index.html" class="externalLink">NetBeans</a></td>
<td>SQE Team</td>
<td>
<a href="http://sqe-team.github.io" class="externalLink">Software Quality Environment (SQE)</a>
</td>
<td>Provides a comprehensive suite of quality assurance tools,
including Checkstyle integration.
</td>
</tr>
<tr class="b">
<td><a href="https://www.sonarsource.com/products/sonarqube/" class="externalLink">SonarQube</a></td>
<td>Freddy Mallet (initial author)</td>
<td><a href="https://github.com/checkstyle/sonar-checkstyle" class="externalLink">
Checkstyle SonarQube repository</a></td>
<td><a href="https://sonarcloud.io/projects" class="externalLink">Demo site of SonarQube</a></td>
</tr>
<tr class="a">
<td><a href="https://www.jedit.org/" class="externalLink">jEdit</a></td>
<td>Todd Papaioannou</td>
<td><a href="https://plugins.jedit.org/plugins/?CheckStylePlugin" class="externalLink">
JEdit CheckStylePlugin</a></td>
<td></td>
</tr>
<tr class="b">
<td><a href="https://www.jetbrains.com/idea/" class="externalLink">IntelliJ IDEA</a></td>
<td>Jakub Slawinski</td>
<td>
<a href="https://plugins.jetbrains.com/plugin/4594-qaplug" class="externalLink">QAPlug</a>
</td>
<td>Provides quality assurance features.</td>
</tr>
<tr class="a">
<td><a href="https://www.jarchitect.com" class="externalLink">JArchitect</a></td>
<td>JArchitect Team</td>
<td><a href="https://www.jarchitect.com" class="externalLink">JArchitect Home Page</a></td>
<td>Imports XML result files from CheckStyle.</td>
</tr>
<tr class="b">
<td><a href="https://www.scala-sbt.org/" class="externalLink">SBT</a></td>
<td>Andrew Johnson</td>
<td><a href="https://github.com/etsy/sbt-checkstyle-plugin" class="externalLink">
sbt-checkstyle-plugin Project Page</a></td>
<td>SBT plugin for running Checkstyle on Java source files in an SBT
project</td>
</tr>
<tr class="a">
<td><a href="https://github.com/nidi3/code-assert" class="externalLink">code-assert</a></td>
<td>Stefan Niederhauser</td>
<td><a href="https://github.com/nidi3/code-assert#checkstyle-checks" class="externalLink">
code-assert</a></td>
<td>Assert that the java code of a project satisfies certain checks. Launch
checkstyle validation from UTs</td>
</tr>
<tr class="b">
<td><a href="http://jdee.sourceforge.net/" class="externalLink">Emacs JDE</a></td>
<td>Markus Mohnen</td>
<td>Part of the standard JDEE distribution -
<a href="https://github.com/jdee-emacs/jdee" class="externalLink"></a>
</td>
<td><a href="https://github.com/jdee-emacs/jdee/blob/master/jdee-checkstyle.el" class="externalLink">
configuration could be seen at jdee-checkstyle.el</a></td>
</tr>
<tr class="a">
<td><a href="https://neovim.io/" class="externalLink">Neovim</a></td>
<td>Mathias Fußenegger</td>
<td><a href="https://github.com/mfussenegger/nvim-lint" class="externalLink">nvim-lint</a></td>
<td>An asynchronous linter plugin for Neovim complementary to the built-in Language
Server Protocol support.</td>
</tr>
<tr class="b">
<td><a href="https://code.visualstudio.com/" class="externalLink">Visual Studio Code</a></td>
<td>Sheng Chen</td>
<td><a href="https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle" class="externalLink">
vscode-checkstyle</a></td>
<td>Checkstyle for Microsoft Visual Studio Code</td>
</tr>
<tr class="a">
<td>
<a href="https://github.com/nvuillam/mega-linter" class="externalLink">Mega-Linter</a>
</td>
<td>Nicolas Vuillamy</td>
<td>Checkstyle supported out of the box</td>
<td>Automatically detect 35 languages, 11 formats, 15 tooling formats and copy-pastes
in your repository sources, and apply their related linters. Available as GitHub
Action, other CI tools and locally</td>
</tr>
<tr class="b">
<td>
<a href="https://rife2.com/bld" class="externalLink">bld</a>
</td>
<td>Erik C. Thauvin</td>
<td><a href="https://github.com/rife2/bld-checkstyle" class="externalLink">Checkstyle Extension</a> for bld</td>
<td>An extension for checking source code in a bld project</td>
</tr>
<tr class="a">
<td><a href="https://www.vim.org/" class="externalLink">Vim editor</a></td>
<td>Community (syntastic)</td>
<td><a href="https://github.com/vim-syntastic/syntastic" class="externalLink">Plugin syntastic</a></td>
<td><a href="https://medium.com/@Sohjiro/setup-vim-checkstyle-java-d0dd74dca1e1" class="externalLink">
how to setup.</a></td>
</tr>
</table>
</div>
</section>
<a id="Related_Tools_Inactive_or_Old_Tools"></a><section id="Related_Tools_Inactive_or_Old_Tools"><a id="Inactive_or_Old_Tools"></a>
<h2>Inactive or Old Tools</h2>
<div class="wrapper">
<table class="table table-striped">
<tr class="a">
<th>IDE / Build tool</th>
<th>Main/Initial Author</th>
<th>Available from</th>
<th>Remarks</th>
</tr>
<tr class="b">
<td><a href="https://qalab.sourceforge.net" class="externalLink">QALab</a></td>
<td>Benoit Xhenseval</td>
<td><a href="https://qalab.sourceforge.net" class="externalLink">QALab Home Page</a></td>
<td>Supports tracking Checkstyle statistics over time.</td>
</tr>
</table>
</div>
</section>
<p>
If you have written a plugin for other IDEs, please let us know, so we
can provide a link here.
</p>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2001–2026
</p>
</div>
</div>
</footer>
</body>
</html>