Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

scarb check docs #1099

Merged
merged 5 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ Scarb is under active development! Expect a lot of new features to appear soon!
- [x] Nightlies
- [x] `Scarb.lock`
- [x] `scarb update`
- [x] `scarb check`
- [ ] Standardized `test` target 🏗️
- [ ] Package registry 🏗️
- [ ] PubGrub implementation for version resolution
- [ ] Dynamic loading of custom Cairo compiler plugins as Scarb packages 🏗️
- [ ] Dynamic loading of custom targets aka code generators
- [ ] `scarb check` 🏗️
- [ ] Dependency overrides
- [ ] Signing & notarization of Windows & macOS binaries
- [ ] `scarb doc`
Expand Down
4 changes: 4 additions & 0 deletions website/docs/cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Built Sierra code of this package will be written to `target/dev` directory.
> [!TIP]
> `scarb clean` cleans `target` directory.

<!-- prettier-ignore -->
> [!TIP]
> `scarb check` checks for errors without compiling the packages.

### Building CASM

Add following to `Scarb.toml`:
Expand Down
17 changes: 17 additions & 0 deletions website/docs/guides/working-on-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,20 @@ $ scarb build
```

This will fetch all the dependencies and then build them, along with the package.

You might want to simply check the package and all of its dependencies for errors without performing the final step of output files generation.
Instead of `scarb build`, you can use a bit faster command - `scarb check`:

```shell
$ scarb check
Checking alexandria_ascii v0.1.0 (/path/to/package/alexandria/src/ascii/Scarb.toml)
Checking alexandria_data_structures v0.1.0 (/path/to/package/alexandria/src/data_structures/Scarb.toml)
Checking alexandria_encoding v0.1.0 (/path/to/package/alexandria/src/encoding/Scarb.toml)
Checking alexandria_linalg v0.1.0 (/path/to/package/alexandria/src/linalg/Scarb.toml)
Checking alexandria_math v0.2.0 (/path/to/package/alexandria/src/math/Scarb.toml)
Checking alexandria_numeric v0.1.0 (/path/to/package/alexandria/src/numeric/Scarb.toml)
Checking alexandria_searching v0.1.0 (/path/to/package/alexandria/src/searching/Scarb.toml)
Checking alexandria_sorting v0.1.0 (/path/to/package/alexandria/src/sorting/Scarb.toml)
Checking alexandria_storage v0.2.0 (/path/to/package/alexandria/src/storage/Scarb.toml)
Finished checking release target(s) in 4 seconds
```