https://github.com/ManasJayanth/esy-libffi
https://github.com/ManasJayanth/esy-libffi
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ManasJayanth/esy-libffi
- Owner: ManasJayanth
- Created: 2021-02-07T06:04:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T09:57:39.000Z (about 1 year ago)
- Last Synced: 2025-04-01T23:51:52.208Z (10 months ago)
- Language: JavaScript
- Size: 24.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- awesome-list - esy-libffi
README
[](https://github.com/ManasJayanth/esy-libffi/actions/workflows/workflow.yml)
# esy-libffi
`esy-libffi` is sample package, [`libffi`](https://github.com/esy/test-hello-c), packaged for [`esy`](https://esy.sh/).
## Why
`esy` can not only fetch and install Reason and OCaml libraries and tools,
but also those written in C. This extends reproducibility benefits to
packages written in C, like `skia`, `libffi`, `pkg-config`
etc. Users don't have to install them separately, nor have to worry if
they have installed the correct version. Read more at the docs about
[benefits for opting for esy packages](https://esy.sh#TODO).
## How to use `esy-libffi`?
`esy-libffi` can be used from both NPM and directly from Github.
### From NPM
`esy-libffi` is deployed on NPM can be found
[here](https://www.npmjs.com/package/TODO).
You can simply run `esy add esy-libffi` to install it, or specify it in
`package.json` and run `esy`.
```diff
{
"dependencies": {
+ "esy-libffi": "*"
}
}
```
### Directly from Github
```json
{
"dependencies": {
"esy-libffi": "esy-packages/esy-libffi"
}
}
```
i.e. `/`
To use a specific commit,
```diff
"dependencies": {
+ "esy-libffi": "esy-packages/esy-libffi#"
}
```
## How to package for esy?
### For the experienced
**The gist**
Specify the configure and build commands in `esy.build` property of
`esy.json` and the install step in `esy.install`. If the package
builds "in source", set `esy.buildsInSource` property to `true`. Use
`$cur__install` environment variable to set the install location.
See [docs](TODO) for reference.
The CI will take care of fetching the sources and creating an NPM
package for you. See [script.js](TODO) to see how it works.
You can download it or auto publish via CI.
### For beginners
> Note: you'll need Node.js for this tutorial. If you're experienced
> with bash, you can use it instead.
Fundamentally, packaging for esy works like in other Linux distros,
except ofcourse, such that packages become available on MacOS and
Windows too.
You would typically have to specify the instructions to build the
package in the `esy.json`. For example, everyone's favourite http
tool, [curl](https://curl.se/), needs the following instructions ([as
described on their website](https://curl.se/docs/install.html))
```sh
./configure
make
make install
```
Many packages have similar instructions!
Configure and build steps are specified in the `esy.build` property in
the `esy.json` and install steps in `esy.install`. Example,
```json
{
"esy": {
"build": [
"./configure",
"make"
],
"install": [
"make install"
]
}
}
```
## Testing and making sure the package works as expected
To test if the package works, we recommend an end-to-end test by
publishing it to local
[`verdaccio`](https://github.com/verdaccio/verdaccio), and using the
package with a `package.json` or `esy.json` depends on it.
```json
{
"dependencies": {
esy-libffi": "*"
}
}
```
And pointing `esy` to the local npm registry
```sh
esy i --npm-registry http://localhost:4873
esy b
```
If the package is a library, it's a good idea to write a small program
to actually check if the library works. Referring how the
corresponding package is being tested in Homebrew or Arch Linux.
Checkout [ci-test.sh](./ci-test.sh) for reference, used on the CI.