arthurpalves / badgy Goto Github PK

While reviewing #14 @BenLeggiero raised an interesting opportunity I can't miss discussing :)

Badgy carries a hardcoded color names for --color and --tint-color properties.
Alternatively, we could query ImageMagick for the list with convert -list color | awk '{ print $1 }'.

Each solution has its pros and cons. Unfortunately, both are prone to get out of sync with the end-user scripts, as we have an unpinned dependency on ImageMagick.

All in all, it seems like a hardcoded list looks like a bit easier to reason about considering runtime and dependency validation.
Even as Badgy is destined to go out of sync with ImageMagick named colors right now, we always have an escape hatch with hexed color codes.

Include GitHub workflows to ensure consistency and quality of the codebase.
Include:

• SwiftLint
  • (most common rules)
• SwiftFormat
  • Header template containing also MIT License
  • (most common rules)
• CoherentSwift
  • Minimum threshold of 80%

ArgumentParser is Swift’s open source library to parse command-line arguments.

Consider the switch from SwiftCLI to ArgumentParser as an improvement, for something that has more contribution, stability and support from the community.

During the final stages of migration to ArgumentParser #10, we stumbled upon a problem of a somewhat side dependency on SwiftCLI.Task as an OS command handling interface.

Though the last try wasn't a direct success #20, the overall concept is clear.

Danger: This can cause Xcode to not even want to start building: https://stackoverflow.com/q/63079909/3939277

adding .git to the end of the URL will solve that, and also might fix the thing down below where you had to use .product

Thanks for a nice catch :)
Originally posted by @BenLeggiero in #23

When I try to install Badgy using Homebrew and following the steps on ReadMe, I got this error:

brew install badgy
Updating Homebrew...
Error: No available formula with the name "badgy"
==> Searching for a previously deleted formula (in the last month)...
Warning: homebrew/core is shallow clone. To get complete history run:
  git -C "$(brew --repo homebrew/core)" fetch --unshallow

Error: No previously deleted formula found.
==> Searching for similarly named formulae...
Error: No similarly named formulae found.
==> Searching taps...
==> Searching taps on GitHub...
Error: No formulae found in taps.

Open question, just wondering if the need to have ImageMagick as a dependency is actually needed? Also what benefits it introduces over going with the Core Image route.

Thank you for a great CLI application!

Add option to replace a specific icon set or png.

This will not output the files to folder ./Badgy and will override the icon set with images of the same sizes and names.

When I followed the installation instructions for SPM (Swift), it not worked as expected. I needed to run the followed commands to install it and enable it to be run from anywhere on the command line on my Mac:

$ swift build -c release
$ cd .build/release
$ cp -f badgy /usr/local/bin/badgy

Background

Both --color and --tint-color support hexadecimal colors (RRGGBB) but not its 3-character shorthand notation (RGB).

What to do

Adjust the argument validators to accept either 3 or 6-character hex code.
There is nothing to be done in Factory as ImageMagick already supports these.