Skip to content

Commit 5977a13

Browse files
feat: enhance message prefixes for consistency and clarity
1 parent d289485 commit 5977a13

File tree

3 files changed

+37
-7
lines changed

3 files changed

+37
-7
lines changed

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
77
javaVersion=21
88
mcVersion=1.21.10
99
group=dev.slne.surf
10-
version=1.21.10-2.42.3
10+
version=1.21.10-2.42.4
1111
relocationPrefix=dev.slne.surf.surfapi.libs
1212
snapshot=false

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/Colors.kt

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
package dev.slne.surf.surfapi.core.api.messages
22

3+
import dev.slne.surf.surfapi.core.api.messages.adventure.buildText
34
import net.kyori.adventure.text.Component
45
import net.kyori.adventure.text.format.NamedTextColor
56
import net.kyori.adventure.text.format.TextColor
67
import net.kyori.adventure.text.format.TextColor.color
8+
import net.kyori.adventure.text.format.TextDecoration
79

810
/**
911
* A class that defines all the colors used in the Surf system, ensuring a consistent visual style
@@ -108,11 +110,36 @@ interface Colors {
108110
// -------------------- Default Colors -------------------- //
109111

110112
/**
111-
* The default prefix used across all Surf plugins, ensuring a recognizable and uniform
113+
* The default prefix used across all Surf plugins
114+
*/
115+
@JvmField
116+
val PREFIX: Component = buildText {
117+
spacer("»")
118+
appendSpace()
119+
}
120+
121+
@JvmField
122+
val WARNING_PREFIX: Component = buildText {
123+
spacer("[")
124+
error("!", TextDecoration.BOLD)
125+
spacer("]")
126+
appendSpace()
127+
}
128+
129+
@JvmField
130+
val ERROR_PREFIX: Component = buildText {
131+
spacer("[")
132+
error("", TextDecoration.BOLD)
133+
spacer("]")
134+
appendSpace()
135+
}
136+
137+
/**
138+
* The surf used across all Surf plugins, ensuring a recognizable and uniform
112139
* identifier in messages.
113140
*/
114141
@JvmField
115-
val PREFIX: Component = Component.text(">> ", DARK_SPACER)
142+
val SURF_PREFIX: Component = Component.text(">> ", DARK_SPACER)
116143
.append(Component.text("Surf", PREFIX_COLOR))
117144
.append(Component.text(" | ", DARK_SPACER))
118145

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder.kt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package dev.slne.surf.surfapi.core.api.messages.builder
22

3+
import dev.slne.surf.surfapi.core.api.messages.*
34
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.DARK_SPACER
45
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.ERROR
56
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.INFO
@@ -11,14 +12,10 @@ import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.SUCCESS
1112
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.VARIABLE_KEY
1213
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.VARIABLE_VALUE
1314
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.WARNING
14-
import dev.slne.surf.surfapi.core.api.messages.CommonComponents
1515
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.DISCONNECT_HEADER
1616
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.DISCORD_LINK
1717
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.MAP_SEPERATOR
1818
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.TIME_SEPARATOR
19-
import dev.slne.surf.surfapi.core.api.messages.NoLowercase
20-
import dev.slne.surf.surfapi.core.api.messages.joinToComponent
21-
import dev.slne.surf.surfapi.core.api.messages.joinToComponentNewLine
2219
import net.kyori.adventure.key.Key
2320
import net.kyori.adventure.text.*
2421
import net.kyori.adventure.text.event.ClickEvent
@@ -44,6 +41,9 @@ interface SurfComponentBuilder : TextComponent.Builder {
4441
}
4542

4643
fun appendPrefix() = append(PREFIX)
44+
fun appendSurfPrefix() = append(Colors.SURF_PREFIX)
45+
fun appendErrorPrefix() = append(Colors.ERROR_PREFIX)
46+
fun appendWarningPrefix() = append(Colors.WARNING_PREFIX)
4747
fun appendNewPrefixedLine() = appendNewline().appendPrefix()
4848

4949
fun append(block: SurfComponentBuilder.() -> Unit): SurfComponentBuilder =
@@ -234,6 +234,9 @@ interface SurfComponentBuilder : TextComponent.Builder {
234234
fun darkSpacer(long: Long, vararg decoration: TextDecoration) =
235235
text(long, DARK_SPACER, *decoration)
236236

237+
fun white(any: Any, vararg decoration: TextDecoration) =
238+
text(any.toString(), Colors.WHITE, *decoration)
239+
237240
fun ellipsis(color: TextColor? = SPACER) = append(CommonComponents.ELLIPSIS.color(color))
238241

239242
fun appendDiscordLink() = append(DISCORD_LINK)

0 commit comments

Comments
 (0)