Oni2 can be built from source using the following setup and steps! This takes around 30-40 mins on an "average" machine, as we need to setup a brand newset of tooling for both OCaml and Skia, which are both fairly large. Repeat buildsshould take only a few seconds, as build artifacts are cached by When performing a non-Docker based install, you'll need the following dependencies onall platforms. There are additional platform specific dependencies linked below. NOTE: Linux-only: if you need to install using All platforms require No additional requirements. Requires Some Linux distributions may need other packages: The docker build path is the most contained path, and as such may be the easiest way onsome Linux distributions. We include a Dockerfile in The steps to use it are as follows: NOTE: The non-standard NOTE: The NOTE: On Windows, you must build from a shell running as administrator. This is a requirement of esy because creating symlinks requires administrator permissions. More info at esy/esy#389. NOTE: On macOS, if you receive an The We use auto formatting tool, you might want to run it before you commit changes NOTE: On macOS, checkhealth may report that a library is not loaded (e.g. Sparkle). This is normal. To check that libraries are loaded in a generated release build, see the section on macOS below. To create a release build, run: This will create a With the exception of macOS, these are actually symbolic links to To create an installation package for Windows, run the following PowerShell script: When building a release on newer versions of macOS, checkhealth will report that some libraries are not loaded. This is because the libraries are not accessible until the app is fully built and can be ignored. To check that the libraries are in fact included in a generated release build, you can run the following command from the You can also install Oni2 in your Run the following from the If you want to open the editor from the terminal with an If you want to develop, or debug, an extension integration, the following tips may help: There is a development extension in To add logging, use Both the oni-dev-extension and any other extension can be instrumented, as they're usually included in non-minified form. If there's a problem in-between Oni2 and the extension, it can be helpful to build and instrument your own copy of the extension host. You can use the You can use the For example, adding the logging here (the Results in this debug logging: The extension host protocol is defined in extHost.protocol.ts. Interfaces prefixed with From the esy.Prerequisites
npm install -g esy@latest)sudo npm install -g esy@latest then your NPM installation might be broken follow the instruction here to fix it this is related to this issue esy/esy#1099.npm install -g windows-build-tools (this installs some build tools that aren't included by default on Windows)Dependencies
git, node and esy, and anything outlined in the revery docs:https://github.com/revery-ui/revery/wiki/Building-&-Installing.Windows
macOS
libtool and gettext from homebrew: brew install libtool gettext.Linux
nasm,libacl1-dev, libncurses-dev latter two for libvim.libXt-devel, libSM-devel, libICE-devel, libacl-devel and ncurses-devel for libvimlibglu1-mesa-dev, libxxf86vm-dev and libxkbfile-dev.Docker build (Linux)
scripts/docker/centos that we usefor all our CI builds, so it should be up-to-date! This will produce an AppImage andtar.gz both suitable for Linux. Containers are not provided for other distributions(we only need this one), but should serve as a good base if specific changes are needed.# Clone the Oni2 repogit clone https://github.com/onivim/oni2cd oni2# Use our included script to setup a docker containerdocker build --network=host -t centos scripts/docker/centos# Now use that container to actually build an Oni2 AppImage.# Bind the Oni2 folder to the volume so that it can access the source.# We also bind ~/.esy such that the build steps are cached locally.# This means subsequent builds are fast.# You can clean that folder out to save space at the cost of build time for future# builds.docker container run --rm \ --name centos \ --network=host \ --volume `pwd`:/oni2 \ --volume ~/.esy:/esy/store \ --cap-add SYS_ADMIN \ --device /dev/fuse \ --security-opt apparmor:unconfined \ centos \ /bin/bash -c 'cd oni2 && ./scripts/docker-build.sh'# Wait 30-40 minutes on an average machine...# This takes up to about an hour on CI though, so may be worth# leaving for a bit!# During the initial esy steps, there isn't much output, so you# may end up waiting on `info fetching: done`. It will eventually# finish the initial install and move on to building, which has output.# Done!# This should drop an AppImage binary off in _release in the Oni2# folder.# You can run a health check if you would like..._release/Onivim2.AppDir/usr/bin/Oni2 -f --no-log-colors --checkhealthBuild and Run from Source
Clone repository
git clone https://github.com/onivim/oni2cd oni2Install node dependencies
npm install -g node-gypnode-gyp install 14.15.4node install-node-deps.jsnode install-node-deps.js step instead of npm install is necessary because the script picks up our vendored node binary.node install-node-deps.js command will need to be re-run whenever the extension host is upgraded.Build the front-end
error: Too many open files, you can run ulimit -Sn 4096 to increase the file limit. More info at esy/esy#1057# Install dependencies in package.jsonesy install# Builds most dependencies and run Oni2 specific bootstrapping.# Takes upwards of 30 mins on a normal machine.# esy does intelligently cache to ~/.esy, subsequent builds are fast.esy bootstrap# Finish up remaining parts of building. Should be quick.esy buildRun health-check
--checkhealth argument validates all dependencies are available and working.esy run -f --checkhealthRun Onivim 2
esy runTests
esy '@test' installesy '@test' buildesy '@test' runInline Unit Tests
esy '@test' inlineCheck build
esy build dune build @checkBenchmarks
esy '@bench' installesy '@bench' buildesy '@bench' runFormat code
esy formatRelease
esy '@release' run -f --checkhealthesy '@release' installesy '@release' run --helpesy '@release' create_esy/release folder at the root with the application bundle inside that folder there will be folders for built binaries, in _esy/release/install/bin the Oni2 binary resides along Oni2_editor.oni2/_esy/release/store/b/oni2-<hashvalue>/install/default/bin/Oni2, the same is true for the Oni2_editor binary. On macOS, the symlinks are replaced with the actual binaries.Windows
./scripts/windows/publish.ps1macOS
oni2 directory:./_release/Onivim2.app/Contents/MacOS/Oni2 -f --checkhealthApplications folder.oni2 directory:cp -R _release/Onivim2.app /Applicationsoni2 command, you can add Oni2 to the system PATH using a commandfrom within the app:Cmd + Shift + PSystem: Add Oni2 to System PATHExtension Integration
Testing with oni-dev-extenion
src/development_extensions/oni-dev-extension which can be used to implement dummy functionality that is often easier to test and integrate with than real extensions.Resources
Instrumenting extensions
console.error - messages on stderr will be shown in Onivim's log. (Make sure to turn debug logging on, via ONI2_DEBUG=1 environment variable or the --debug command-line arg).Extension host
Building
cd ~ on Linux / macOS, or cd / on Windows)git clone https://github.com/onivim/vscode-exthostcd vscode-exthostyarn installyarn compileyarn watch command too - this is useful for iterating quickly!Testing
ONI2_EXTHOST environment variable to override the default extension host with your local extension host:$executeContributedCommand proxy method)
Protocol
MainThread refer to messages sent from the extension host to the "main thread", which in our case is Oni2. While interfaces prefixed with ExtHost refer to messages sent to the extension host.oni2 directory:cd docs/websitenpm installnpm start
