https://github.com/mockbukkit/openrewrite-recipes
Openrewrite Recipes for Mockbukkit
https://github.com/mockbukkit/openrewrite-recipes
mockbukkit moderne openrewrite openrewrite-recipes refactoring rewrite
Last synced: 7 months ago
JSON representation
Openrewrite Recipes for Mockbukkit
- Host: GitHub
- URL: https://github.com/mockbukkit/openrewrite-recipes
- Owner: MockBukkit
- License: mit
- Created: 2024-10-18T14:06:16.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T19:05:08.000Z (11 months ago)
- Last Synced: 2025-01-10T22:46:16.561Z (9 months ago)
- Topics: mockbukkit, moderne, openrewrite, openrewrite-recipes, refactoring, rewrite
- Homepage: https://mockbukkit.org/
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenRewrite Recipes for MockBukkit Refactoring
This repository contains a set of OpenRewrite recipes designed to help developers refactor projects that use [MockBukkit](https://github.com/Mockbukkit/MockBukkit). OpenRewrite enables automatic refactoring, making it easier to update code, enforce standards, and introduce best practices consistently.
## Overview
MockBukkit is a powerful library for unit testing Bukkit/Spigot plugins, providing mock implementations of core API classes. This set of OpenRewrite recipes helps developers transition older or deprecated usage of MockBukkit into modern patterns, ensuring cleaner and more maintainable test code.
## Features
- **Update Deprecated Classes**: Automatically replace deprecated classes in MockBukkit with their modern counterparts.
## Getting Started
### Prerequisites
- **Java 21**
- **Maven/Gradle** (for OpenRewrite)
- **MockBukkit 3.x or 4.x**
### Installation
Add OpenRewrite as a dependency to your project:
For **Maven**:
```xml
org.openrewrite.maven
rewrite-maven-plugin
5.42.2
org.mockbukkit.rewrite.PackageRename
org.mockbukkit.rewrite.ClassRename
org.mockbukkit.rewrite
openrewrite-recipes
1.0.2
```
For **Gradle**:
Groovy DSL
```groovy
plugins {
id("org.openrewrite.rewrite") version "6.x.x"
}
dependencies {
// Add the Mockbukkit recipes
rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2")
}
// Add the recipe source to your project’s rewrite configuration
rewrite {
activeRecipe("org.mockbukkit.rewrite.PackageRename")
activeRecipe("org.mockbukkit.rewrite.ClassRename")
}
```
Kotlin DSL
```kotlin
plugins {
id("org.openrewrite.rewrite") version "6.x.x"
}
dependencies {
// Add the Mockbukkit recipes
rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2")
}
// Add the recipe source to your project’s rewrite configuration
rewrite {
activeRecipe("org.mockbukkit.rewrite.PackageRename")
activeRecipe("org.mockbukkit.rewrite.ClassRename")
}
```
### Usage
Run OpenRewrite to refactor your code
For **Maven**:
```shell
mvn rewrite:run
```
For **Gradle**:
```shell
./gradlew rewriteRun
```
### Included Recipes
- **PackageRename**: Rename the old `be.seeseemelk` package
to the new `org.mockbukkit package`
- **ClassRename**: Rename the Classes of several Mocks to use the new names
### License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more Details