Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#320)
Browse files Browse the repository at this point in the history
  • Loading branch information
piotmag769 authored Feb 19, 2025
1 parent c826905 commit a7e49fb
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,23 @@ error.
In Visual Studio Code you will find this output in the `Output``Cairo Language Server` panel.
We're not copying these here because nobody will bother keeping this document in sync.

### Custom commands

Special commands for developers are available via Visual Studio Code [Command Palette][command-palette].
These include:
- Cairo: View currently analyzed crates
- Cairo: View syntax tree of the current file content

To make the best use of these add the following variable to `"cairo1.languageServerExtraEnv"`
section in `.vscode/settings.json`:
```json
{
"cairo1.languageServerExtraEnv": {
"CLICOLOR_FORCE": "1"
}
}
```

### Use tests

If you find a short reproduction of your problem, we strongly suggest writing an E2E test and
Expand Down Expand Up @@ -131,3 +148,4 @@ Thanks! ❤️ ❤️ ❤️
CairoLS Team

[env-filter-directives]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
[command-palette]: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette

0 comments on commit a7e49fb

Please sign in to comment.