/
cmdline.html
567 lines (476 loc) · 22.4 KB
/
cmdline.html
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
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/xdocs/cmdline.xml.vm at 2024-04-28
| Rendered using Apache Maven Default Skin
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<title>checkstyle – Command Line</title>
<link rel="stylesheet" href="./css/maven-base.css" />
<link rel="stylesheet" href="./css/maven-theme.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/checkstyle.js"></script>
<script type="text/javascript"
src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script type="text/javascript" src="./js/anchors.js"></script>
<script type="text/javascript" src="./js/google-analytics.js"></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 class="composite">
<div id="banner">
<a href="./" id="bannerLeft" title="Checkstyle"><img src="images/header-checkstyle-logo.png" alt="Checkstyle"/></a><a href="./" id="bannerRight" title="Checkstyle"><img src="images/header-right-ruller.png" alt="Checkstyle"/></a> <div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xright"><a href="" title="toTop">toTop</a> | <span id="publishDate">Last Published: 2024-04-28</span>
| <span id="projectVersion">Version: 10.16.0</span>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>About</h5>
<ul>
<li class="none"><a href="index.html" title="Checkstyle">Checkstyle</a></li>
<li class="none"><a href="releasenotes.html" title="Release Notes">Release Notes</a></li>
<li class="none"><a href="consulting.html" title="Consulting">Consulting</a></li>
<li class="none"><a href="sponsoring.html" title="Sponsoring">Sponsoring</a></li>
</ul>
<h5>Documentation</h5>
<ul>
<li class="expanded"><a href="config.html" title="Configuration">Configuration</a>
<ul>
<li class="none"><a href="property_types.html" title="Property Types">Property Types</a></li>
<li class="none"><a href="config_system_properties.html" title="System Properties">System Properties</a></li>
</ul></li>
<li class="expanded"><a href="running.html" title="Running">Running</a>
<ul>
<li class="none"><a href="anttask.html" title="Ant Task">Ant Task</a></li>
<li class="none"><strong>Command Line</strong></li>
</ul></li>
<li class="expanded"><a href="checks.html" title="Checks">Checks</a>
<ul>
<li class="collapsed"><a href="checks/annotation/index.html" title="Annotations">Annotations</a></li>
<li class="collapsed"><a href="checks/blocks/index.html" title="Block Checks">Block Checks</a></li>
<li class="collapsed"><a href="checks/design/index.html" title="Class Design">Class Design</a></li>
<li class="collapsed"><a href="checks/coding/index.html" title="Coding">Coding</a></li>
<li class="collapsed"><a href="checks/header/index.html" title="Headers">Headers</a></li>
<li class="collapsed"><a href="checks/imports/index.html" title="Imports">Imports</a></li>
<li class="collapsed"><a href="checks/javadoc/index.html" title="Javadoc Comments">Javadoc Comments</a></li>
<li class="collapsed"><a href="checks/metrics/index.html" title="Metrics">Metrics</a></li>
<li class="collapsed"><a href="checks/misc/index.html" title="Miscellaneous">Miscellaneous</a></li>
<li class="collapsed"><a href="checks/modifier/index.html" title="Modifiers">Modifiers</a></li>
<li class="collapsed"><a href="checks/naming/index.html" title="Naming Conventions">Naming Conventions</a></li>
<li class="collapsed"><a href="checks/regexp/index.html" title="Regexp">Regexp</a></li>
<li class="collapsed"><a href="checks/sizes/index.html" title="Size Violations">Size Violations</a></li>
<li class="collapsed"><a href="checks/whitespace/index.html" title="Whitespace">Whitespace</a></li>
</ul></li>
<li class="collapsed"><a href="filters/index.html" title="Filters">Filters</a></li>
<li class="collapsed"><a href="filefilters/index.html" title="File Filters">File Filters</a></li>
<li class="expanded"><a href="style_configs.html" title="Style Configurations">Style Configurations</a>
<ul>
<li class="none"><a href="google_style.html" title="Google's Style">Google's Style</a></li>
<li class="none"><a href="sun_style.html" title="Sun's Style">Sun's Style</a></li>
</ul></li>
</ul>
<h5>Developers</h5>
<ul>
<li class="expanded"><a href="extending.html" title="Extending Checkstyle">Extending Checkstyle</a>
<ul>
<li class="none"><a href="writingchecks.html" title="Writing Checks">Writing Checks</a></li>
<li class="none"><a href="writingjavadocchecks.html" title="Writing Javadoc Checks">Writing Javadoc Checks</a></li>
<li class="none"><a href="writingfilters.html" title="Writing Filters">Writing Filters</a></li>
<li class="none"><a href="writingfilefilters.html" title="Writing File Filters">Writing File Filters</a></li>
<li class="none"><a href="writinglisteners.html" title="Writing Listeners">Writing Listeners</a></li>
</ul></li>
<li class="none"><a href="contributing.html" title="Contributing">Contributing</a></li>
<li class="expanded"><a href="beginning_development.html" title="Beginning Development">Beginning Development</a>
<ul>
<li class="none"><a href="eclipse.html" title="Eclipse IDE">Eclipse IDE</a></li>
<li class="none"><a href="netbeans.html" title="NetBeans IDE">NetBeans IDE</a></li>
<li class="none"><a href="idea.html" title="IntelliJ IDE">IntelliJ IDE</a></li>
</ul></li>
<li class="none"><a href="apidocs/index.html" title="Javadoc">Javadoc</a></li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed"><a href="project-info.html" title="Project Information">Project Information</a></li>
<li class="collapsed"><a href="project-reports.html" title="Project Reports">Project Reports</a></li>
</ul>
<a href="https://github.com/checkstyle/checkstyle" title="GitHub" class="poweredBy">
<img class="poweredBy" alt="GitHub" src="images/github_logo_social_coding_outlined.png" />
</a>
<a href="https://twitter.com/checkstyle_java/" title="Twitter" class="poweredBy">
<img class="poweredBy" alt="Twitter" src="images/twitter_button.png" />
</a>
<a href="https://stackoverflow.com/questions/tagged/checkstyle" title="Stackoverflow" class="poweredBy">
<img class="poweredBy" alt="Stackoverflow" src="images/stackoverflow.jpeg" />
</a>
<a href="https://groups.google.com/forum/#!forum/checkstyle" title="GoogleGroups" class="poweredBy">
<img class="poweredBy" alt="GoogleGroups" src="images/groups.png" />
</a>
<a href="https://www.ej-technologies.com/products/jprofiler/overview.html" title="JProfiler" class="poweredBy">
<img class="poweredBy" alt="JProfiler" src="https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<section>
<h2><a name="Content"></a>Content</h2>
<ul>
<li><a href="#Content">Content</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#Command_line_usage">Command line usage</a></li>
<li><a href="#Download_and_Run">Download and Run</a></li>
<li><a href="#Run_after_compilation">Run after compilation</a></li>
<li><a href="#Usage_by_Classpath_update">Usage by Classpath update</a></li></ul>
</section>
<section>
<h2><a name="Description"></a>Description</h2>
<p>
This document describes how to run Checkstyle using the command line
tool. The latest version of Checkstyle can be downloaded as described at
<a class="externalLink" href="https://checkstyle.org/#Download">Download section</a>.
This command line tool is included in the Checkstyle distribution.
</p>
</section>
<section>
<h2><a name="Command_line_usage"></a>Command line usage</h2>
<p>
</p>
<div class="source">
<pre>
java -D<property>=<value> \
com.puppycrawl.tools.checkstyle.Main \
-c <configurationFile> \
[-f <format>] [-p <propertiesFile>] [-o <file>] \
[-s <line:column>] [-g | --generate-xpath-suppression] [-w | --tabWidth <length>] \
[-t | --tree] [-T | --treeWithComments] [-J | --treeWithJavadoc] [-j | --javadocTree] \
[-V | --version] [-b | --branch-matching-xpath <xpathQuery>] [-h | --help] \
[-e | --exclude <excludedPath>] [-E | --executeIgnoredModules] [-d | --debug] \
[-x | --exclude-regexp <excludedPathPattern>] \
file(s) or folder(s) ...
</pre></div>
<p>
Checkstyle will process the specified files and by default report
violations to standard out in plain format. Checkstyle requires a <a href="config.html">configuration XML file</a> that configures the
checks to apply. Command line options are:
</p>
<ul id="CLI_Options">
<li>
<code>-c configurationFile</code> - Specifies the location of the
file that defines the configuration modules. The location can either
be a filesystem location, or a
<a class="externalLink" href="https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html#res_names">
name</a>
passed to the ClassLoader.getResource() method.
</li>
<li>
<code>-f format</code> - Specifies the output
format. Valid values: <code>xml</code>, <code>sarif</code>, <code>plain</code> for <a href="apidocs/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/SarifLogger.html">SarifLogger</a>, and
<a href="apidocs/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a>
respectively. Defaults to <code>plain</code>.
</li>
<li>
<code>-p propertiesFile</code> - Sets the property files to load.
</li>
<li>
<code>-o file</code> - Sets the output file. Defaults to stdout.
</li>
<li>
<code>-s line:column</code> - Prints xpath suppressions at the file's line and column
position.
Argument is the line and column number (separated by a <code>:</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.
Note that the generated result will have few queries, joined by pipe(<code>|</code>).
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.
</li>
<li>
<code>-g,--generate-xpath-suppression</code> - 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 catched and single suppressions xml file will be printed out.
Used only
with <code>-c</code> option. Output location can be specified with <code>-o</code> option.
</li>
<li>
<code>-w, --tabWidth length</code> - Sets the length of the tab character. Used only with
<code>-s</code> option. Default value is 8.
</li>
<li>
<code>-t, --tree</code> - This option is used to display the Abstract Syntax Tree (AST)
<b>without any comments</b> of the specified file. It can only be used on a single file
and cannot be combined with other options.
</li>
<li>
<code>-T, --treeWithComments</code> - This option is used to display the Abstract Syntax
Tree (AST) <b>with comment nodes excluding Javadoc</b> of the specified file. It can only
be used on a single file and cannot be combined with other options.
</li>
<li>
<code>-J, --treeWithJavadoc</code> - This option is used to display the Abstract Syntax
Tree (AST) <b>with Javadoc nodes</b> of the specified file. It can only be used on a
single file and cannot be combined with other options.
</li>
<li>
<code>-j, --javadocTree</code> - This option is used to print the Parse Tree of the
Javadoc comment. The file has to contain <b>only Javadoc comment content</b>
excluding '/**' and '*/' at the beginning and at the end respectively. It can only be
used on a single file and cannot be combined with other options.
</li>
<li>
<code>-d, --debug</code> - Prints all debug logging of CheckStyle utility.
</li>
<li>
<code>-e, --exclude excludedPath</code> - Directory/file to exclude from
CheckStyle. The path can be the full, absolute path, or relative to the current path.
Multiple excludes are allowed.
</li>
<li>
<code>-x, --exclude-regexp excludedPathPattern</code> - Directory/file pattern to
exclude from CheckStyle. Multiple excludes are allowed.
</li>
<li>
<code>-V, --version</code> - print product version and exit. Any other option is ignored.
</li>
<li>
<code>-b, --branch-matching-xpath xpathQuery</code>
- Shows Abstract Syntax Tree(AST) branches that match given XPath query.
</li>
<li>
<code>-h, --help</code> - print usage help message and exit. Any other option is ignored.
</li>
<li>
<code>-E, --executeIgnoredModules</code> - Allows ignored modules to be run.
</li>
</ul>
<p>
Note that the <code>-n packageNamesFile</code>
option has been dropped for Checkstyle 5.0, because of significant changes regarding
package name file handling. See <a href="config.html#Packages">this link</a> for details.
</p>
<p>
Set the properties for <a href="config.html#Properties">expanded
property values</a> by either by assigning system properties using the
<code>-D<property>=<value></code> arguments to java or
specifying a property file using the <code>-p</code> option. If a
property file is specified, the system properties are ignored.
</p>
<p>
CLI is implemented by means of <a class="externalLink" href="https://picocli.info">picocli</a>
library. Our CLI supports definition of arguments in file
by means of <a class="externalLink" href="https://picocli.info/#AtFiles">AtFiles</a> feature
and also command line completion in Bash or ZSH Unix shells, see how to make it
<a class="externalLink" href="https://picocli.info/autocomplete.html">here</a>.
</p>
</section>
<section>
<h2><a name="Download_and_Run"></a>Download and Run</h2>
<p>
It is possible to run Checkstyle directly from the JAR file using
the <code>-jar</code> option. Download latest
<a class="externalLink" href="https://github.com/checkstyle/checkstyle/releases/download/checkstyle-10.16.0/checkstyle-10.16.0-all.jar">
checkstyle-10.16.0-all.jar</a>.
An example of run would be:
</p>
<div class="wrap-content">
<div class="source">
<pre>
java -jar checkstyle-10.16.0-all.jar -c /sun_checks.xml MyClass.java
java -jar checkstyle-10.16.0-all.jar -c /google_checks.xml MyClass.java
</pre></div>
</div>
<p>
It is recommended to use configuration files that are embedded in jar files, but latest
configuration files are there:
<a class="externalLink" href="https://raw.githubusercontent.com/checkstyle/checkstyle/master/src/main/resources/sun_checks.xml">
sun_checks.xml</a>
<a class="externalLink" href="https://raw.githubusercontent.com/checkstyle/checkstyle/master/src/main/resources/google_checks.xml">
google_checks.xml</a>
</p>
<p>
To run <a href="writingchecks.html#The_Checkstyle_SDK_Gui">Checkstyle UI viewer</a>
for AST tree directly from the JAR file using
the <code>-jar</code> option. Download latest
<a class="externalLink" href="https://github.com/checkstyle/checkstyle/releases/download/checkstyle-10.16.0/checkstyle-10.16.0-all.jar">
checkstyle-10.16.0-all.jar</a>.
An example of run would be (path to java file is optional):
</p>
<div class="wrap-content">
<div class="source">
<pre>
java -cp checkstyle-10.16.0-all.jar com.puppycrawl.tools.checkstyle.gui.Main \
    MyClass.java
</pre></div>
</div>
</section>
<section>
<h2><a name="Run_after_compilation"></a>Run after compilation</h2>
<p>
Download and compile:
</p>
<div class="wrap-content">
<div class="source">
<pre>
git clone https://github.com/checkstyle/checkstyle.git
cd checkstyle
mvn clean compile
</pre></div>
</div>
<p>
Run validation with arguments:
</p>
<div class="wrap-content">
<div class="source">
<pre>
mvn exec:java -Dexec.mainClass="com.puppycrawl.tools.checkstyle.Main" \
    -Dexec.args="-c /sun_checks.xml src/main/java"
</pre></div>
</div>
<p>
Run UI application for file :
</p>
<div class="wrap-content">
<div class="source">
<pre>
mvn exec:java -Dexec.mainClass="com.puppycrawl.tools.checkstyle.gui.Main" -Dexec.args=\
    "src/main/java/com/puppycrawl/tools/checkstyle/Checker.java"
</pre></div>
</div>
<p>
Build all jars, and launch CLI from new build:
</p>
<div class="wrap-content">
<div class="source">
<pre>
mvn clean package -Passembly,no-validations
java -jar target/checkstyle-X.X-SNAPSHOT-all.jar -c /sun_checks.xml MyClass.java
</pre></div>
</div>
</section>
<section>
<h2><a name="Usage_by_Classpath_update"></a>Usage by Classpath update</h2>
<p>
The easiest way is to include
<a class="externalLink" href="https://github.com/checkstyle/checkstyle/releases/download/checkstyle-10.16.0/checkstyle-10.16.0-all.jar">
checkstyle-10.16.0-all.jar</a>
in the
<a class="externalLink" href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/classpath.html#sthref10">
classpath</a>.
Alternatively, you must include the
<code>compile</code> third party dependencies listed in
<a href="dependencies.html">Project Dependencies</a> in the
classpath.
<br />
<br />
<b>
Run checkstyle with configuration file at
<code>/sun_checks.xml</code> on a filesystem
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java com.puppycrawl.tools.checkstyle.Main -c /sun_checks.xml Check.java
</pre></div>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>/sun_checks.xml</code> on all Java files in a directory
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java com.puppycrawl.tools.checkstyle.Main -c /sun_checks.xml src/
</pre></div>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>/sun_checks.xml</code> on a file and provide a system
property
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java -Dcheckstyle.cache.file=target/cachefile com.puppycrawl.tools.checkstyle.Main \
    -c /sun_checks.xml Check.java
</pre></div>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>/sun_checks.xml</code> on a file and use properties in a
file
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java com.puppycrawl.tools.checkstyle.Main -c /sun_checks.xml \
    -p myCheckstyle.properties Check.java
</pre></div>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>/sun_checks.xml</code> on a file and output to a file in
XML format
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java com.puppycrawl.tools.checkstyle.Main -c /sun_checks.xml -f xml \
    -o build/checkstyle_errors.xml Check.java
</pre></div>
</div>
<p>
<b>
Run checkstyle with <a href="extending.html">custom module(s)
(Root module, Checks, etc)</a> in configuration file:
</b>
</p>
<div class="wrap-content">
<div class="source">
<pre>
java -classpath MyCustom.jar;checkstyle-10.16.0-all.jar \
    com.puppycrawl.tools.checkstyle.Main -c config.xml Check.java
</pre></div>
</div>
<p>
<b>Note</b>: Custom modules should be specified with the class'
<a href="writingchecks.html#Integrating_Checks">full classpath</a>
in the configuration file and the compiled class be located in the custom
JAR for Checkstyle to find.
</p>
</section>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright © 2001–2024.. </div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>