https://github.com/platan/idea-gradle-dependencies-formatter
Gradle dependencies formatter for IntelliJ IDEA
https://github.com/platan/idea-gradle-dependencies-formatter
dependencies gradle intellij intellij-idea intellij-plugin
Last synced: 6 months ago
JSON representation
Gradle dependencies formatter for IntelliJ IDEA
- Host: GitHub
- URL: https://github.com/platan/idea-gradle-dependencies-formatter
- Owner: platan
- License: mit
- Created: 2015-09-02T19:10:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T05:00:25.000Z (about 1 year ago)
- Last Synced: 2025-01-03T05:22:23.283Z (6 months ago)
- Topics: dependencies, gradle, intellij, intellij-idea, intellij-plugin
- Language: Groovy
- Homepage: https://plugins.jetbrains.com/plugin/7937
- Size: 1.34 MB
- Stars: 163
- Watchers: 8
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - platan/idea-gradle-dependencies-formatter - Gradle dependencies formatter for IntelliJ IDEA (Groovy)
README
# Gradle dependencies formatter
[](https://img.shields.io/github/actions/workflow/status/platan/idea-gradle-dependencies-formatter/build.yml)
[)](https://ci.appveyor.com/project/platan/idea-gradle-dependencies-formatter)
[](https://coveralls.io/github/platan/idea-gradle-dependencies-formatter?branch=master)
[](https://codebeat.co/projects/github-com-platan-idea-gradle-dependencies-formatter-master)
[](https://plugins.jetbrains.com/plugin/7937-gradle-dependencies-formatter)
[](https://plugins.jetbrains.com/plugin/7937-gradle-dependencies-formatter)
IntelliJ IDEA plugin for formatting Gradle dependencies.
## Features
- Convert a string notation to a map notation
- Convert a map notation to a string notation
- Sort dependencies
- Paste a Maven dependency as a Gradle dependency (on the fly conversion)
## Installation
Install using the JetBrains Plugin Repository:
`File` > `Settings` > `Plugins` > `Browse repositories...` > type `gradle dependencies formatter` in search form > `Install plugin`
## Usage
### Convert between a string notation and a map notation
Use `Show Intention Actions` action (`Alt + Enter` or ⌥⏎) and choose `Convert to map notation` or `Convert to string notation`.
### Sort dependencies
In order to sort dependencies open a `.gradle` file and use `Sort Gradle dependencies` action from `Code` menu.
### Paste a Maven dependency as a Gradle dependency
1. Copy a declaration of a Maven dependency in any editor.
2. Paste it into gradle file to dependencies section. Plugin will automatically convert it to a Gradle dependency.
Features:
- converts Maven dependency with `groupId` (required), `artifactId` (required), `version`, `classifier`, `optional` and `exclusions` fields
- handles scopes: `compile`, `provided`, `runtime`, `test`
- optional dependencies are coded using syntax defined by [Nebula Extra Configurations](https://github.com/nebula-plugins/gradle-extra-configurations-plugin/)
- can convert several dependencies at once
If you need to paste XML with maven dependency into gradle file without modification, please use `Paste Simple` action.
Note: In version 2016.3 IntelliJ IDEA added a similar feature. It converts a single maven dependency at once and handles only simple cases. This plugin overrides this built-in feature.
## Development
Build:
`./gradlew build`
In order to run tests with specific IntelliJ IDEA version (e.g. 2016.3) use this command:
`./gradlew -P ideaVersion=2016.3 test`
Run IntelliJ IDEA with the plugin intalled in:
`./gradlew runIde`
This project uses [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin). Please refer to its documentation for information about a configuration.
Note: Currently the project is not prepared to be imported as a IntelliJ Platform Plugin.
## Changelog
### 0.6.1 (2021-09-12)
- (bugfix) fixed NPE in `StringNotationToMapNotationIntention` [#76](https://github.com/platan/idea-gradle-dependencies-formatter/issues/76)
### 0.6.0 (2021-02-12)
- (feature) Sort dependencies in allprojects block and in subprojects block [#39](https://github.com/platan/idea-gradle-dependencies-formatter/issues/39)
- (feature) Change notation type on multiple dependencies at once [#38](https://github.com/platan/idea-gradle-dependencies-formatter/issues/38)
- (bugfix) Convert a map notation that uses a variable to a string notation properly [#42](https://github.com/platan/idea-gradle-dependencies-formatter/issues/42)
### 0.5.3 (2017-12-19)
- (bugfix) Unable to paste multiple Maven dependencies at once [#3](https://github.com/platan/idea-gradle-dependencies-formatter/issues/3)
### 0.5.2 (2017-04-09)
- (bugfix) fixed NPE in `MapNotationToStringNotationIntention#getElementPredicate`
### 0.5.1 (2017-02-12)
- (improvement) Run `MavenToGradleDependenciesCopyPasteProcessor` before built-in `CopyPasteProcessor`s
### 0.5.0 (2016-03-29)
- (feature) Sort dependencies
### 0.4.0 (2015-10-20)
- (feature) Convert a map notation to a string notation
- (bugfix) Convert string notation of a dependency with ext to a map notation
### 0.3.0 (2015-09-22)
- Convert a string notation to a map notation
### 0.2.0 (2015-09-08)
- Paste a Maven dependency as a Gradle dependency:
- added support for elements `classifier` and `optional`
- version is skipped for dependency without version
### 0.1.0 - initial release (2015-09-02)
- Paste a Maven dependency as a Gradle dependency
## License
This project is licensed under the MIT license.