JS_OF_OCAML-BUILD-RUNTIME(1)

📦
version 6.2.0 · 4 versions
, in ubuntu resolute

✨ JS_OF_OCAML-BUILD-RUNTIME ✨

okay bestie, welcome to the js_of_ocaml-build-runtime page from the Js_of_ocaml Manual 💅 this one's all about building the standalone runtime — it's the whole point when you're doing separate compilation. sit down, grab a strawberry 🍓, let's go.

🌸 NAME 🌸

js_of_ocaml-build-runtime — build the standalone runtime. it's used for separate compilation, no cap.

🦋 SYNOPSIS 🦋

js_of_ocaml build-runtime [OPTION]… [JS_FILES]…

💖 DESCRIPTION 💖

Js_of_ocaml is a compiler that takes OCaml bytecode and turns it into JavaScript. it's giving translator, it's giving glow-up 🧚 and the way it works means you can literally run pure OCaml programs inside JavaScript environments — think web browsers, think Node.js. iconic behavior honestly.

🎀 OPTIONS (TOPLEVEL) 🎀

  • --nocmis, --no-cmis — do not include cmis when compiling toplevel. that's it, that's the whole vibe.
  • --toplevel — compile a toplevel and embed the necessary cmis (unless you passed --no-cmis, in which case, no cmis, we respect it). you can configure which exported compilation units go in with --export. heads up though: 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, bestie, it's already on ✨
  • --file=FILE — register [FILE] into the pseudo-filesystem.
  • -I DIR — add [DIR] to the list of include directories.
  • --no-extern-fs — configure the pseudo-filesystem to NOT allow registering files from outside. the opposite vibe entirely.
  • --ofs=FILE — output the filesystem to [FILE].

💜 ARGUMENTS 💜

  • JS_FILES — link JavaScript files [JS_FILES]. and here's a lil trick you're gonna love: you can refer to a path relative to Findlib packages using the syntax '+pkg_name/file.js' 😌 iykyk.

⭐ OPTIONS ⭐

  • --custom-header=VAL — give the generated JavaScript file a custom header. super useful if you want to 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 optimization [OPT].
  • --effects=KIND — pick an implementation of effect handlers. [KIND] has to be one of cps, double-translation, or disabled (which is the default). and fr fr: effects will not be supported if you leave this unspecified 🫠
  • --empty-sourcemap, --empty-source-map — always generate empty source maps.
  • --enable=OPT — enable optimization [OPT].
  • --no-sourcemap, --no-source-map — don't generate a source map. and just so you know: every other source-map-related flag gets ignored once you use this one. it's giving main character, it overrides everything 💅
  • --noinline, --no-inline — disable inlining.
  • --noruntime, --no-runtime — do not include the standard runtime.
  • -o FILE (required) — set the output file name to [FILE]. it's required bestie, you can't skip it 😭
  • --pretty — pretty print the output. aesthetic ✨
  • -q, --quiet — suppress non-error messages. silence, but make it chic.
  • --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. defaults to isomorphic if you don't say anything.
  • -w WARN — enable or disable the warnings specified by the argument [WARN].
  • --Werror — turn all warnings into errors. dramatic? yes. effective? also yes 💀
  • --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 of 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.
  • --version — show version information.

💀 EXIT STATUS 💀

js_of_ocaml build-runtime exits with:

  • 0 — on success 🎉
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs). not the cute kind of bug, the bad kind 🙈

🐛 BUGS 🐛

bugs are tracked on github at https://github.com/ocsigen/js_of_ocaml/issues. go tell them, they'll handle it 🫶

👀 SEE ALSO 👀

👑 AUTHORS 👑

Jerome Vouillon, Hugo Heuzard. absolute legends, we stan 🌟

📜 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.

and that's the whole page, bestie 🎀 this was Js_of_ocaml version 6.2.0, section JS_OF_OCAML-BUILD-RUNTIME(1) — slay, go build that runtime, you got this 💖✨

📦 where this page comes from