Skip to content

Commit b32079b

Browse files
committed
Add table of supported OCaml Platform tools
Signed-off-by: Riku Silvola <[email protected]>
1 parent 4454de7 commit b32079b

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

lib/main.mlx

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,70 @@ let getting_started ~install_url () =
6060
"$ dune pkg lock"
6161
"$ dune exec \"$PROJECT\""
6262
</Code>
63+
64+
<h3 class_="mt-10 mb-2.5">"Platform Tools"</h3>
65+
66+
<p>"OCaml Platform tools are supported out of the box without opam.
67+
They are automatically installed as dev dependencies, but for this to work
68+
you need to first run "<span class_="font-mono text-block-p">"dune pkg lock"</span>" on your project so that dune knows how to
69+
build the appropriate tools."
70+
<br/>
71+
</p>
72+
73+
<table class_="w-full pb-4 border-collapse border">
74+
<thead class_="font-normal border">
75+
<tr>
76+
<th class_="pl-2.5 lg:pl-14 py-2.5 border font-normal">"Tool"</th>
77+
<th class_="pl-2.5 py-2.5 border font-normal">"Status"</th>
78+
<th class_="pl-2.5 py-2.5 border font-normal">"Call"</th>
79+
<th class_="pl-2.5 py-2.5 border font-normal">"Notes"</th>
80+
</tr>
81+
</thead>
82+
<tbody>
83+
<tr class_="odd:bg-tertiary/10">
84+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"OCamlFormat"</span></td>
85+
<td class_="pl-2.5 py-2.5 border"><span class_="supported">"✅"</span></td>
86+
<td class_="pl-2.5 py-2.5 border"><span class_="font-mono text-block-p">"dune fmt"</span></td>
87+
<td class_="pl-2.5 py-2.5 border">"Use "<span class_="font-mono text-block-p">"dune tools exec ocamlformat"</span>" to call OCamlFormat directly"</td>
88+
</tr>
89+
<tr class_="odd:bg-tertiary/10">
90+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"OCaml-LSP"</span></td>
91+
<td class_="pl-2.5 py-2.5 border"><span class_="supported">"✅"</span></td>
92+
<td class_="pl-2.5 py-2.5 border"><span class_="font-mono text-block-p">"dune tools exec ocamllsp"</span></td>
93+
<td class_="pl-2.5 py-2.5 border">"Runs automatically (just configure your editor)"</td>
94+
</tr>
95+
<tr class_="odd:bg-tertiary/10">
96+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"Odoc"</span></td>
97+
<td class_="pl-2.5 py-2.5 border"><span class_="supported">"✅"</span></td>
98+
<td class_="pl-2.5 py-2.5 border"><span class_="font-mono text-block-p">"dune ocaml doc"</span></td>
99+
<td class_="pl-2.5 py-2.5 border">"After first run "<span class_="font-mono text-block-p">"dune build @doc"</span>" will also work"</td>
100+
</tr>
101+
<tr class_="odd:bg-tertiary/10">
102+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"utop"</span></td>
103+
<td class_="pl-2.5 py-2.5 border"><span class_="not-supported">"❌"</span></td>
104+
<td class_="pl-2.5 py-2.5 border"><span class_="font-mono text-block-p">"dune utop"</span></td>
105+
<td class_="pl-2.5 py-2.5 border"></td>
106+
</tr>
107+
<tr class_="odd:bg-tertiary/10">
108+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"dune-release"</span></td>
109+
<td class_="pl-2.5 py-2.5 border"><span class_="not-supported">"❌"</span></td>
110+
<td class_="pl-2.5 py-2.5 border"><span class_="font-mono text-block-p">"dune release"</span></td>
111+
<td class_="pl-2.5 py-2.5 border"></td>
112+
</tr>
113+
<tr class_="odd:bg-tertiary/10">
114+
<td class_="pl-2.5 lg:pl-14 py-2.5 border"><span class_="font-mono text-block-p">"ocamlfind"</span></td>
115+
<td class_="pl-2.5 py-2.5 border"><span class_="not-supported">"❌"</span></td>
116+
<td class_="pl-2.5 py-2.5 border"></td>
117+
<td class_="pl-2.5 py-2.5 border"></td>
118+
</tr>
119+
</tbody>
120+
</table>
121+
122+
<p>
123+
<br/>"A global opam switch may interfere with the functioning of the developer preview.
124+
To clean the environment, you may want to create an empty global switch and work from it.
125+
This you can do with "<span class_="font-mono text-block-p">"opam switch create my-empty-switch --empty && eval $(opam env --switch=my-empty-switch --set-switch)"</span>"."</p>
126+
63127
<h3 class_="mt-10 mb-2.5">"Editor Configuration"</h3>
64128
<p>
65129
"Here is how to configure some popular editors for OCaml using the Dune Developer Preview. Note that it is unnecessary to install "

0 commit comments

Comments
 (0)