Skip to content

Commit 7ad9853

Browse files
committed
Update docs regarding native cmd for gradle plugin
1 parent d2f34ae commit 7ad9853

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ lib('generic.EndWithNewlineStep') +'{{yes}} | {{yes}}
4848
lib('generic.IndentStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
4949
lib('generic.Jsr223Step') +'{{no}} | {{yes}} | {{no}} | {{no}} |',
5050
lib('generic.LicenseHeaderStep') +'{{yes}} | {{yes}} | {{yes}} | {{no}} |',
51-
lib('generic.NativeCmdStep') +'{{no}} | {{yes}} | {{no}} | {{no}} |',
51+
lib('generic.NativeCmdStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
5252
lib('generic.ReplaceRegexStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
5353
lib('generic.ReplaceStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
5454
lib('generic.TrimTrailingWhitespaceStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
@@ -87,7 +87,7 @@ extra('wtp.EclipseWtpFormatterStep') +'{{yes}} | {{yes}}
8787
| [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
8888
| [`generic.Jsr223Step`](lib/src/main/java/com/diffplug/spotless/generic/Jsr223Step.java) | :white_large_square: | :+1: | :white_large_square: | :white_large_square: |
8989
| [`generic.LicenseHeaderStep`](lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java) | :+1: | :+1: | :+1: | :white_large_square: |
90-
| [`generic.NativeCmdStep`](lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java) | :white_large_square: | :+1: | :white_large_square: | :white_large_square: |
90+
| [`generic.NativeCmdStep`](lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
9191
| [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
9292
| [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
9393
| [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |

plugin-gradle/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Spotless supports all of Gradle's built-in performance features (incremental bui
7777
- [eclipse web tools platform](#eclipse-web-tools-platform)
7878
- css, html, js, json, xml
7979
- **Language independent**
80+
- [Generic steps](#generic-steps)
8081
- [License header](#license-header) ([slurp year from git](#retroactively-slurp-years-from-git-history))
8182
- [How can I enforce formatting gradually? (aka "ratchet")](#ratchet)
8283
- [`spotless:off` and `spotless:on`](#spotlessoff-and-spotlesson)
@@ -715,6 +716,20 @@ Unlike Eclipse, Spotless WTP ignores per default external URIs in schema locatio
715716
external entities. To allow the access of external URIs, set the property `resolveExternalURI`
716717
to true.
717718
719+
## Generic steps
720+
721+
[Prettier](#prettier), [eclipse wtp](#eclipse-web-tools-platform), and [license header](#license-header) are available in every format, and they each have their own section. As mentioned in the [quickstart](#quickstart), there are a variety of simple generic steps which are also available in every format, here are examples of these:
722+
723+
```gradle
724+
spotless {
725+
// run a native binary
726+
format 'terraform', {
727+
target 'src/**/*.tf', 'src/**/*.tfvars' // you have to set the target manually
728+
nativeCmd('terraform', '/opt/homebrew/bin/terraform', ['fmt', '-']) // name, path to binary, additional arguments
729+
}
730+
}
731+
```
732+
718733
<a name="license-header-options"></a>
719734
720735
## License header

0 commit comments

Comments
 (0)