From a7e49fbb3b71117484ee9e524dd8dba2a0254314 Mon Sep 17 00:00:00 2001 From: Piotr Magiera <56825108+piotmag769@users.noreply.github.com> Date: Wed, 19 Feb 2025 11:28:57 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#320) --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f01b4533..89d4e8df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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