Skip to content

Commit b9f4880

Browse files
author
ntwigg
committed
Placeholders for docs.
1 parent 6528b0b commit b9f4880

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

plugin-gradle/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Spotless supports all of Gradle's built-in performance features (incremental bui
5353

5454
- [**Quickstart**](#quickstart)
5555
- [Requirements](#requirements)
56+
- [Git hook](#git-hook)
5657
- [Linting](#linting)
5758
- **Languages**
5859
- [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [clang-format](#clang-format), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations), [cleanthat](#cleanthat), [IntelliJ IDEA](#intellij-idea))
@@ -141,6 +142,10 @@ Spotless requires JRE 11+ and Gradle 6.1.1 or newer.
141142
- If you're stuck on JRE 8, use [`id 'com.diffplug.spotless' version '6.13.0'` or older](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md#6130---2023-01-14).
142143
- If you're stuck on an older version of Gradle, [`id 'com.diffplug.gradle.spotless' version '4.5.1'` supports all the way back to Gradle 2.x](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md#451---2020-07-04).
143144

145+
### Git hook
146+
147+
TODO
148+
144149
### Linting
145150

146151
Starting in version `7.0.0`, Spotless now supports linting in addition to formatting. To Spotless, all lints are errors which must be either fixed or suppressed. Lints show up like this:

plugin-maven/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ user@machine repo % mvn spotless:check
3737

3838
- [**Quickstart**](#quickstart)
3939
- [Requirements](#requirements)
40+
- [Git hook](#git-hook)
4041
- [Binding to maven phase](#binding-to-maven-phase)
4142
- **Languages**
4243
- [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations), [cleanthat](#cleanthat), [IntelliJ IDEA](#intellij-idea))
@@ -145,7 +146,10 @@ Spotless consists of a list of formats (in the example above, `misc` and `java`)
145146

146147
Spotless requires Maven to be running on JRE 11+. To use JRE 8, go back to [`2.30.0` or older](https://github.com/diffplug/spotless/blob/main/plugin-maven/CHANGES.md#2300---2023-01-13).
147148

148-
<a name="applying-to-java-source"></a>
149+
150+
### Git hook
151+
152+
TODO
149153

150154
### Binding to maven phase
151155

@@ -176,6 +180,8 @@ any other maven phase (i.e. compile) then it can be configured as below;
176180
</executions>
177181
```
178182

183+
<a name="applying-to-java-source"></a>
184+
179185
## Java
180186

181187
[code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/java/Java.java). [available steps](https://github.com/diffplug/spotless/tree/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/java).

0 commit comments

Comments
 (0)