Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pcattori/ocaml-cheatsheet
https://github.com/pcattori/ocaml-cheatsheet
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pcattori/ocaml-cheatsheet
- Owner: pcattori
- Created: 2024-01-15T22:22:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-02T18:10:58.000Z (12 months ago)
- Last Synced: 2024-11-08T19:12:08.739Z (2 months ago)
- Size: 1.95 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ocaml cheatsheet
Notes from when I went on [Dillon Mulroy's Twitch stream](https://www.twitch.tv/dmmulroy) to talk about [getting started with OCaml](https://www.youtube.com/watch?v=FtI5hxDcVKU).
## learning
The official ["Learn OCaml"](https://ocaml.org/docs) docs are always improving, but here are some other resources I found invaluable when starting out.
#### Tools & techniques
👉 [Real World OCaml](https://dev.realworldocaml.org/)
- [Command-line parsing](https://dev.realworldocaml.org/command-line-parsing.html)
- [Error handling](https://dev.realworldocaml.org/error-handling.html)
- [Maps and hash tables](https://dev.realworldocaml.org/maps-and-hashtables.html)
- [Serialization](https://dev.realworldocaml.org/data-serialization.html)
- [JSON](https://dev.realworldocaml.org/json.html)
- [Testing](https://dev.realworldocaml.org/testing.html)
#### Programming language design & theory
👉 [OCaml Programming: Correct + Efficient + Beautiful](https://cs3110.github.io/textbook/cover.html#)
- [Implementing an interpreter in OCaml](https://cs3110.github.io/textbook/chapters/interp/intro.html)
- [The Curry-Howard Correspondence](https://cs3110.github.io/textbook/chapters/adv/curry-howard.html)
## project setup
```sh
dune init proj
cd
opam switch create . --deps-only
```
Minimal `dune-project` for CLIs:
```lisp
(lang dune 3.11)
(generate_opam_files true)
(package
(name )
(depends ocaml dune))
```
#### git
Initialize a git repo:
```sh
git init
```
Then add a `.gitignore`:
```txt
_build/
_opam/
```
#### opam switch
Setup `opam` to auto-enable the switch when entering the directory:
```sh
opam init --enable-shell-hook
```
Or do this every time:
```sh
eval $(opam env)
```
#### dev dependencies
```sh
opam install ocaml-lsp-server odoc ocamlformat utop
```
## neovim
Do not do the `rtp` thing that `opam` suggests.
Instead, do this if using `lazy.nvim` as your package manager:
```lua
-- ~/.config/nvim/lua/plugins/ocaml.lua
return {
{
"nvim-treesitter/nvim-treesitter",
opts = {
ensure_installed = { "ocaml", "ocaml_interface" },
},
},
{
"neovim/nvim-lspconfig",
opts = {
servers = {
-- use local lsp installed within project's opam switch
ocamllsp = { mason = false },
},
},
},
}
```
[dmmulroy]: https://www.twitch.tv/dmmulroy
[getting-started-with-ocaml]: https://www.youtube.com/watch?v=FtI5hxDcVKU
[learn-ocaml]: https://ocaml.org/docs