Skip to content

Commit

Permalink
Aligned style of documentation with the on proposed in #293.
Browse files Browse the repository at this point in the history
The Eclipse formatter is described in a dedicated sub-section.
The configFile example follows directly after the describing paragraph.
  • Loading branch information
fvgh committed Sep 4, 2018
1 parent f3e9677 commit fe87c6a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions plugin-gradle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,10 @@ spotless {
}
```

The [Groovy-Eclipse](https://github.com/groovy/groovy-eclipse) formatter is based on the Eclipse Java formatter as used by `eclipseFormatFile`. It uses the same configuration parameters plus a few additional ones. These parameters can be configured within a single file, like the Java properties file [greclipse.properties](../lib-extra/src/test/resources/groovy/greclipse/format/greclipse.properties) in the previous example. The formatter step can also load the [exported Eclipse properties](../ECLIPSE_SCREENSHOTS.md) and augment it with the `org.codehaus.groovy.eclipse.ui.prefs` from the Eclipse workspace as shown below.
### [Groovy-Eclipse](https://github.com/groovy/groovy-eclipse) XML formatter

[Groovy-Eclipse](https://github.com/groovy/groovy-eclipse) formatter errors/warnings lead
per default to a build failure. This behavior can be changed by adding the property/key value: `ignoreFormatterProblems=true` to the configuration. In this scenario, files
causing problems, will not be modified by this formatter step.
The formatter is based on the Eclipse Java formatter as used by `eclipseFormatFile`. It uses the same configuration parameters plus a few additional ones.
These parameters can be configured within a single file, like the Java properties file [greclipse.properties](../lib-extra/src/test/resources/groovy/greclipse/format/greclipse.properties) in the previous example. The formatter step can also load the [exported Eclipse properties](../ECLIPSE_SCREENSHOTS.md) and augment it with the `org.codehaus.groovy.eclipse.ui.prefs` from the Eclipse workspace as shown below.

```gradle
spotless {
Expand All @@ -209,6 +208,8 @@ spotless {
}
```

Groovy-Eclipse formatting errors/warnings lead per default to a build failure. This behavior can be changed by adding the property/key value `ignoreFormatterProblems=true` to a configuration file. In this scenario, files causing problems, will not be modified by this formatter step.

<a name="freshmark"></a>

## Applying [FreshMark](https://github.com/diffplug/freshmark) to markdown files
Expand Down

0 comments on commit fe87c6a

Please sign in to comment.