@monodon/rust

A Nx plugin that adds support for Cargo and Rust in your Nx workspace.

Compatibility Chart

|@monodon/rust|nx|
|---|---
|<=1.2.1|<=17.1.0|
|>=1.3.0|>=17.1.0|

Getting Started

$3

The following tools need to be installed on your system to take full advantage of @monodon/rust
* Node (LTS)
* Rust / Cargo via https://rustup.rs

$3

To bootstrap a new workspace with @monodon/rust installed and ready, run:

``shell
npx create-nx-workspace --preset=@monodon/rust
`

$3

Use your favourite package manager to install in your project:

`shell
yarn add -D @monodon/rust
`

`shell
npm install -D @monodon/rust
`

`shell
pnpm add -D @monodon/rust
`

#### Initialization

After installing, you can run any of the project generators (binary, library) to have @monodon/rust set up Cargo in your workspace.

Generators

Use Nx Console to see the full list of options for each generator.

$3

Creates a Rust binary application to be run independently.

> Create a new binary:
> `shell
> nx generate @monodon/rust:binary my-rust-app
> `

$3

Creates a Rust library that can be used in binaries, or compiled to be used for napi.

> Create a new library:
> `shell
> nx generate @monodon/rust:library my-rust-lib
> `

> Create a new library with napi:
> `shell
> nx generate @monodon/rust:library my-rust-node-lib --napi
> `

#### Napi
Generating a library with the --napi flag will set up the project to be built with it.

Executors


All the executors support these additional properties:
* toolchain: (e.g. --toolchain='stable' | 'beta' | 'nightly');
* Uses stable by default
* target (e.g. --target=aarch64-apple-darwin);
* profile (e.g. --profile=dev)
* Cargo profiles
* release
* target-dir
* features (e.g. --features=bmp)
* Cargo features
* all-features
* args
* Arguments forwarding to the executor.

$3

Runs cargo to build the project
> Not supported with napi

$3

Runs cargo clippy to lint the project

$3

Runs the napi cli to build the project

$3

Runs cargo run for the project
> Not supported with napi

$3

Runs cargo test` for the project