Skip to content

Commit 4b47237

Browse files
committed
feature(adventure): Add new dependencies section and note about typo removals
1 parent b8ace18 commit 4b47237

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

src/content/docs/adventure/migration/adventure-4.x.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,24 @@ This means that you can no longer extend these classes, although you shouldn't h
1717
One relatively common incorrect usage was to create custom `Component` implementations.
1818
This is now no longer possible, and you should instead be using the `VirtualComponent` API.
1919

20-
Adventure has also migrated to using JSpecify for nullness annotations.
21-
These are applied at a module level, so unless otherwise specified, everything should be treated as non-null.
22-
2320
Another side effect of wanting a modern codebase is that the `adventure-extra-kotlin` module has been removed.
2421
This module will be re-introduced in a separate repo under a new module in the future.
2522
This will allow for more flexibility working around the more frequent Kotlin updates.
2623

2724
The `adventure-text-serializer-gson-legacy-impl` module has also been removed.
2825
This module has been replaced with the implementation-agnostic `adventure-text-serializer-json-legacy-impl` module.
2926

27+
Finally, Adventure now contains proper `module-info.java` files for those of you using the Java 9+ module system.
28+
29+
## Updated dependencies
30+
31+
Adventure has migrated to using JSpecify for nullness annotations.
32+
These are applied at a module level, so unless otherwise specified, everything should be treated as non-null.
33+
3034
As most of the internal implementation of Adventure is now using records, we no longer have need to use the Examination library for `toString` generation.
3135
The Examination library has been entirely removed from Adventure and is no longer a transitive dependency.
3236

33-
Finally, Adventure now contains proper `module-info.java` files for those of you using the Java 9+ module system.
37+
The `adventure-text-logger-slf4j` module has been updated to use SLF4J 2.0.
3438

3539
## Breaking changes
3640

@@ -102,3 +106,6 @@ This section documents the removals that have been made and how you can migrate
102106
This has been replaced with the equivalent `PlainTextComponentSerializer` class.
103107
* **`ClickEvent$Action#payloadType` has been removed.**\
104108
As click event actions are now typed, this field is no longer required.
109+
* **Typos have been removed.**\
110+
Some incorrectly spelt/named methods, such as `Argument#numeric` and `ComponentSerializer#deseializeOrNull`, have been removed.
111+
These methods have been deprecated, and correctly spelt/named methods have been available for a while.

src/content/docs/adventure/migration/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This includes migrating from older versions of Adventure, as well as migrating f
1212

1313
* [Migrating from Adventure 4.x to 5.x](/adventure/migration/adventure-4.x)
1414
* [A modern codebase](/adventure/migration/adventure-4.x#a-modern-codebase)
15+
* [Updated dependencies](/adventure/migration/adventure-4.x#updated-dependencies)
1516
* [Breaking changes](/adventure/migration/adventure-4.x#breaking-changes)
1617
* [Removal of deprecated methods and classes](/adventure/migration/adventure-4.x#removal-of-deprecated-methods-and-classes)
1718
* [Migrating from the BungeeCord Chat API](/adventure/migration/bungeecord-chat-api)

0 commit comments

Comments
 (0)