emojize & symolize - api is not intuitive

[bilal-fazlani]

This is the documentation

Parameter	Value	Description
emojize	False	Disables parsing of GitHub style emojis, i.e. :mushroom: into 🍄. Requires symbolize=false
symbolize	False	Disables parsing of SF Symbols i.e. "SF Symbols Test :sun.max: :cloud.fill: :gamecontroller.fill: 🔖 :sun.dust:"

This is my script

#!/bin/bash

echo "hello
---
hasdas :mushroom: sadsad | symbolize=false
hi:mushroom:xzczxc | symbolize=false
hasdas :mushroom: sadsad | emojize=true
hi:mushroom:xzczxc | emojize=true
"

Below plugin is rendered

The first two items have symbolize set to false and rest of them have emojize set to true.
The documentation says "Requires symbolize=false" but it's a bit confusing (to me as a plugin developer).

Can emojize and symbolize be decoupled?

How about we keep emojize as is, but give a different syntax to symbolize?

[melonamin]

Hey, I'm not sure where the confusion is coming from, let me illustrate:

#!/bin/bash
echo "SF Symbol :house:|"
echo "---"
echo "Emoji :house:| symbolize=false"
echo "Text :house:| symbolize=false emojize=false"

Principles:

• emojis and symbolize have the same syntax, it is cleaner in my eyes
• symbolize has a priority, i.e. if the same literal, like :house: in example above, is both an Emoji and SF Symbol - SwiftBar will use SF Symbol
• symbolize=false turns off SF Symbols, allowing Emoji conversion

[bilal-fazlani]

This helps a lot. Thank you.
I think I know where my confusion came from. I am using Catalina. And SF Symbols are not available.

So the same script

#!/bin/bash
echo "SF Symbol :house:|"
echo "---"
echo "Emoji :house:| symbolize=false"
echo "Text :house:| symbolize=false emojize=false"

appears like this on my machine

So in order to fix this on Catalina, I have to modify my script to be like:

#!/bin/bash

echo "SF Symbol :house: | symbolize=false"
echo "---"
echo "Emoji :house:| symbolize=false"
echo "Text :house:| symbolize=false emojize=false"

This make it render like

The only drawback of explicitly setting symbolize=false for backward compatibility for plugin is that, it renders emojis on Big Sur too.

If SwiftBar automatically assumed symbolize=false on pre BigSur OS, then, this

#!/bin/bash
echo "SF Symbol :house:|"
echo "---"
echo "Emoji :house:| symbolize=false"
echo "Text :house:| symbolize=false emojize=false"

would result into

on catalina

and the same script would result into rendering SF Symbol on BigSur

[bilal-fazlani]

Developers can of course opt out of this by explicitly setting symbolize= false

[melonamin]

If SwiftBar automatically assumed symbolize=false on pre BigSur OS, then, this

That makes sense, implemented in #114

[bilal-fazlani]

Thank you!

[myelsukov]

QQ: How can I use SF Symbols with Catalina (10.15.7)? I have installed SF Symbols 2 but whatever I try I can't use them with SwiftBar.

[melonamin]

Per Apple’s HIG: “SF Symbols are available in iOS 13 and later, macOS 11 and later, watchOS 6 and later, and tvOS 13 and later.”

I’m not sure why you are able to install SF Symbols app, but SF Symbols are not supported in Catalina 😔