@@ -52,22 +52,21 @@ You can also browse the latest published documentation:
52
52
The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates
53
53
are:
54
54
55
- - [ ` bitwarden-api-api ` ] ( ./crates/bitwarden-api-api/ ) : Auto-generated API bindings for the API
55
+ - [ ` bitwarden-api-api ` ] ( ./crates/bitwarden-api-api ) : Auto-generated API bindings for the API
56
56
server.
57
- - [ ` bitwarden-api-identity ` ] ( ./crates/bitwarden-api-identity/ ) : Auto-generated API bindings for the
57
+ - [ ` bitwarden-api-identity ` ] ( ./crates/bitwarden-api-identity ) : Auto-generated API bindings for the
58
58
Identity server.
59
- - [ ` bitwarden-core ` ] ( ./crates/bitwarden-core/ ) : The core functionality consumed by the other crates.
60
- - [ ` bitwarden-crypto ` ] ( ./crates/bitwarden-crypto/ ) : Crypto library.
61
- - [ ` bitwarden-wasm-internal ` ] ( ./crates/bitwarden-wasm-internal/ ) : WASM bindings for the internal
59
+ - [ ` bitwarden-core ` ] ( ./crates/bitwarden-core ) : The core functionality consumed by the other crates.
60
+ - [ ` bitwarden-crypto ` ] ( ./crates/bitwarden-crypto ) : Crypto library.
61
+ - [ ` bitwarden-wasm-internal ` ] ( ./crates/bitwarden-wasm-internal ) : WASM bindings for the internal
62
62
SDK.
63
- - [ ` bitwarden-uniffi ` ] ( ./crates/bitwarden-uniffi/ ) : Mobile bindings for swift and kotlin using
63
+ - [ ` bitwarden-uniffi ` ] ( ./crates/bitwarden-uniffi ) : Mobile bindings for swift and kotlin using
64
64
[ UniFFI] ( https://github.com/mozilla/uniffi-rs/ ) .
65
65
66
66
## API Bindings
67
67
68
- We autogenerate the server bindings using
69
- [ openapi-generator] ( https://github.com/OpenAPITools/openapi-generator ) . To do this we first need to
70
- build the internal swagger documentation.
68
+ We autogenerate the server bindings using[ openapi-generator] ( https://github.com/OpenAPITools/openapi-generator ) .
69
+ To do this, we first need to build the internal swagger documentation.
71
70
72
71
### Swagger generation
73
72
@@ -83,14 +82,14 @@ ASPNETCORE_ENVIRONMENT=development dotnet swagger tofile --output ../../identity
83
82
84
83
### OpenApi Generator
85
84
86
- To generate a new version of the bindings run the following script from the root of the SDK project.
85
+ To generate a new version of the bindings, run the following script from the root of the SDK project.
87
86
88
87
``` bash
89
88
./support/build-api.sh
90
89
```
91
90
92
- This project uses customized templates which lives in the ` support/openapi-templates ` directory.
93
- These templates resolves some outstanding issues we've experienced with the rust generator. But we
91
+ This project uses customized templates that live in the ` support/openapi-templates ` directory.
92
+ These templates resolve some outstanding issues we've experienced with the rust generator. But we
94
93
strive towards modifying the templates as little as possible to ease future upgrades.
95
94
96
95
### Note
@@ -102,8 +101,8 @@ strive towards modifying the templates as little as possible to ease future upgr
102
101
103
102
## Developer tools
104
103
105
- This project recommends the use of certain developer tools, and also includes configurations for
106
- them to make developers lives easier. The use of these tools is optional and they might require a
104
+ This project recommends the use of certain developer tools and includes configurations for
105
+ them to make developers' lives easier. The use of these tools is optional, and they might require a
107
106
separate installation step.
108
107
109
108
The list of developer tools is:
@@ -122,12 +121,12 @@ The list of developer tools is:
122
121
## Formatting & Linting
123
122
124
123
This repository uses various tools to check formatting and linting before it's merged. It's
125
- recommended to run the checks prior to submitting a PR.
124
+ recommended to run the checks before submitting a PR.
126
125
127
126
### Installation
128
127
129
- Please see the [ lint.yml] ( ./.github/workflows/lint.yml ) file for example installation commands &
130
- versions. Here are the cli tools we use:
128
+ Please see the [ lint.yml] ( ./.github/workflows/lint.yml ) file, for example, installation commands and versions. Here are the
129
+ cli tools we use:
131
130
132
131
- Nightly [ cargo fmt] ( https://github.com/rust-lang/rustfmt ) and
133
132
[ cargo udeps] ( https://github.com/est31/cargo-udeps )
0 commit comments