https://github.com/flaque/useslib
A Cyrstal macro for testing if a user has a C dep installed
https://github.com/flaque/useslib
Last synced: 2 months ago
JSON representation
A Cyrstal macro for testing if a user has a C dep installed
- Host: GitHub
- URL: https://github.com/flaque/useslib
- Owner: Flaque
- License: mit
- Created: 2018-05-31T20:17:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T20:26:05.000Z (almost 7 years ago)
- Last Synced: 2025-01-20T10:13:49.590Z (4 months ago)
- Language: Crystal
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# useslib
`useslib` is a litle macro for checking if a user
has a C dependency installed. It's a way for c-binding authors to alert their users that they need to have some dependencies installed without giving them difficult to understand compiler errors.
If the user has the item, then compilation will work like normal. If they don't, the project will throw a normal crystal compiler error with a message like this:
```
❯ crystal run src/useslib.cr
Error in src/useslib.cr:14: Unable to find c library 'fuzzboing' on your system. Are you sure you installed it?
useslib fuzzboing
^~~~~~~
```
Without `useslib`, a `@[Lib("imagemagick")]` call will throw an error like this:
```
ld: library not found for -lMagickWand
clang: error: linker command failed with exit code 1 (use -v to see invocation)
Error: execution of command failed with code: 1: `cc "${@}" -o '/Users/flaque/.cache/c
rystal/crystal-run-webimg.tmp' -rdynamic -lMagickWand -lpcre -lgc -lpthread /usr/loc
al/Cellar/crystal-lang/0.24.2_1/src/ext/libcrystal.a -levent -liconv -ldl -L/usr/lib -
L/usr/local/lib`
```
That's a lot harder to figure out.
## Warning
`pkg-config` probably won't work on every system and I've only tested it so far on macOS. It's probably not a good idea to use this for everything. If you find issues with the project on other OS's please let me know.
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
useslib:
github: flaque/useslib
```
## Usage
Just put `useslib someLibrary` at the top of your file.
```crystal
require "useslib"
useslib imagemagick
puts "this code will only get to the compiler if imagemagick is installed"
```
## Contributing
1. Fork it ( https://github.com/flaque/useslib/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [flaque](https://github.com/flaque) Flaque - creator, maintainer