From d17b91ecc4e996703ad37219b2f6984294fa6132 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Vanderheyden?= Date: Fri, 14 Feb 2025 12:04:09 +0000 Subject: [PATCH 1/4] chore: add codespace configuration --- .devcontainer/devcontainer.json | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000000..b3d135c72c68 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -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" + } +} \ No newline at end of file From 4b786082ece4e71eb0d8c33334138ba68ab79d26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Vanderheyden?= Date: Fri, 14 Feb 2025 13:14:14 +0100 Subject: [PATCH 2/4] chore: add empty line at EOF --- .devcontainer/devcontainer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index b3d135c72c68..68d33fbf05f9 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -13,4 +13,4 @@ "hostRequirements": { "storage": "64gb" } -} \ No newline at end of file +} From 605711523f39b4a7637194ad008c19fc41adf05e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Vanderheyden?= Date: Fri, 14 Feb 2025 15:11:27 +0000 Subject: [PATCH 3/4] docs(contributing): add info about developing in codespaces --- CONTRIBUTING.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71c7b9922f89..efa0cda2f749 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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?hide_repo_select=true&machine=premiumLinux&repo=932201881&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`. From 90d6ff7f2e7b42c786616d3b5d38ea9c146efb24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Vanderheyden?= Date: Fri, 14 Feb 2025 15:15:39 +0000 Subject: [PATCH 4/4] docs(contributing): fix codespace creation url --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efa0cda2f749..aafdfe830b38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,7 +108,7 @@ 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?hide_repo_select=true&machine=premiumLinux&repo=932201881&ref=main&skip_quickstart=true) +[![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.