typelevel/skunk

Add option to turn off emojis in exceptions

Open

#1,138 opened on Oct 23, 2024

View on GitHub
 (3 comments) (4 reactions) (0 assignees)Scala (1,656 stars) (172 forks)batch import
good first issue

Description

The flood of 🔥 emojis looks cool and definitely draws attention when you hit an issue in local development, but it's not well supported in all CI systems, and certainly not in all logging systems. There should be a way to tweak this behavior, perhaps even with sane defaults such as disabling the fires when CI=1 or based on some terminal variables.

Contributor guide

Tech stack
scalapostgresql
Domain
backenddatabase
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Scala basicsFamiliarity with Skunk's error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by examining the exception formatting code in the Skunk source, likely in the error or exception handling module. Look for where emojis are injected into error messages. The issue suggests adding a configuration option, possibly via an environment variable like CI=1 to disable emojis automatically. Consider modeling the solution after existing configuration patterns in the library. Review the issue comments for any additional suggestions from maintainers.