Skip to content

Commit

Permalink
Document developer tools
Browse files Browse the repository at this point in the history
  • Loading branch information
dani-garcia committed Apr 19, 2024
1 parent dfe067e commit 7e1b1a1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
3 changes: 0 additions & 3 deletions crates/bitwarden-napi/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,5 @@ napi-derive = "2"
[build-dependencies]
napi-build = "2.1.0"

[profile.release]
lto = true

[lints]
workspace = true

0 comments on commit 7e1b1a1

Please sign in to comment.