Skip to content

Commit 15a8da7

Browse files
nedtwiggnedtwigg
authored
Merge pull request #633 from diffplug/feat/readme-refactor
Refactor all READMEs
2 parents 5070536 + cff05b5 commit 15a8da7

File tree

4 files changed

+785
-716
lines changed

4 files changed

+785
-716
lines changed

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ For the folders below in monospace text, they are published on maven central at
3636
| `lib-extra` | Contains the optional parts of Spotless which require external dependencies. `LineEnding.GIT_ATTRIBUTES` won't work unless `lib-extra` is available. |
3737
| `plugin-gradle` | Integrates spotless and all of its formatters into Gradle. |
3838
| `plugin-maven` | Integrates spotless and all of its formatters into Maven. |
39-
| javadoc-publish | Logic for publishing javadoc to github-pages. |
4039
| ide | Generates and launches an IDE for developing spotless. |
4140
| _ext | Folder for generating glue jars (specifically packaging Eclipse jars from p2 for consumption using maven).
4241

@@ -105,8 +104,7 @@ Here's a checklist for creating a new step for Spotless:
105104

106105
The `_ext` projects are disabled per default, since:
107106

108-
* some of the projects perform vasts downloads at configuration time
109-
107+
* some of the projects perform vast downloads at configuration time
110108
* the downloaded content may change on server side and break CI builds
111109

112110

@@ -116,7 +114,6 @@ Activate the the property via command line, like for example:
116114

117115
```
118116
gradlew -Pcom.diffplug.spotless.include.ext=true build
119-
120117
```
121118

122119
Or set the property in your user `gradle.properties` file, which is especially recommended if you like to work with the `_ext` projects using IDEs.

‎README.md‎

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,20 @@ function extra(className) { return '| [`' + className + '`](lib-extra/src/main/j
3333
output = [
3434
'| Feature / FormatterStep | [plugin-gradle](plugin-gradle/README.md) | [plugin-maven](plugin-maven/README.md) | [(Your build tool here)](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system) |',
3535
'| --------------------------------------------- | ------------- | ------------ | --------|',
36-
lib('generic.EndWithNewlineStep') +'{{yes}} | {{yes}} | {{no}} |',
37-
lib('generic.IndentStep') +'{{yes}} | {{yes}} | {{no}} |',
36+
'| Automatic [idempotency safeguard](PADDEDCELL.md) | {{yes}} | {{yes}} | {{no}} |',
37+
'| Misconfigured [encoding safeguard](https://github.com/diffplug/spotless/blob/08340a11566cdf56ecf50dbd4d557ed84a70a502/testlib/src/test/java/com/diffplug/spotless/EncodingErrorMsgTest.java#L34-L38) | {{yes}} | {{yes}} | {{no}} |',
38+
'| [Ratchet from](https://github.com/diffplug/spotless/tree/main/plugin-gradle#ratchet) `origin/main` or other git ref | {{yes}} | {{yes}} | {{no}} |',
39+
'| Define [line endings using git](https://github.com/diffplug/spotless/tree/main/plugin-gradle#line-endings-and-encodings-invisible-stuff) | {{yes}} | {{yes}} | {{no}} |',
40+
'| Fast incremental format and up-to-date check | {{yes}} | {{no}} | {{no}} |',
41+
'| Fast format on fresh checkout using buildcache | {{yes}} | {{no}} | {{no}} |',
42+
lib('generic.EndWithNewlineStep') +'{{yes}} | {{yes}} | {{no}} |',
43+
lib('generic.IndentStep') +'{{yes}} | {{yes}} | {{no}} |',
3844
lib('generic.LicenseHeaderStep') +'{{yes}} | {{yes}} | {{no}} |',
39-
lib('generic.ReplaceRegexStep') +'{{yes}} | {{yes}} | {{no}} |',
40-
lib('generic.ReplaceStep') +'{{yes}} | {{yes}} | {{no}} |',
41-
lib('generic.TrimTrailingWhitespaceStep') +'{{yes}} | {{yes}} | {{no}} |',
42-
extra('cpp.EclipseFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
45+
lib('generic.ReplaceRegexStep') +'{{yes}} | {{yes}} | {{no}} |',
46+
lib('generic.ReplaceStep') +'{{yes}} | {{yes}} | {{no}} |',
47+
lib('generic.TrimTrailingWhitespaceStep') +'{{yes}} | {{yes}} | {{no}} |',
48+
lib('antlr4.Antlr4FormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
49+
extra('cpp.EclipseFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
4350
extra('groovy.GrEclipseFormatterStep') +'{{yes}} | {{no}} | {{no}} |',
4451
lib('java.GoogleJavaFormatStep') +'{{yes}} | {{yes}} | {{no}} |',
4552
lib('java.ImportOrderStep') +'{{yes}} | {{yes}} | {{no}} |',
@@ -48,26 +55,30 @@ extra('java.EclipseFormatterStep') +'{{yes}} | {{yes}}
4855
lib('kotlin.KtLintStep') +'{{yes}} | {{yes}} | {{no}} |',
4956
lib('kotlin.KtfmtStep') +'{{yes}} | {{yes}} | {{no}} |',
5057
lib('markdown.FreshMarkStep') +'{{yes}} | {{no}} | {{no}} |',
51-
lib('npm.PrettierFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
52-
lib('npm.TsFmtFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
53-
lib('scala.ScalaFmtStep') +'{{yes}} | {{yes}} | {{no}} |',
58+
lib('npm.PrettierFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
59+
lib('npm.TsFmtFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
60+
lib('scala.ScalaFmtStep') +'{{yes}} | {{yes}} | {{no}} |',
5461
lib('sql.DBeaverSQLFormatterStep') +'{{yes}} | {{no}} | {{no}} |',
5562
extra('wtp.EclipseWtpFormatterStep') +'{{yes}} | {{yes}} | {{no}} |',
56-
'| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | {{no}} | {{no}} | {{no}} |',
57-
'| Fast up-to-date checking | {{yes}} | {{no}} | {{no}} |',
58-
'| Automatic idempotency safeguard | {{yes}} | {{no}} | {{no}} |',
59-
''
63+
'| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | {{no}} | {{no}} | {{no}} |',
6064
].join('\n');
6165
-->
6266
| Feature / FormatterStep | [plugin-gradle](plugin-gradle/README.md) | [plugin-maven](plugin-maven/README.md) | [(Your build tool here)](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system) |
6367
| --------------------------------------------- | ------------- | ------------ | --------|
64-
| [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1: | :+1: | :white_large_square: |
65-
| [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1: | :+1: | :white_large_square: |
68+
| Automatic [idempotency safeguard](PADDEDCELL.md) | :+1: | :+1: | :white_large_square: |
69+
| Misconfigured [encoding safeguard](https://github.com/diffplug/spotless/blob/08340a11566cdf56ecf50dbd4d557ed84a70a502/testlib/src/test/java/com/diffplug/spotless/EncodingErrorMsgTest.java#L34-L38) | :+1: | :+1: | :white_large_square: |
70+
| [Ratchet from](https://github.com/diffplug/spotless/tree/main/plugin-gradle#ratchet) `origin/main` or other git ref | :+1: | :+1: | :white_large_square: |
71+
| Define [line endings using git](https://github.com/diffplug/spotless/tree/main/plugin-gradle#line-endings-and-encodings-invisible-stuff) | :+1: | :+1: | :white_large_square: |
72+
| Fast incremental format and up-to-date check | :+1: | :white_large_square: | :white_large_square: |
73+
| Fast format on fresh checkout using buildcache | :+1: | :white_large_square: | :white_large_square: |
74+
| [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1: | :+1: | :white_large_square: |
75+
| [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1: | :+1: | :white_large_square: |
6676
| [`generic.LicenseHeaderStep`](lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java) | :+1: | :+1: | :white_large_square: |
67-
| [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1: | :+1: | :white_large_square: |
68-
| [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1: | :+1: | :white_large_square: |
69-
| [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1: | :+1: | :white_large_square: |
70-
| [`cpp.EclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseFormatterStep.java) | :+1: | :+1: | :white_large_square: |
77+
| [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1: | :+1: | :white_large_square: |
78+
| [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1: | :+1: | :white_large_square: |
79+
| [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1: | :+1: | :white_large_square: |
80+
| [`antlr4.Antlr4FormatterStep`](lib/src/main/java/com/diffplug/spotless/antlr4/Antlr4FormatterStep.java) | :+1: | :+1: | :white_large_square: |
81+
| [`cpp.EclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseFormatterStep.java) | :+1: | :+1: | :white_large_square: |
7182
| [`groovy.GrEclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/groovy/GrEclipseFormatterStep.java) | :+1: | :white_large_square: | :white_large_square: |
7283
| [`java.GoogleJavaFormatStep`](lib/src/main/java/com/diffplug/spotless/java/GoogleJavaFormatStep.java) | :+1: | :+1: | :white_large_square: |
7384
| [`java.ImportOrderStep`](lib/src/main/java/com/diffplug/spotless/java/ImportOrderStep.java) | :+1: | :+1: | :white_large_square: |
@@ -76,14 +87,12 @@ extra('wtp.EclipseWtpFormatterStep') +'{{yes}} | {{yes}}
7687
| [`kotlin.KtLintStep`](lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java) | :+1: | :+1: | :white_large_square: |
7788
| [`kotlin.KtfmtStep`](lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java) | :+1: | :+1: | :white_large_square: |
7889
| [`markdown.FreshMarkStep`](lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java) | :+1: | :white_large_square: | :white_large_square: |
79-
| [`npm.PrettierFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java) | :+1: | :+1: | :white_large_square: |
80-
| [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1: | :+1: | :white_large_square: |
81-
| [`scala.ScalaFmtStep`](lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java) | :+1: | :+1: | :white_large_square: |
90+
| [`npm.PrettierFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java) | :+1: | :+1: | :white_large_square: |
91+
| [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1: | :+1: | :white_large_square: |
92+
| [`scala.ScalaFmtStep`](lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java) | :+1: | :+1: | :white_large_square: |
8293
| [`sql.DBeaverSQLFormatterStep`](lib/src/main/java/com/diffplug/spotless/sql/DBeaverSQLFormatterStep.java) | :+1: | :white_large_square: | :white_large_square: |
8394
| [`wtp.EclipseWtpFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/wtp/EclipseWtpFormatterStep.java) | :+1: | :+1: | :white_large_square: |
84-
| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | :white_large_square: | :white_large_square: | :white_large_square: |
85-
| Fast up-to-date checking | :+1: | :white_large_square: | :white_large_square: |
86-
| Automatic idempotency safeguard | :+1: | :white_large_square: | :white_large_square: |
95+
| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | :white_large_square: | :white_large_square: | :white_large_square: |
8796
<!---freshmark /matrix -->
8897

8998
*Why are there empty squares?* Many projects get harder to work on as they get bigger. Spotless is easier to work on than ever, and one of the reasons why is that we don't require contributors to "fill the matrix". If you want to [add Bazel support](https://github.com/diffplug/spotless/issues/76), we'd happily accept the PR even if it only supports the one formatter you use. And if you want to add FooFormatter support, we'll happily accept the PR even if it only supports the one build system you use.

0 commit comments

Comments
 (0)