Skip to content

Commit 4c3d7b1

Browse files
committed
Polish README
1 parent 6e8849c commit 4c3d7b1

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ Your `checkstyle.xml` file should look then like this:
179179
----
180180
<?xml version="1.0"?>
181181
<!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">
184184
<module name="com.puppycrawl.tools.checkstyle.Checker">
185185
<module name="io.spring.javaformat.checkstyle.SpringChecks" />
186186
</module>
@@ -237,13 +237,13 @@ You can download the latest version from https://repo1.maven.org/maven2/io/sprin
237237
The plugin is automatically enabled when one or more of the following conditions match:
238238

239239
* `.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
242242

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.
245245

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:
247247

248248
[source,xml,indent=0]
249249
----
@@ -256,12 +256,12 @@ To configure the plugin, first you need to create your own checkstyle configurat
256256
</module>
257257
----
258258

259-
Once configuration file is created:
259+
Once the configuration file is created, configure your IDE to use it:
260260

261261
* 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
265265

266266

267267

@@ -298,8 +298,8 @@ If you want most `SpringChecks` but need to exclude one or two, you can do somet
298298
----
299299
<?xml version="1.0"?>
300300
<!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">
303303
<module name="com.puppycrawl.tools.checkstyle.Checker">
304304
<module name="io.spring.javaformat.checkstyle.SpringChecks">
305305
<property name="excludes" value="io.spring.javaformat.checkstyle.check.SpringAvoidStaticImportCheck" />

0 commit comments

Comments
 (0)