CONTRIBUTING.md

Contributing

Setup

For development instruction see Authoring Zed Extensions.

Development

Install the required tools

We use Just to run scripts and tasks, to make our life easier.

You can install just using cargo:

cargo install just

But we **highly recommend ** to install it using an OS package manager, so you won't need to prefix every command with cargo.

Once installed, run the following command install the required tools:

just install-tools

1. Clone this repository.
2. Open Zed
3. Open the command palette Ctrl/⌘+⇧+P
4. Run the zed: install dev extensions command.
5. Select the directory of this repo.

If you make changes to the Rust code and you require to reload the extension, you can open the "Extensions" tab by running the command zed: extensions, choose the "Installed", seek the current extension and click the "Rebuild" label.

Custom biome binary

The binary used by the extension can be overriden in Zed settings.json using the lsp key:

// settings.json
{
  "lsp": {
    "biome": {
      "binary": {
        "path": "<path_to_biome_binary>",
        "arguments": ["lsp-proxy"]
      }
    }
  } 
}

Logs

Zed will print logs in the following directory: ~/Library/Logs/Zed/Zed.log