Green-Software-Foundation / if

Impact Framework
https://if.greensoftware.foundation/
MIT License
138 stars 40 forks source link

Add emojis to `if-diff` output #745

Open jmcook1186 opened 3 months ago

jmcook1186 commented 3 months ago

What Add a red cross emoji ❌ to the fail response and a green tick emoji ✅ to the success response for if-diff

Why This change makes the status of the if-diff response clear at a glance, especially when there are additional logs and warnings in the console.

Context if-diff is a command line tool we provide to enable rapid comparison of output files for debugging and verification purposes. Today it provides a success response as follows:

Files match!

and a failure response which looks like:

Files do not match!
tree.children.child-0.inputs.1.network/energy
source: 0.000001
target: 0.01

This plain text is adequate, but it would help to add an emoji to the console log to make it obvious at a glance whether the response was success/fail.

Prerequisites/resources none

SoW (scope of work)

Acceptance criteria

✅ Files match!
❌ Files do not match!
tree.children.child-0.inputs.1.network/energy
source: 0.000001
target: 0.01
leoasimon commented 2 months ago

Hi @jmcook1186

I'm looking for a good first issue to tackle, and this one seems within my reach. If it's still relevant, could you assign it to me?

Thanks :)

jmcook1186 commented 2 months ago

great - go for it!