rewrite-gradle

Gradle plugin that automatically discovers Rewrite refactoring rules and applies them to your codebase

License	The Apache Software License, Version 2.0
Categories	Gradle Build Tools
GroupId	io.spring.gradle
ArtifactId	rewrite-gradle
Last Version	0.3.2
Release Date	Apr 22, 2017
Type	jar
Description	rewrite-gradle Gradle plugin that automatically discovers Rewrite refactoring rules and applies them to your codebase
Project URL	https://github.com/spring-gradle-plugins/rewrite-gradle
Source Code Management	https://github.com/spring-gradle-plugins/rewrite-gradle.git

Download rewrite-gradle

Filename	Size
rewrite-gradle-0.3.2.pom
rewrite-gradle-0.3.2.jar	35 KB
rewrite-gradle-0.3.2-sources.jar	7 KB
rewrite-gradle-0.3.2-javadoc.jar	1 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.spring.gradle/rewrite-gradle/ -->
<dependency>
    <groupId>io.spring.gradle</groupId>
    <artifactId>rewrite-gradle</artifactId>
    <version>0.3.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.spring.gradle/rewrite-gradle/
implementation 'io.spring.gradle:rewrite-gradle:0.3.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.spring.gradle/rewrite-gradle/
implementation ("io.spring.gradle:rewrite-gradle:0.3.2")

Apache Buildr

'io.spring.gradle:rewrite-gradle:jar:0.3.2'

Apache Ivy

<dependency org="io.spring.gradle" name="rewrite-gradle" rev="0.3.2">
  <artifact name="rewrite-gradle" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.spring.gradle', module='rewrite-gradle', version='0.3.2')
)

Scala SBT

libraryDependencies += "io.spring.gradle" % "rewrite-gradle" % "0.3.2"

Leiningen

[io.spring.gradle/rewrite-gradle "0.3.2"]

Dependencies

runtime (3)

Group / Artifact	Type	Version
com.netflix.devinsight.rewrite : rewrite-core	jar	1.2.0
eu.infomas : annotation-detector	jar	3.0.5
org.jetbrains.kotlin : kotlin-stdlib-jre8	jar	1.1.0

Project Modules

There are no modules declared in this project.

Rewrite plugin

A Gradle plugin that discovers and applies Rewrite refactoring rules to your codebase.

Requirements

• Gradle 2.x (2.9 or later) or Gradle 3.x. Gradle 2.8 and earlier are not supported.
• Java 8 or later

Using the plugin

To apply the plugin, see the instructions on the Gradle plugin portal.

The Rewrite plugin scans each source set's classpath for methods marked with @AutoRewrite and applies their contents to the source set.

To generate a report of what should be refactored in your project based on the @AutoRewrite methods found, run:

./gradlew lintSource

To automatically fix your code (preserving all of your beautiful code style), run:

./gradlew fixSourceLint && git diff

It is up to you to check the diff, run tests, and commit the resultant changes!

Creating an @AutoRewrite rule

@AutoRewrite must be placed on a public static method that takes a single Refactor argument. The method may return anything you wish or nothing at all.

Below is an example of a rule:

@AutoRewrite(value = "reactor-mono-flatmap", description = "change flatMap to flatMapMany")
public static void migrateMonoFlatMap(Refactor refactor) {
  // a compilation unit representing the source file we are refactoring
  Tr.CompilationUnit cu = refactor.getOriginal();

  refactor.changeMethodName(cu.findMethodCalls("reactor.core.publisher.Mono flatMap(..)"),
    "flatMapMany");
}

Spring Gradle Plugins

Gradle plugins developed by the Spring team

Versions

Version
0.3.2 Apr 22, 2017
0.3.1 Apr 22, 2017