https://github.com/leavesmc/leavesweight

Gradle build system plugin for Leaves
https://github.com/leavesmc/leavesweight

Last synced: about 2 months ago
JSON representation

Gradle build system plugin for Leaves

• Host: GitHub
• URL: https://github.com/leavesmc/leavesweight
• Owner: LeavesMC
• Created: 2024-01-20T09:32:09.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-05-19T14:36:31.000Z (8 months ago)
• Last Synced: 2024-05-19T15:32:15.137Z (8 months ago)
• Language: Kotlin
• Homepage:
• Size: 1.59 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license/LGPLv2.1.txt

Awesome Lists containing this project

README

        
## leavesweight

**IMPORTANT: leavesweight is a branch of paperweight, dedicated to providing more user-friendly development tools for LeavesMC. It is open source and follows the LGPL2.1 license.**

`leavesweight` consists of only one Gradle plugins now:

- `leavesweight-patcher`: Used to create Leaves, Lumina or other `leavesweight-patcher`-based forks

### How to use this for testing:

- Install `leavesweight` to Maven Local:

```bash

./gradlew publishToMavenLocal

```

- Add `mavenLocal()` for plugin resolution in your test project

  (see the [Gradle docs](https://docs.gradle.org/current/userguide/plugins.html#sec:custom_plugin_repositories) for more details)

- Adjust the `leavesweight` version in your test project

  - Local versions of `leavesweight` will use have the `-SNAPSHOT` suffix in the version from `gradle.properties` replaced by `-LOCAL-SNAPSHOT`

> Most output `leavesweight` creates goes into `/.gradle/caches/paperweight`

>

> (yeah, we use the same path as paperweight.)

### Debugging

Create a remote JVM debug run configuration in IntelliJ which connects to port 5005, then run Gradle in debug mode:

```bash

./gradlew --no-daemon -Dorg.gradle.debug=true 

```

Gradle will not start until the debugger is connected so you don't need to worry about missing a breakpoint.

### Style Guide

This projects follows the opinionated [`ktlint`](https://ktlint.github.io/) linter and formatter. It uses the

[`ktlint-gradle`](https://github.com/jlleitschuh/ktlint-gradle) plugin to automatically check and format the code in

this repo.

Run the `format` task to automatically reformat the project using `ktlint` - which should handle most cases - to

maintain a consistent code style. Adjust any errors `ktlint` can't fix itself before committing.

```

./gradlew format

```

### IDE Setup

It's recommended to run the `ktlintApplyToIdea` and `addKtlintFormatGitPreCommitHook` tasks to configure your IDE

with `ktlint` style settings and to automatically format this project's code before committing:

```

./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook

```

> This project uses many new Gradle features to make sure we're ready for Gradle 7.0 and beyond, and we don't find

> ourselves stuck in a bad position where it's too hard for us to update. That being said, Gradle always marks new APIs

> as unstable for a bit until the next major version, so you should probably disable the "Unstable API Usages" inspection

> in IntelliJ as well. The easiest way to do this is just find any place where an "unstable API" is used (tons in

> `Paperweight.kt`) and disable the inspection from there.