Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.43 KB
Raw

If you have any trobubles with these instructions at all, please create a GitHub issue!

Building from source

Dependencies

Firstly, the build system was only tested on Linux. Using Windows Subsystem for Linux or MacOS may also work, but who knows. The built extension is cross-platform no matter where you're compiling.

You will need the Rust programming language installed, installed using the official rustup Rust installer. This extension relies on nightly features, so e.g. Ubuntu packages will not work.

To just run the extensions, VS Code needs to be installed so that code command works. Aside from that, if you want to build a .vsix, then stuff for VS Code extension build system is also required. Install a relatively recent version of node and npm(node 4.x does not work, node 8.x does), which may not be available e.g. in official Ubuntu 16.04 packages. After that, install vsce with sudo npm install -g vsce.

Building

Clone the repository and run BUILDSH_RELEASE=1 ./build.sh package. The built .vsix can be found in target/evscode directory. In VS Code, go to Extensions and use "Install from VSIX..." option.

Development

In order to launch a debug build, run ./build.sh run. To quickly check if your changes compile, run cargo check.

Most of the logic resides in the src/ directory/. The exceptions are network interactions and VS Code interactions, which live respectively in the unijudge*/ and evscode*/ directory families. Inside src/, adding new commands or config options will be registered automatically.

To see Rust VS Code API docs, run cargo doc --open -p evscode. If you want to use a part of the official API that's not supported yet, then you need to add the JS FFI declarations to vscode-sys/ and a Rust wrapper in evscode/. This may be challenging, so feel free to ask me for help with this(or any other!) part.

To add support for other competitive programming sites, add a new unijudge-something/ directory and fill it with code similar to unijudge-spoj. After that, add its metadata to src/net.rs and Cargo.toml, and ICIE will start using it.

To add your changes back to the plugin, open a pull request.