Skip to content

Build the project

Jump to bottom
Florian Daloze edited this page Dec 19, 2024 · 7 revisions

Build the project

  • clone the repository
    • To use Typeshed for default stubs, init submodules: git submodule init and git submodule update

Now, follow the steps according to the IDE you are using/building.

Server

// TODO Rust installation

Run cargo build to build the project in debug, and cargo build -r to build in release mode. If you want to launch the server from your command line, type cargo run -- --use-tcp. By adding the use-tcp argument, the server is available outside of an extension context (by default server is launched by vscode with stdio as input-ouput)

VsCode

Run npm install in vscode directory See vscode README to build the package.

Launch in debug mode

If you don't want to build the package but rather launch it in your vscode instance and use your debugger, follow the next steps. The project is designed to work in multi-root workspace.

  • To open the project, open a multi-root workspace and create 2 roots: the vscode directory and the server directory. This way you will have the server and the vscode extension opened and debuggable.
  • Go in the debug menu (ctrl-shif-D) and launch the wanted configuration:
  • Launch VsCode client: launch only vscode with the extension, but without the server. Useful for working on UI.
  • Launch Server: Launch only the server and make it wait for message on its local port.
  • server + client: Launch both of them, but as separated projects. It will be the same than launch the final vsix, except that the server is not launched by the client but by your debugging session. It means that any restart wanted by the client will crash (in case of configuration update). So if you want to select another configuration in debug mode, change your configuration and restart the project.

The other debug configuration are the tests. To run tests, you should start first by the "Test Setup" to ensure that your test setup is well configured, then you can launch any test you want. To setup test, you actually have to change the path to your odoo community at this line

Clone this wiki locally