Skip to content

Commit a65e6f0

Browse files
simschlasimschla
committed
docs: document what filetypes are supported per step
1 parent e34d7db commit a65e6f0

8 files changed

Lines changed: 138 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,11 @@ Runs clang-format
210210
The version of clang-format to use.
211211
(default: 10.0.1)
212212
-V, --version Print version information and exit.
213+
214+
📄 The following file types are supported by this formatter step:
215+
C, C++, Java, JavaScript, JSON, Objective-C, Protobuf, C#
216+
217+
🌎 Homepage: https://clang.llvm.org/docs/ClangFormat.html
213218
```
214219

215220
<!---freshmark /usage_clang_format -->
@@ -251,6 +256,9 @@ Corrects line break formatting of type annotations in java files.
251256
Remove annotations from the list of type annotations to keep
252257
on the same line as the type.
253258
-V, --version Print version information and exit.
259+
260+
📄 The following file types are supported by this formatter step:
261+
Java
254262
```
255263

256264
<!---freshmark /usage_format_annotations -->
@@ -311,6 +319,11 @@ Runs google java format
311319
One of: AOSP, GOOGLE
312320
(default: GOOGLE)
313321
-V, --version Print version information and exit.
322+
323+
📄 The following file types are supported by this formatter step:
324+
Java
325+
326+
🌎 Homepage: https://github.com/google/google-java-format
314327
```
315328

316329
<!---freshmark /usage_google_java_format -->
@@ -369,6 +382,12 @@ Runs license header
369382
The separator to use for the year range in the
370383
license header.
371384
(default: -)
385+
386+
📄 The following file types are supported by this formatter step:
387+
any
388+
389+
🌎 Homepage: https://github.
390+
com/diffplug/spotless/tree/main/plugin-gradle#license-header
372391
```
373392

374393
<!---freshmark /usage_license_header -->
@@ -413,6 +432,11 @@ Runs palantir java format
413432
One of: PALANTIR, AOSP, GOOGLE
414433
(default: PALANTIR)
415434
-V, --version Print version information and exit.
435+
436+
📄 The following file types are supported by this formatter step:
437+
Java
438+
439+
🌎 Homepage: https://github.com/palantir/palantir-java-format
416440
```
417441

418442
<!---freshmark /usage_palantir_java_format -->
@@ -483,6 +507,14 @@ Runs prettier, the opinionated code formatter.
483507
-R, --npmrc-file=<explicitNpmrcFile>
484508
The explicit path to the .npmrc file.
485509
-V, --version Print version information and exit.
510+
511+
📄 The following file types are supported by this formatter step:
512+
JavaScript, JSX, Angular, Vue, Flow, TypeScript, CSS, Less, SCSS, HTML,
513+
Ember/Handlebars, JSON, GraphQL, Markdown, YAML, (and more using plugins)
514+
515+
🌎 Homepage: https://prettier.io/
516+
517+
🧩 Find plugins at https://prettier.io/docs/plugins.html#official-plugins
486518
```
487519

488520
<!---freshmark /usage_prettier -->

‎app/src/main/java/com/diffplug/spotless/cli/help/FormatterStepConstants.java‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright 2025 DiffPlug
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.diffplug.spotless.cli.help;
17+
18+
public final class FormatterStepConstants {
19+
20+
public static final String SUPPORTED_FILETYPES_INTRO =
21+
"📄 The following @|yellow file types|@ are supported by this formatter step:" + OptionConstants.NEW_LINE;
22+
23+
public static final String HOMEPAGE = "🌎 Homepage: ";
24+
25+
private FormatterStepConstants() {
26+
// no instance
27+
}
28+
}

‎app/src/main/java/com/diffplug/spotless/cli/steps/ClangFormat.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,27 @@
2121
import org.jetbrains.annotations.NotNull;
2222

2323
import com.diffplug.spotless.FormatterStep;
24+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
2425
import com.diffplug.spotless.cli.help.OptionConstants;
2526
import com.diffplug.spotless.cpp.ClangFormatStep;
2627

2728
import picocli.CommandLine;
2829

29-
@CommandLine.Command(name = "clang-format", description = "Runs clang-format")
30+
@CommandLine.Command(
31+
name = "clang-format",
32+
description = "Runs clang-format",
33+
footer = {
34+
"",
35+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + ClangFormat.SUPPORTED_FILETYPES,
36+
"",
37+
FormatterStepConstants.HOMEPAGE + ClangFormat.HOMEPAGE
38+
})
3039
public class ClangFormat extends SpotlessFormatterStep {
3140

41+
public static final String SUPPORTED_FILETYPES = "C, C++, Java, JavaScript, JSON, Objective-C, Protobuf, C#";
42+
43+
public static final String HOMEPAGE = "https://clang.llvm.org/docs/ClangFormat.html";
44+
3245
@CommandLine.Option(
3346
names = {"--clang-version", "-v"},
3447
required = true,

‎app/src/main/java/com/diffplug/spotless/cli/steps/FormatAnnotations.java‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,23 @@
2121
import org.jetbrains.annotations.NotNull;
2222

2323
import com.diffplug.spotless.FormatterStep;
24+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
2425
import com.diffplug.spotless.cli.help.OptionConstants;
2526
import com.diffplug.spotless.java.FormatAnnotationsStep;
2627

2728
import picocli.CommandLine;
2829

2930
@CommandLine.Command(
3031
name = "format-annotations",
31-
description = "Corrects line break formatting of type annotations in java files.")
32+
description = "Corrects line break formatting of type annotations in java files.",
33+
footer = {
34+
"",
35+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + FormatAnnotations.SUPPORTED_FILETYPES,
36+
})
3237
public class FormatAnnotations extends SpotlessFormatterStep {
3338

39+
public static final String SUPPORTED_FILETYPES = "Java";
40+
3441
@CommandLine.Option(
3542
names = {"--add-type-annotation", "-a"},
3643
arity = "0..*",

‎app/src/main/java/com/diffplug/spotless/cli/steps/GoogleJavaFormat.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,25 @@
1919

2020
import com.diffplug.spotless.FormatterStep;
2121
import com.diffplug.spotless.cli.core.SpotlessActionContext;
22+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
2223
import com.diffplug.spotless.cli.help.OptionConstants;
2324
import com.diffplug.spotless.java.GoogleJavaFormatStep;
2425

2526
import picocli.CommandLine;
2627

27-
@CommandLine.Command(name = "google-java-format", description = "Runs google java format")
28+
@CommandLine.Command(
29+
name = "google-java-format",
30+
description = "Runs google java format",
31+
footer = {
32+
"",
33+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + GoogleJavaFormat.SUPPORTED_FILETYPES,
34+
"",
35+
FormatterStepConstants.HOMEPAGE + GoogleJavaFormat.HOMEPAGE
36+
})
2837
public class GoogleJavaFormat extends SpotlessFormatterStep {
38+
public static final String SUPPORTED_FILETYPES = "Java";
39+
40+
public static final String HOMEPAGE = "https://github.com/google/google-java-format";
2941

3042
@CommandLine.Option(
3143
names = {"--style", "-s"},

‎app/src/main/java/com/diffplug/spotless/cli/steps/LicenseHeader.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import com.diffplug.spotless.antlr4.Antlr4Defaults;
2727
import com.diffplug.spotless.cli.core.SpotlessActionContext;
2828
import com.diffplug.spotless.cli.core.TargetFileTypeInferer;
29+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
2930
import com.diffplug.spotless.cli.help.OptionConstants;
3031
import com.diffplug.spotless.cpp.CppDefaults;
3132
import com.diffplug.spotless.generic.LicenseHeaderStep;
@@ -34,8 +35,19 @@
3435

3536
import picocli.CommandLine;
3637

37-
@CommandLine.Command(name = "license-header", description = "Runs license header")
38+
@CommandLine.Command(
39+
name = "license-header",
40+
description = "Runs license header",
41+
footer = {
42+
"",
43+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + LicenseHeader.SUPPORTED_FILETYPES,
44+
"",
45+
FormatterStepConstants.HOMEPAGE + LicenseHeader.HOMEPAGE
46+
})
3847
public class LicenseHeader extends SpotlessFormatterStep {
48+
public static final String SUPPORTED_FILETYPES = "any";
49+
50+
public static final String HOMEPAGE = "https://github.com/diffplug/spotless/tree/main/plugin-gradle#license-header";
3951

4052
@CommandLine.ArgGroup(exclusive = true, multiplicity = "1")
4153
LicenseHeaderSourceOption licenseHeaderSourceOption;

‎app/src/main/java/com/diffplug/spotless/cli/steps/PalantirJavaFormat.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,25 @@
2121

2222
import com.diffplug.spotless.FormatterStep;
2323
import com.diffplug.spotless.cli.core.SpotlessActionContext;
24+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
2425
import com.diffplug.spotless.cli.help.OptionConstants;
2526
import com.diffplug.spotless.java.PalantirJavaFormatStep;
2627

2728
import picocli.CommandLine;
2829

29-
@CommandLine.Command(name = "palantir-java-format", description = "Runs palantir java format")
30+
@CommandLine.Command(
31+
name = "palantir-java-format",
32+
description = "Runs palantir java format",
33+
footer = {
34+
"",
35+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + PalantirJavaFormat.SUPPORTED_FILETYPES,
36+
"",
37+
FormatterStepConstants.HOMEPAGE + PalantirJavaFormat.HOMEPAGE
38+
})
3039
public class PalantirJavaFormat extends SpotlessFormatterStep {
40+
public static final String SUPPORTED_FILETYPES = "Java";
41+
42+
public static final String HOMEPAGE = "https://github.com/palantir/palantir-java-format";
3143

3244
@CommandLine.Option(
3345
names = {"--style", "-s"},

‎app/src/main/java/com/diffplug/spotless/cli/steps/Prettier.java‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import com.diffplug.spotless.FormatterStep;
2929
import com.diffplug.spotless.cli.core.ExecutionLayout;
3030
import com.diffplug.spotless.cli.core.SpotlessActionContext;
31+
import com.diffplug.spotless.cli.help.FormatterStepConstants;
3132
import com.diffplug.spotless.npm.NpmPathResolver;
3233
import com.diffplug.spotless.npm.PrettierConfig;
3334
import com.diffplug.spotless.npm.PrettierFormatterStep;
@@ -40,9 +41,24 @@
4041
import static com.diffplug.spotless.cli.help.OptionConstants.NEW_LINE;
4142
import static com.diffplug.spotless.cli.steps.OptionDefaultUse.use;
4243

43-
@CommandLine.Command(name = "prettier", description = "Runs prettier, the opinionated code formatter.")
44+
@CommandLine.Command(
45+
name = "prettier",
46+
description = "Runs prettier, the opinionated code formatter.",
47+
footer = {
48+
"",
49+
FormatterStepConstants.SUPPORTED_FILETYPES_INTRO + Prettier.SUPPORTED_FILETYPES,
50+
"",
51+
FormatterStepConstants.HOMEPAGE + Prettier.HOMEPAGE,
52+
"",
53+
"🧩 Find plugins at https://prettier.io/docs/plugins.html#official-plugins"
54+
})
4455
public class Prettier extends SpotlessFormatterStep {
4556

57+
public static final String SUPPORTED_FILETYPES =
58+
"JavaScript, JSX, Angular, Vue, Flow, TypeScript, CSS, Less, SCSS, HTML, Ember/Handlebars, JSON, GraphQL, Markdown, YAML, (and more using plugins)";
59+
60+
public static final String HOMEPAGE = "https://prettier.io/";
61+
4662
@CommandLine.Option(
4763
names = {"--dev-dependency", "-D"},
4864
description = "An entry to add to the package.json for running prettier." + NEW_LINE

0 commit comments

Comments
 (0)