@@ -179,8 +179,8 @@ Your `checkstyle.xml` file should look then like this:
179
179
----
180
180
<?xml version="1.0"?>
181
181
<!DOCTYPE module PUBLIC
182
- "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
183
- "https://checkstyle.org/dtds/configuration_1_3.dtd">
182
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
183
+ "https://checkstyle.org/dtds/configuration_1_3.dtd">
184
184
<module name="com.puppycrawl.tools.checkstyle.Checker">
185
185
<module name="io.spring.javaformat.checkstyle.SpringChecks" />
186
186
</module>
@@ -237,13 +237,13 @@ You can download the latest version from https://repo1.maven.org/maven2/io/sprin
237
237
The plugin is automatically enabled when one or more of the following conditions match:
238
238
239
239
* `.springformat` file exists
240
- * For maven based project, `spring-javaformat-maven-plugin` plugin is defined in `pom.xml`
241
- * For gradle based project, `io.spring.javaformat` plugin is applied
240
+ * For a Maven- based project, `spring-javaformat-maven-plugin` plugin is defined in `pom.xml`
241
+ * For a Gradle- based project, `io.spring.javaformat` plugin is applied
242
242
243
- ==== IntelliJ IDEA CheckStyle-IDEA plugin
244
- The https://plugins.jetbrains.com/plugin/1065-checkstyle-idea[CheckStyle-IDEA plugin] provides checkstyle integration to the IntelliJ IDEA.
243
+ ==== CheckStyle-IDEA plugin
244
+ The https://plugins.jetbrains.com/plugin/1065-checkstyle-idea[CheckStyle-IDEA plugin] provides Checkstyle integration for IntelliJ IDEA.
245
245
246
- To configure the plugin, first you need to create your own checkstyle configuration file.
246
+ To configure the plugin, create your own Checkstyle configuration file with the following content:
247
247
248
248
[source,xml,indent=0]
249
249
----
@@ -256,12 +256,12 @@ To configure the plugin, first you need to create your own checkstyle configurat
256
256
</module>
257
257
----
258
258
259
- Once configuration file is created:
259
+ Once the configuration file is created, configure your IDE to use it :
260
260
261
261
* Open `Preferences` - `Tools` - `Checkstyle`
262
- * Add `spring-javaformat-checkstyle-[VERSION] .jar` and `spring-javaformat-config-[VERSION] .jar` to the `Third-Party Checks`
263
- * Specify appropriate `Checkstyle version`
264
- * Add your checkstyle configuration file.
262
+ * Add `spring-javaformat-checkstyle-{release-version} .jar` and `spring-javaformat-config-{release-version} .jar` to the `Third-Party Checks`
263
+ * Specify the appropriate `Checkstyle version`
264
+ * Add your Checkstyle configuration file
265
265
266
266
267
267
@@ -298,8 +298,8 @@ If you want most `SpringChecks` but need to exclude one or two, you can do somet
298
298
----
299
299
<?xml version="1.0"?>
300
300
<!DOCTYPE module PUBLIC
301
- "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
302
- "https://checkstyle.org/dtds/configuration_1_3.dtd">
301
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
302
+ "https://checkstyle.org/dtds/configuration_1_3.dtd">
303
303
<module name="com.puppycrawl.tools.checkstyle.Checker">
304
304
<module name="io.spring.javaformat.checkstyle.SpringChecks">
305
305
<property name="excludes" value="io.spring.javaformat.checkstyle.check.SpringAvoidStaticImportCheck" />
0 commit comments