-
Notifications
You must be signed in to change notification settings - Fork 8
/
idea.html
287 lines (265 loc) · 13.5 KB
/
idea.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
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/xdocs/idea.xml at 2024-12-12
| 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 – Importing and debugging in IntelliJ IDE</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-12-12</span>
| <span id="projectVersion">Version: 10.21.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"><a href="cmdline.html" title="Command Line">Command Line</a></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"><strong>IntelliJ IDE</strong></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="#Import_Checkstyle_Project">Import Checkstyle Project</a></li>
<li><a href="#Debug">Debug</a></li>
<li><a href="#Organize_Imports">Organize Imports</a></li>
<li><a href="#Inspections">Inspections</a></li>
<li><a href="#Disable_Auto_Indent_On_Paste">Disable Auto Indent On Paste</a></li></ul>
</section>
<section>
<h2><a name="Import_Checkstyle_Project"></a>Import Checkstyle Project</h2>
<p>
If no project is currently open in IntelliJ IDEA, click Import Project on the
Welcome screen. Otherwise, select File > New > Project from Existing Sources<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_importing_idea.png" alt="screenshot" />
</span>
<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_importing_idea1.png" alt="screenshot" />
</span>
<br /><br />
Then Next > Next > ... Until Finish.
</p>
<p>
Generate sources that a required by checkstyle
by right click over pom.xml file and click on menu "Maven / Generate Sources and Update
Folders"
<span class="wrapper block">
<img src="images/gui_screenshot_idea_generate_sources.png" alt="screenshot" />
</span>
<br /><br />
</p>
</section>
<section>
<h2><a name="Debug"></a>Debug</h2>
<p>
Open the Check's source file by double-click on it in a source tree as is shown:<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_select_check_idea.png" alt="screenshot" />
</span>
<br /><br />
Debug the Check by putting the breakpoint at controversial place (double-click)
on the left part of line number as it is shown:<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_debug_idea.png" alt="screenshot" />
</span>
<br /><br />
Open the Test's source file by double-click on it in a source tree as is shown:<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_click_Test_File.png" alt="screenshot" />
</span>
<br /><br />
Then right-click the corresponding Unit-test file or class definition > Debug
"testName"<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_ut_select_idea.png" alt="screenshot" />
</span>
<br /><br />
Then manage you debug operations F8 (Step Over), Shift+F8 (Step Out),
F7 (Step Into), Alt+F9 (Run to Cursor)
</p>
</section>
<section>
<h2><a name="Organize_Imports"></a>Organize Imports</h2>
<p>
One of the Checkstyle checks we run on our own code require certain order of import
statements. Few changes in IDE settings are required to help your IDE do it
automatically.<br />
To change formatter settings please go to File->Settings in menu.<br />
Then in the tree go to: Editor->Code Style->Java, open Import tab (follow numbers on a
picture) and apply settings highlighted:<br /><br />
<span class="wrapper block">
<img src="images/gui_screenshot_organize_imports_idea.jpg" alt="Organize Imports settings in IDEA" />
</span>
<br />
</p>
</section>
<section>
<h2><a name="Inspections"></a>Inspections</h2>
<p>
Checkstyle has its own very strict set of inspections. To import and enable them go to
Settings -> Editor -> Inspections -> Manage -> Import... and locate file
<code>config/intellij-idea-inspections.xml</code>.
<br />
<br />
<span class="wrapper block">
<img src="images/gui_screenshot_inspections_idea.png" alt="Inspections in IntelliJ IDEA" />
</span>
<br />
<br />
ATTENTION: Not all files in repository should be analyzed.
For example test input files contain numerous violations on purpose.
Our shared inspection scope should be used to exclude such files.
<br />
Add custom scope copy file <code>config/intellij-idea-inspection-scope.xml</code>
to <code>.idea/scopes</code> directory.
<br />
Command from root of repo is:
<br />
<code>mkdir -p .idea/scopes; cp config/intellij-idea-inspection-scope.xml
.idea/scopes/</code>
<br />
Now it should be ready to be used in Inspect Code window (Analyse -> Inspect Code):
<br />
<br />
<span class="wrapper block">
<img src="images/gui_screenshot_scope_idea.png" alt="Scope for inspections" />
</span>
</p>
</section>
<section>
<h2><a name="Disable_Auto_Indent_On_Paste"></a>Disable Auto Indent On Paste</h2>
<p>
IDEA has its own rules of indentation when pasting code and it applies these rules to
all the lines of the copied code. This may result in wrong formatting of code in many
checkstyle files. A simple solution to this problem is by using the key combinations
<code>Ctrl + Shift + Alt + V</code> or <code>Edit | Paste Simple</code>. However, it is
recommended that these settings be changed by default as shown below
<span class="wrapper block">
<img src="images/gui_screenshot_disable_indent_paste_idea.png" alt="Disable Auto Indent on Paste" />
</span>
</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>