Skip to content

Commit

Permalink
feat(docs): Fix Spelling and update dependencies
Browse files Browse the repository at this point in the history
- Fixes spelling of MockBukkit
- Updates dependencies
- Fixes some formatting errors
  • Loading branch information
thelooter committed Dec 22, 2024
1 parent 30f5487 commit f2bf9fa
Show file tree
Hide file tree
Showing 8 changed files with 889 additions and 445 deletions.
22 changes: 13 additions & 9 deletions docs/en/contribution/maintainers/pr_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand All @@ -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/).
2 changes: 1 addition & 1 deletion docs/en/user_guide/advanced/adventure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user_guide/advanced/custom_server_mock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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(ServerNock)` method.

::: code-group

Expand Down
10 changes: 5 additions & 5 deletions docs/en/user_guide/advanced/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/en/user_guide/introduction/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading

0 comments on commit f2bf9fa

Please sign in to comment.