luckyframework / luckyframework/lucky_cli
If on macOS and PKGCONFIG_PATH is not set, fail during script/setup
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 92
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
On macOS you must set `export PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig` in your shell (usually`bashrc` or `zshrc`). People run into this and don't know what to do.
We should check for it when on macOS and raise if it is not set. Something like:
> Looks like OpenSSL is not set up for use with Crystal
>
> 1) Make sure OpenSSL is installed. Usually 'brew install openssl`
> 2) Set 'export PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig' in your shell. Usually this goes in '~/.bashrc' or '~/.zshrc'
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the script/setup entry point and reproduce the macOS setup with PKG_CONFIG_PATH unset. Check that setup raises the requested OpenSSL guidance, including installation and shell configuration steps, and verify the existing setup still works when the variable is set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal, macos
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100