From 7e1b1a1d856767b35677cced800abdf165fc4591 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Garci=CC=81a?= Date: Fri, 19 Apr 2024 17:08:34 +0200 Subject: [PATCH] Document developer tools --- README.md | 19 +++++++++++++++++++ crates/bitwarden-napi/Cargo.toml | 3 --- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1ef88b7d..6c639d052 100644 --- a/README.md +++ b/README.md @@ -140,5 +140,24 @@ VALUES ); ``` +## Developer tools + +This project recommends the use of certain developer tools, and also includes configurations for +them to make developers lives easier. The use of these tools is optional and they might require a +separate installation step. + +The list of developer tools is: + +- `Visual Studio Code`: We provide a recommended extension list which should show under the + `Extensions` tab when opening this project with the editor. We also offer a few launch settings + and tasks to build and run the SDK +- `bacon`: This is a CLI background code checker. We provide a configuration file with some of the + most common tasks to run (`check`, `clippy`, `test`, `doc` - run `bacon -l` to see them all). This + tool needs to be installed separately by running `cargo install bacon --locked`. +- `nexttest`: This is a new and faster test runner, capable of running tests in parallel and with a + much nicer output compared to `cargo test`. This tool needs to be installed separately by running + `cargo install cargo-nextest --locked`. It can be manually run using + `cargo nextest run --all-features` + [secrets-manager]: https://bitwarden.com/products/secrets-manager/ [bws-help]: https://bitwarden.com/help/secrets-manager-cli/ diff --git a/crates/bitwarden-napi/Cargo.toml b/crates/bitwarden-napi/Cargo.toml index 16853dbbf..7bcd54aad 100644 --- a/crates/bitwarden-napi/Cargo.toml +++ b/crates/bitwarden-napi/Cargo.toml @@ -29,8 +29,5 @@ napi-derive = "2" [build-dependencies] napi-build = "2.1.0" -[profile.release] -lto = true - [lints] workspace = true