Skip to content

Commit

Permalink
Remove _ext from CONTRIBUTING.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
nedtwigg committed Jan 23, 2024
1 parent 706f18e commit 9d468eb
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ For the folders below in monospace text, they are published on MavenCentral at t
| `lib-extra` | Contains the optional parts of Spotless which require external dependencies. `LineEnding.GIT_ATTRIBUTES` won't work unless `lib-extra` is available. |
| `plugin-gradle` | Integrates spotless and all of its formatters into Gradle. |
| `plugin-maven` | Integrates spotless and all of its formatters into Maven. |
| `_ext` | Folder for generating glue jars (specifically packaging Eclipse jars from p2 for consumption using maven).

## How to add a new FormatterStep

Expand Down Expand Up @@ -119,24 +118,6 @@ There are many great formatters (prettier, clang-format, black, etc.) which live

Because of Spotless' up-to-date checking and [git ratcheting](https://github.com/diffplug/spotless/tree/main/plugin-gradle#ratchet), Spotless actually doesn't have to call formatters very often, so even an expensive shell call for every single invocation isn't that bad. Anything that works is better than nothing, and we can always speed things up later if it feels too slow (but it probably won't).

## How to enable the `_ext` projects

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

* some of the projects perform vast downloads at configuration time
* the downloaded content may change on server side and break CI builds


The `_ext` can be activated via the root project property `com.diffplug.spotless.include.ext`.

Activate the property via command line, like for example:

```
gradlew -Pcom.diffplug.spotless.include.ext=true build
```

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.

## How to add a new plugin for a build system

The gist of it is that you will have to:
Expand Down

0 comments on commit 9d468eb

Please sign in to comment.