chore: add codespace configuration (#5122)

This commit is contained in:
Michaël Vanderheyden 2025-02-16 08:34:18 +01:00 committed by GitHub
parent 1949e57c21
commit e9f679f96f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 31 additions and 1 deletions

View file

@ -0,0 +1,16 @@
{
"image": "mcr.microsoft.com/devcontainers/universal:2",
"features": {
"ghcr.io/devcontainers/features/rust:1": {
"version": "latest",
"profile": "complete",
"targets": "aarch64-unknown-linux-gnu"
},
"ghcr.io/guiyomh/features/just:0": {
"version": "latest"
}
},
"hostRequirements": {
"storage": "64gb"
}
}

View file

@ -58,6 +58,10 @@ Alternatively, you can use our official [CodeSandbox template](https://codesandb
## Getting Started
You can [work on the project locally](#local-development) by cloning the repository and installing the required tools or [use the pre-configured GitHub Codespaces](#github-codespaces) and jump right into the code.
### Local development
Building this project requires a `stable` Rust toolchain, which can be installed using [rustup](https://www.rust-lang.org/tools/install).
Clone the repository and navigate to the `tools` directory:
@ -74,7 +78,7 @@ You can use cargo to run Biome CLI in development mode:
cargo biome-cli-dev --help
```
## Install the required tools
#### Install the required tools
We use [Just](https://just.systems/man/en/) to run scripts and tasks, to make our life easier.
@ -102,6 +106,16 @@ You'll also need to have `pnpm` installed on your machine, and run `pnpm install
And you're good to go hack with Biome and Rust! 🚀
### GitHub Codespaces
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?machine=premiumLinux&repo=671654508&ref=main&skip_quickstart=true)
This Codespace comes pre-configured with the required tools and dependencies to work on the Biome project.
> [!NOTE]
> A basic Codespace (32gb of disk space) might run out of disk space when building biome or running the full test suite.
> The pre-configured Codespace is therefor based on the premium image with 64gb of disk space.
## Testing
You can either use `cargo` or `just` to run tests. For simplicity and running tests real quick, use `cargo`.