Skip to content

Commit a610fbf

Browse files
committed
Minor tweaks to homepage.
1 parent aa78b56 commit a610fbf

File tree

1 file changed

+34
-12
lines changed

1 file changed

+34
-12
lines changed

README.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,45 @@
11
# <img align="left" src="_images/spotless_logo.png"> Spotless: Keep your code spotless
22

3-
<!---freshmark shields
4-
output = [
5-
link(image('Circle CI', 'https://circleci.com/gh/diffplug/spotless/tree/main.svg?style=shield'), 'https://circleci.com/gh/diffplug/spotless/tree/main'),
6-
link(shield('Live chat', 'gitter', 'chat', 'brightgreen'), 'https://gitter.im/{{org}}/{{name}}'),
7-
link(shield('License Apache', 'license', 'apache', 'brightgreen'), 'https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)')
8-
].join('\n');
9-
-->
10-
[![Circle CI](https://circleci.com/gh/diffplug/spotless/tree/main.svg?style=shield)](https://circleci.com/gh/diffplug/spotless/tree/main)
11-
[![Live chat](https://img.shields.io/badge/gitter-chat-brightgreen.svg)](https://gitter.im/diffplug/spotless)
12-
[![License Apache](https://img.shields.io/badge/license-apache-brightgreen.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
13-
<!---freshmark /shields -->
3+
[![Gradle Plugin](https://img.shields.io/gradle-plugin-portal/v/com.diffplug.spotless?color=blue&label=gradle%20plugin)](plugin-gradle)
4+
[![Maven Plugin](https://img.shields.io/maven-central/v/com.diffplug.spotless/spotless-maven-plugin?color=blue&label=maven%20plugin)](plugin-maven)
5+
[![SBT Plugin](https://img.shields.io/badge/sbt%20plugin-0.1.3-blue)](https://github.com/moznion/sbt-spotless)
146

15-
Spotless can format &lt;antlr | c | c# | c++ | css | flow | graphql | groovy | html | java | javascript | json | jsx | kotlin | less | license headers | markdown | objective-c | protobuf | python | scala | scss | sql | typeScript | vue | yaml | anything> using &lt;gradle | maven | anything>.
7+
Spotless can format &lt;antlr | c | c# | c++ | css | flow | graphql | groovy | html | java | javascript | json | jsx | kotlin | less | license headers | markdown | objective-c | protobuf | python | scala | scss | sql | typeScript | vue | yaml | anything> using &lt;gradle | maven | sbt | anything>.
168

179
You probably want one of the links below:
1810

1911
## [❇️ Spotless for Gradle](plugin-gradle) (with integrations for [VS Code](https://marketplace.visualstudio.com/items?itemName=richardwillis.vscode-spotless-gradle) and [IntelliJ](https://plugins.jetbrains.com/plugin/18321-spotless-gradle))
12+
13+
```console
14+
user@machine repo % ./gradlew build
15+
:spotlessJavaCheck FAILED
16+
The following files had format violations:
17+
src\main\java\com\diffplug\gradle\spotless\FormatExtension.java
18+
-\t\t····if·(targets.length·==·0)·{
19+
+\t\tif·(targets.length·==·0)·{
20+
Run './gradlew spotlessApply' to fix these violations.
21+
user@machine repo % ./gradlew spotlessApply
22+
:spotlessApply
23+
BUILD SUCCESSFUL
24+
user@machine repo % ./gradlew build
25+
BUILD SUCCESSFUL
26+
```
27+
2028
## [❇️ Spotless for Maven](plugin-maven)
29+
30+
```console
31+
user@machine repo % mvn spotless:check
32+
[ERROR] > The following files had format violations:
33+
[ERROR] src\main\java\com\diffplug\gradle\spotless\FormatExtension.java
34+
[ERROR] -\t\t····if·(targets.length·==·0)·{
35+
[ERROR] +\t\tif·(targets.length·==·0)·{
36+
[ERROR] Run 'mvn spotless:apply' to fix these violations.
37+
user@machine repo % mvn spotless:apply
38+
[INFO] BUILD SUCCESS
39+
user@machine repo % mvn spotless:check
40+
[INFO] BUILD SUCCESS
41+
```
42+
2143
## [❇️ Spotless for SBT (external for now)](https://github.com/moznion/sbt-spotless)
2244
## [Other build systems](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system)
2345

0 commit comments

Comments
 (0)