https://github.com/ragurney/spotless-intellij-gradle

An IntelliJ plugin to allow running the Spotless gradle task from within the IDE.
https://github.com/ragurney/spotless-intellij-gradle

gradle intellij intellij-plugin plugin spotless spotless-gradle

Last synced: about 1 year ago
JSON representation

An IntelliJ plugin to allow running the Spotless gradle task from within the IDE.

• Host: GitHub
• URL: https://github.com/ragurney/spotless-intellij-gradle
• Owner: ragurney
• License: mit
• Created: 2021-12-28T18:53:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-02T10:27:03.000Z (about 2 years ago)
• Last Synced: 2025-03-26T11:11:09.359Z (about 1 year ago)
• Topics: gradle, intellij, intellij-plugin, plugin, spotless, spotless-gradle
• Language: Java
• Homepage:
• Size: 1.37 MB
• Stars: 39
• Watchers: 3
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Spotless Intellij Gradle

![Build](https://github.com/ragurney/spotless/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/18321.svg)](https://plugins.jetbrains.com/plugin/18321)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/18321.svg)](https://plugins.jetbrains.com/plugin/18321)

An IntelliJ plugin to allow running the [spotless](https://github.com/diffplug/spotless) gradle task

from within the IDE on the current file selected in the editor. 

You may find the spotless action via Code > Reformat Code with Spotless.

![spotlessdemo](https://user-images.githubusercontent.com/15261525/147841908-d5cc3bda-56c8-4cbd-ba29-13ebe29f6a1d.gif)

Report bugs or contribute enhancements on GitHub [(ragurney/spotless-intellij-gradle)](https://github.com/ragurney/spotless-intellij-gradle)

## Features

* `spotlessApply` can be run on the current file via Code > Reformat Code with Spotless.

  You may also assign a keyboard shortcut to this action for convenience.

## Installation

>**NOTE:** Before using this extension, ensure you've [configured Spotless](https://github.com/diffplug/spotless/tree/master/plugin-gradle)

correctly in your Gradle build file. (Run ./gradlew spotlessDiagnose to prepare & validate Spotless.)

### Using IDE built-in plugin system:

  Settings/Preferences > Plugins > Marketplace > Search for "Spotless Gradle" >

  Install Plugin

### Manually:

  Download the [latest release](https://github.com/ragurney/spotless/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

## How it Works

This plugin runs the `spotlessApply` Gradle task on the current file using the [Spotless IDE hook](https://github.com/diffplug/spotless/blob/main/plugin-gradle/IDE_HOOK.md). 

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## Release Notes

See [CHANGELOG.md](CHANGELOG.md)

## License

See [License](LICENSE)