https://github.com/idkjs/template-reason-library
https://github.com/idkjs/template-reason-library
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/idkjs/template-reason-library
- Owner: idkjs
- License: mit
- Created: 2021-01-19T13:14:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-19T13:15:50.000Z (over 4 years ago)
- Last Synced: 2025-02-04T16:51:13.258Z (5 months ago)
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `hello_world`
This is a Reason library.
## Template Init
There are two convenience scripts to initialize this repo:
- `scripts/rename hello_world my_library`
- This updates appropriate filenames and contents to use "my_library" as the name.
- Arguments should be snake_case, they will be converted to other forms where appropriate.
- `scripts/vscode`
- This sets up editor support for the [OCaml Platform](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform) extension by creating `.vscode/settings.json`.
- This can be done manually or inside VS Code, but I find this easier.
_Remove this section from the readme after completing the initialization._
## Install `esy`
Globally install [`esy`](https://www.npmjs.com/package/esy) so that the `esy`
command is available in the terminal.
```bash
npm install -g esy
```
_This may be useful: [Global npm without sudo](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md)_
## Install the dependencies and build
```bash
esy
```
_This is a combination of `esy install` and `esy build`_
## Run tests for `HelloWorld.re`
```bash
esy test
```
_This should automatically rebuild if there are changes_
## More Details
- For more details and additional setup see: [`details.md`](details.md)
- Editor support
- Adding dependencies
- Recursive dub-directories
- Ignoring warnings
- Printing stack traces
## Next Steps
For CI/CD, check out [`esy-ocaml/hello-reason`](https://github.com/esy-ocaml/hello-reason).