Skip to content

feat: enhance message prefixes for consistency and clarity #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: version/1.21.10
Choose a base branch
from
Open

feat: enhance message prefixes for consistency and clarity #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5977a13
feat: enhance message prefixes for consistency and clarity
TheBjoRedCraft Nov 19, 2025
e721143
feat: bump version to 1.6.2
TheBjoRedCraft Nov 19, 2025
a32452f
Update surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/…
TheBjoRedCraft Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
javaVersion=21
mcVersion=1.21.10
group=dev.slne.surf
version=1.21.10-2.42.3
version=1.21.10-2.42.4
relocationPrefix=dev.slne.surf.surfapi.libs
snapshot=false
31 changes: 29 additions & 2 deletions ...-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/Colors.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package dev.slne.surf.surfapi.core.api.messages

import dev.slne.surf.surfapi.core.api.messages.adventure.buildText
import net.kyori.adventure.text.Component
import net.kyori.adventure.text.format.NamedTextColor
import net.kyori.adventure.text.format.TextColor
import net.kyori.adventure.text.format.TextColor.color
import net.kyori.adventure.text.format.TextDecoration

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

/**
* The default prefix used across all Surf plugins, ensuring a recognizable and uniform
* The default prefix used across all Surf plugins
*/
@JvmField
val PREFIX: Component = buildText {
spacer("»")
appendSpace()
}

@JvmField
val WARNING_PREFIX: Component = buildText {
spacer("[")
error("!", TextDecoration.BOLD)
spacer("]")
appendSpace()
}

@JvmField
val ERROR_PREFIX: Component = buildText {
spacer("[")
error("✘", TextDecoration.BOLD)
spacer("]")
appendSpace()
}

/**
* The Surf prefix used across all Surf plugins, ensuring a recognizable and uniform
* identifier in messages.
*/
@JvmField
val PREFIX: Component = Component.text(">> ", DARK_SPACER)
val SURF_PREFIX: Component = Component.text(">> ", DARK_SPACER)
.append(Component.text("Surf", PREFIX_COLOR))
.append(Component.text(" | ", DARK_SPACER))

Expand Down
11 changes: 7 additions & 4 deletions ...i/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package dev.slne.surf.surfapi.core.api.messages.builder

import dev.slne.surf.surfapi.core.api.messages.*
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.DARK_SPACER
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.ERROR
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.INFO
Expand All @@ -11,14 +12,10 @@ import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.SUCCESS
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.VARIABLE_KEY
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.VARIABLE_VALUE
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.WARNING
import dev.slne.surf.surfapi.core.api.messages.CommonComponents
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.DISCONNECT_HEADER
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.DISCORD_LINK
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.MAP_SEPERATOR
import dev.slne.surf.surfapi.core.api.messages.CommonComponents.TIME_SEPARATOR
import dev.slne.surf.surfapi.core.api.messages.NoLowercase
import dev.slne.surf.surfapi.core.api.messages.joinToComponent
import dev.slne.surf.surfapi.core.api.messages.joinToComponentNewLine
import net.kyori.adventure.key.Key
import net.kyori.adventure.text.*
import net.kyori.adventure.text.event.ClickEvent
Expand All @@ -44,6 +41,9 @@ interface SurfComponentBuilder : TextComponent.Builder {
}

fun appendPrefix() = append(PREFIX)
fun appendSurfPrefix() = append(Colors.SURF_PREFIX)
fun appendErrorPrefix() = append(Colors.ERROR_PREFIX)
fun appendWarningPrefix() = append(Colors.WARNING_PREFIX)
fun appendNewPrefixedLine() = appendNewline().appendPrefix()

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

fun white(any: Any, vararg decoration: TextDecoration) =
text(any.toString(), Colors.WHITE, *decoration)

fun ellipsis(color: TextColor? = SPACER) = append(CommonComponents.ELLIPSIS.color(color))

fun appendDiscordLink() = append(DISCORD_LINK)
Expand Down
2 changes: 1 addition & 1 deletion surf-api-gradle-plugin/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugins {
group = groupId
version = buildString {
append(mcVersion)
append("-1.6.1")
append("-1.6.2")
if (snapshot) append("-SNAPSHOT")
}

Expand Down