JS_OF_OCAML(1)

📦
version 6.2.0 · 4 versions
, in ubuntu resolute

💖 JS_OF_OCAML 💖

okay bestie, welcome to the js_of_ocaml compiler page — this is the one from the Js_of_ocaml Manual, and it's literally about turning your OCaml bytecode into JavaScript. sit down, grab a boba, we're doing this 🧋✨

✨ NAME ✨

js_of_ocaml — the Js_of_ocaml compiler, aka your new bestie 💅

🦋 SYNOPSIS 🦋

js_of_ocaml [COMMAND] …

🌸 DESCRIPTION 🌸

Js_of_ocaml is a compiler from OCaml bytecode to Javascript. that's the whole vibe. it means you can take your pure OCaml programs and run them in JavaScript environments — think web browsers, think Node.js — no cap. 👑

💜 OPTIONS (TOPLEVEL) 💜

  • --export=VAL — a file holding the list of units to export in a toplevel, with Dynlink or with --linkall. if you don't give it, all units get exported. generous queen behavior fr fr.
  • --nocmis, --no-cmis — don't include cmis when compiling to toplevel. nope, not today. 🙈
  • --toplevel — compile a toplevel and embed the necessary cmis (unless you passed --no-cmis, obviously 💅). you can configure which compilation units get exported with --export. also heads up bestie: you'll also need to link against js_of_ocaml-toplevel.

🎀 OPTIONS (FILESYSTEM) 🎀

  • --extern-fs — configure the pseudo-filesystem so it allows registering files from outside. (this is the default, so it's already on unless you say otherwise)
  • --file=FILE — register FILE to the pseudo filesystem. get in there, file.
  • -I DIR — add DIR to the list of include directories.
  • --no-extern-fs — configure the pseudo-filesystem to NOT allow registering files from outside. boundaries, established.
  • --ofs=FILE — output the filesystem to FILE.

🔥 COMMANDS 🔥

  • build-fs [-I DIR] [-o FILE] [OPTION]… [FILES]… — the Js_of_ocaml pseudo filesystem utility ✨
  • build-runtime [OPTION]… [JS_FILES]… — build a standalone runtime. used for separate compilation, iykyk.
  • check-runtime [--target-env={isomorphic,browser,nodejs}] [OPTION]… [FILES]… — check runtime 👀
  • compile [OPTION]… [JS_FILES]… PROGRAM — the Js_of_ocaml compiler itself. main character energy.
  • link [OPTION]… [JS_FILES]… — the Js_of_ocaml linker 🔗
  • print-standard-runtime [OPTION]… — print the standard runtime to stdout

💅 ARGUMENTS 💅

  • JS_FILES — link JavaScript files JS_FILES. and okay this part is cute: you can refer to a path relative to Findlib packages using the syntax '+pkg_name/file.js'. obsessed.
  • PROGRAM (required) — compile the bytecode program PROGRAM. and if you're feeling quirky, use '-' to read from standard input instead.

🌈 OPTIONS 🌈

  • --custom-header=VAL — give your generated JavaScript file a custom header. super useful if you wanna make the script an executable file with #!/usr/bin/env node 💀
  • --debug=SECTION — enable debug for SECTION.
  • --debuginfo, --debug-info — output debug information.
  • --disable=OPT — disable the optimization OPT.
  • --dynlink — enable dynlink of bytecode files. use this if you wanna be able to use the Dynlink module. heads up tho: you'll also need to link with 'js_of_ocaml-compiler.dynlink'.
  • --effects=KIND — pick an implementation of effect handlers. KIND has to be one of cps, double-translation or disabled (which is the default). effects won't be supported if it's unspecified, so don't play games with this one bestie.
  • --empty-sourcemap, --empty-source-map — always generate empty source maps. iconic.
  • --enable=OPT — enable the optimization OPT.
  • --include-runtime — include the (partial) runtime when compiling cmo and cma files to JavaScript.
  • --keep-unit-names — keep the unit name 💖
  • --linkall — link all primitives and compilation units. exported compilation units can be configured with --export.
  • --load-shape=FILE — load the shape file FILE.
  • --no-sourcemap, --no-source-map — don't generate a source map. and lowkey, all other source map related flags will be ignored once you say this.
  • --noinline, --no-inline — disable inlining.
  • --noruntime, --no-runtime — do not include the standard runtime.
  • -o FILE — set the output file name to FILE.
  • --opt=NUM — set the optimization profile to NUM.
  • --pretty — pretty print the output ✨
  • -q, --quiet — suppress non-error messages. shhh 🤫
  • --set=PARAM=VALUE — set compiler options.
  • --setenv=PARAM=VALUE — set an environment variable statically.
  • --source-map-inline — inline the sourcemap in the generated JavaScript.
  • --source-map-no-source — do not inline sources in the source map.
  • --source-map-root=VAL — root dir for the source map.
  • --sourcemap, --source-map — generate a source map.
  • --target-env={isomorphic,browser,nodejs} (absent=isomorphic) — the runtime compile target.
  • -w WARN — enable or disable the warnings specified by the argument WARN.
  • --Werror — turn all warnings into errors. no warnings allowed, periodt. 💀
  • --wrap-with-fun=VAL (absent=<Immediately Invoked Function Expression>) — wrap the generated JavaScript code inside a function that needs to be applied with the global object.

💜 COMMON OPTIONS 💜

  • --help[=FMT] (default=auto) — show this help in format FMT. the value FMT must be one of auto, pager, groff or plain. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined. bestie behavior: just ask for help when you need it 🫶
  • --version — show version information.

⭐ EXIT STATUS ⭐

js_of_ocaml exits with:

  • 0 — on success 🎉 slay
  • 123 — on indiscriminate errors reported on standard error
  • 124 — on command line parsing errors
  • 125 — on unexpected internal errors (bugs) 😭

💀 BUGS 💀

bugs are tracked on github at https://github.com/ocsigen/js_of_ocaml/issues. go report them bestie, they wanna know.

🌈 SEE ALSO 🌈

ocaml(1)

👑 AUTHORS 👑

Jerome Vouillon, Hugo Heuzard. legends, fr fr.

🎀 LICENSE 🎀

Copyright (C) 2010-2020.

js_of_ocaml is free software, you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, with linking exception; either version 2.1 of the License, or (at your option) any later version. 🫶

okay that's the whole thing, you ate that 💅✨ this was Js_of_ocaml 6.2.0, from the JS_OF_OCAML(1) manual page — mwah, go compile something cute 🌸🦋

📦 where this page comes from