Merge pull request #7 from MockBukkit/feat/various-improvements

Thorinwasher · web-flow · commit ab6017f612b9 · 2024-12-22T20:20:37.000+01:00
feat(docs): Fix Spelling and update dependencies
diff --git a/docs/en/contribution/maintainers/pr_guide.md b/docs/en/contribution/maintainers/pr_guide.md
@@ -7,7 +7,7 @@ title: Maintainer PR Guide
 
 ::: info
 
-This information is mostly relevant to the team members of Mockbukkit.
+This information is mostly relevant to the team members of MockBukkit.
 We nevertheless provide this information publicly as to encourage transparency
 and attract new people to help drive this project forward!
 
@@ -19,14 +19,18 @@ to automatically tag PRs with a version number on merge. This removes the
 tedious work of keeping version numbers up
 to date across several PRs at a time and eliminate Human error. The following
 custom labels, all of them following the
-pattern of `release/*`, are used by Mockbukkit:
-
-| Label | Semantic Version Type | | Description | <!-- markdownlint-disable-line MD033 MD013 -->
-|----------------------------------------------|:----------------------|:----|:---------------------------------------| <!-- markdownlint-disable-line MD033 MD013 -->
-| <Badge type="danger" text="release/major"/> | Major Version (X.0.0) | | Only used for breaking changes | <!-- markdownlint-disable-line MD033 MD013 -->
-| <Badge type="warning" text="release/minor"/> | Minor Version (0.X.0) | | New Features | <!-- markdownlint-disable-line MD033 MD013 -->
-| <Badge type="tip" text="release/patch"/> | Patch Version (0.0.X) | | Bugfixes | <!-- markdownlint-disable-line MD033 MD013 -->
-| <Badge type="info" text="release/none"/> | None (-) | | Method Stubs or non code related fixes | <!-- markdownlint-disable-line MD033 MD013 -->
+pattern of `release/*`, are used by MockBukkit:
+
+<!-- markdownlint-disable line-length -->
+
+| Label                                        | Semantic Version Type | Description                            |
+| -------------------------------------------- | :-------------------- | :------------------------------------- |
+| <Badge type="danger" text="release/major"/>  | Major Version (X.0.0) | Only used for breaking changes         |
+| <Badge type="warning" text="release/minor"/> | Minor Version (0.X.0) | New Features                           |
+| <Badge type="tip" text="release/patch"/>     | Patch Version (0.0.X) | Bugfixes                               |
+| <Badge type="info" text="release/none"/>     | None (-)              | Method Stubs or non code related fixes |
+
+<!-- markdownlint-disable line-length -->
 
 As you can probably tell, this project
 uses [Semantic Versioning](https://semver.org/).
diff --git a/docs/en/user_guide/advanced/adventure.md b/docs/en/user_guide/advanced/adventure.md
@@ -12,7 +12,7 @@ prev:
 ::: info
 
 This talks about the
-[Kyori Adventure](https://github.com/KyoriPowered/adventure-platform)Library.
+[Kyori Adventure](https://github.com/KyoriPowered/adventure-platform) Library.
 This has no connection to the Adventure Gamemode
 
 :::
diff --git a/docs/en/user_guide/advanced/custom_server_mock.md b/docs/en/user_guide/advanced/custom_server_mock.md
@@ -16,7 +16,7 @@ class. This could be if you want to implement some of the unimplemented methods
 or simply provide your own mocks for certain methods.
 
 To do that you can simply pass your custom mock that extends `ServerMock` to the
-`MockBukkit#mock(ServerNock)` method.
+`MockBukkit.mock(ServerMock)` method.
 
 ::: code-group
 
diff --git a/docs/en/user_guide/advanced/events.md b/docs/en/user_guide/advanced/events.md
@@ -20,7 +20,7 @@ Mockbukkit provides a way to check if Events are fired.Events are Classes that
 extend `org.bukkit.event.Event` and are fired by Bukkit.
 
 To check if an event is fired, you can use the
-`PluginManagerMock#assertEventFired(Class<? extends Event>)`method. This method
+`PluginManagerMock.assertEventFired(Class<? extends Event>)`method. This method
 takes a class that extends `org.bukkit.event.Event`. It will then check if an
 event of that type was fired.
 
@@ -81,7 +81,7 @@ class MyPluginTests {
 
 If you want to check if an event was fired with a specific value, you can use
 the
-`PluginManagerMock#assertEventFired(Class<? extends Event>, Predicate<Event>)`
+`PluginManagerMock.assertEventFired(Class<? extends Event>, Predicate<Event>)`
 method.
 
 ::: code-group
@@ -144,7 +144,7 @@ class MyPluginTests {
 ### Custom Failure Message with `assertEventFired`
 
 You can also set a custom failure message for the assertion by using the
-`PluginManagerMock#assertEventFired(Class<? extends Event>, String)` method.
+`PluginManagerMock.assertEventFired(Class<? extends Event>, String)` method.
 
 ::: code-group
 
@@ -202,7 +202,7 @@ class MyPluginTests {
 ## Asserting that Events were not fired
 
 You can also check if an event was not fired by using the
-`PluginManagerMock#assertEventNotFired(Class<? extends Event>)` method.
+`PluginManagerMock.assertEventNotFired(Class<? extends Event>)` method.
 
 ::: code-group
 
@@ -258,7 +258,7 @@ class MyPluginTests {
 ### Custom Failure Message with `assertEventNotFired`
 
 You can also set a custom failure message for the assertion by using the
-`PluginManagerMock#assertEventNotFired(Class<? extends Event>, String)` method.
+`PluginManagerMock.assertEventNotFired(Class<? extends Event>, String)` method.
 
 ::: code-group
 
diff --git a/docs/en/user_guide/introduction/getting_started.md b/docs/en/user_guide/introduction/getting_started.md
@@ -65,7 +65,7 @@ dependencies {
 ## Running MockBukkit
 
 MockBukkit is a test framework, so you will need to run your tests using a test
-runner.Mockbukkit recommends using the
+runner. MockBukkit recommends using the
 [JUnit](https://junit.org/junit5/) test runner.
 
 You can run your tests using the following command:
@@ -85,5 +85,5 @@ gradle test
 If you are using a different test runner,
 you will need to configure it to use MockBukkit.
 While other test runners like [TestNG](https://testng.org/) exist,
-Mockbukkit has not verified compatibility with them. This does not mean that
-Mockbukkit might work with them, but it is not tested.
+MockBukkit has not verified compatibility with them. This does not mean that
+MockBukkit might work with them, but it is not tested.
diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md
@@ -7,7 +7,7 @@ prev:
   text: "Migrate to Mockbukkit 4"
 ---
 
-# Migrate to Mockbukkit 4 using OpenRewrite
+# Migrate to MockBukkit 4 using OpenRewrite
 
 Migration to version 4 was carefully automated by the MockBukkit team using
 OpenRewrite scripts to facilitate the migration process. To run the scripts,
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
   "devDependencies": {
-    "prettier": "3.3.3",
-    "vitepress": "^1.3.1",
-    "vue": "^3.4.34"
+    "prettier": "3.4.2",
+    "vitepress": "^1.5.0",
+    "vue": "^3.5.13"
   },
   "scripts": {
     "docs:dev": "vitepress dev",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
