Crates.io | wargo |
lib.rs | wargo |
version | 0.4.1 |
source | src |
created_at | 2022-01-04 01:22:17.082238 |
updated_at | 2024-01-01 16:50:05.803638 |
description | cargo's evil twin to work with projects in the twilight zone of WSL2 |
homepage | https://github.com/asaaki/wargo |
repository | https://github.com/asaaki/wargo |
max_upload_size | |
id | 507472 |
size | 60,068 |
cargo's evil twin to work with projects in the twilight zone of WSL2
The gist of the issue is the following:
You work with both Windows and WSL2. Your repositories live on a NTFS partition. Therefore the compilation performance within WSL2 will suffer, because the files have to cross the VM/file system boundaries.
Slightly more elaborate background and reasoning can be found in my article on how to speed up Rust compilation.
One approach is to copy the files into a location within WSL which is a Linux based filesystem (like ext4) and do the compilation from there. Optionally you need to copy the artifacts back to the origin.
wargo
does that as a wrapper around cargo:
Currently it does this in a very simple and naive way; workspaces should work out of the box, but mostly I use single package projects. Also tweaks with the target folder may or may not work properly, the defaults are usually fine for me anyway.
There are some optional features possible, but current state is pretty complete for my personal use cases.
If you believe there is a feature missing or a tweak necessary, feel free to open a pull request or an issue.
cargo install wargo --locked
Add a basic Wargo.toml
to your project if you want to configure the behaviour.
The wargo wrapper does not accept any CLI arguments on its own, so a config file is the only option for now.
# Wargo.toml
# this is also the default
dest_base_dir = "~/tmp"
The file could be completely empty, but at least dest_base_dir
is good to specify.
Use either a location in your home dir (~
) or any other absolute path, which is not an NTFS file system.
See a complete and commented example here.
# instead of `cargo` just replace it with `wargo`:
wargo check
wargo build
wargo build --release
wargo run
# alternatively also callable as a cargo subcommand `wsl`:
cargo wsl build
This crate uses #![forbid(unsafe_code)]
to ensure everything is implemented in 100% Safe Rust.