From 95ea5f521f70c4d7573dee922e399ceeb96273c7 Mon Sep 17 00:00:00 2001 From: toyeshhm Date: Wed, 14 Oct 2026 09:47:11 -0500 Subject: [PATCH] Fix broken class links and typos in docs - README.md: the feature matrix lists `cpp.EclipseFormatterStep`, which does not exist; the class is `cpp.EclipseCdtFormatterStep`, so the link 404s. Updated both the freshmark source row and the rendered row. - CONTRIBUTING.md: the reflection example links to `extra/java/EclipseFormatterStep.java`, which does not exist; point it at `EclipseJdtFormatterStep.java`. - plugin-gradle/README.md: conig -> config - plugin-maven/README.md: pecified -> specified, identation -> indentation --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- plugin-gradle/README.md | 2 +- plugin-maven/README.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fb6589e94..9254d80dbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,7 +86,7 @@ FormatterStep create (String name, State state , Function stateSupplier, Function stateToFormatter) ``` -If your formatting step only needs to call one or two methods of the external dependency, you can pull it in at runtime and call it via reflection. See the logic for [`EclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/java/EclipseFormatterStep.java) or [`GoogleJavaFormatStep`](lib/src/main/java/com/diffplug/spotless/java/GoogleJavaFormatStep.java). +If your formatting step only needs to call one or two methods of the external dependency, you can pull it in at runtime and call it via reflection. See the logic for [`EclipseJdtFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/java/EclipseJdtFormatterStep.java) or [`GoogleJavaFormatStep`](lib/src/main/java/com/diffplug/spotless/java/GoogleJavaFormatStep.java). Here's a checklist for creating a new step for Spotless: diff --git a/README.md b/README.md index 53fc88856f..1ef8f68f86 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ lib('generic.TrimTrailingWhitespaceStep') +'{{yes}} | {{yes}} lib('antlr4.Antlr4FormatterStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('biome.BiomeStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('cpp.ClangFormatStep') +'{{yes}} | {{no}} | {{no}} | {{no}} |', -extra('cpp.EclipseFormatterStep') +'{{yes}} | {{yes}} | {{yes}} | {{no}} |', +extra('cpp.EclipseCdtFormatterStep') +'{{yes}} | {{yes}} | {{yes}} | {{no}} |', lib('go.GofmtFormatStep') +'{{yes}} | {{no}} | {{no}} | {{no}} |', lib('gherkin.GherkinUtilsStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', extra('groovy.GrEclipseFormatterStep') +'{{yes}} | {{yes}} | {{yes}} | {{no}} |', @@ -138,7 +138,7 @@ lib('yaml.JacksonYamlStep') +'{{yes}} | {{yes}} | [`antlr4.Antlr4FormatterStep`](lib/src/main/java/com/diffplug/spotless/antlr4/Antlr4FormatterStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`biome.BiomeStep`](lib/src/main/java/com/diffplug/spotless/biome/BiomeStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`cpp.ClangFormatStep`](lib/src/main/java/com/diffplug/spotless/cpp/ClangFormatStep.java) | :+1: | :white_large_square: | :white_large_square: | :white_large_square: | -| [`cpp.EclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseFormatterStep.java) | :+1: | :+1: | :+1: | :white_large_square: | +| [`cpp.EclipseCdtFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseCdtFormatterStep.java) | :+1: | :+1: | :+1: | :white_large_square: | | [`go.GofmtFormatStep`](lib/src/main/java/com/diffplug/spotless/go/GofmtFormatStep.java) | :+1: | :white_large_square: | :white_large_square: | :white_large_square: | | [`gherkin.GherkinUtilsStep`](lib/src/main/java/com/diffplug/spotless/gherkin/GherkinUtilsStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`groovy.GrEclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/groovy/GrEclipseFormatterStep.java) | :+1: | :+1: | :+1: | :white_large_square: | diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md index 258fd6450b..f6e9570853 100644 --- a/plugin-gradle/README.md +++ b/plugin-gradle/README.md @@ -1696,7 +1696,7 @@ spotless { // Download Biome from the network if not already downloaded, see below for more info biome('2.1.0') - // (optional) Path to the directory with the biome.json conig file + // (optional) Path to the directory with the biome.json config file biome('2.1.0').configPath("path/config/dir") // (optional) Biome will auto detect the language based on the file extension. diff --git a/plugin-maven/README.md b/plugin-maven/README.md index de25140289..5c57f5eca9 100644 --- a/plugin-maven/README.md +++ b/plugin-maven/README.md @@ -391,7 +391,7 @@ Note: when enabling `AOSP` style, `reorderImports` needs to be enabled to apply 4.26 ${project.basedir}/eclipse-formatter.xml - + https://download.eclipse.org/eclipse/updates/4.26/ @@ -874,7 +874,7 @@ sql.formatter.keyword.case=UPPER sql.formatter.statement.delimiter=; # Indentation style (space or tab) sql.formatter.indent.type=space -# Number of identation characters +# Number of indentation characters sql.formatter.indent.size=4 ```