Skip to content

Latest commit

 

History

History
112 lines (88 loc) · 4.46 KB

README.md

File metadata and controls

112 lines (88 loc) · 4.46 KB
Raw

Cairo for Visual Studio Code

This extension provides support for the Cairo programming language. Cairo is the first Turing-complete language for creating provable programs for general computation.

Cairo Language Server is alpha-grade software. Things are moving rapidly. Expect bugs and crashes from time to time.

Features

  • code completion with imports insertion
  • automatic, incremental analysis
  • diagnostic reporting of build warnings and errors
  • go to definition
  • semantic syntax highlighting
  • documentation lookup on hover
  • function signature provider
  • code formatter
  • supports Scarb, the Cairo package manager
  • can be configured to use Dojo Engine-specific tooling

Quick start

Gm! 👋

Whether you are new to Cairo or an experienced Cairo Pharaoh, we hope you will find this extension fitting your needs and making your Cairo development experience more enjoyable.

  1. Install latest Scarb, preferably via asdf.
  2. Install the VS Code Cairo extension.
  3. Open a workspace containing Scarb.toml or just open any Cairo file to automatically activate the extension.
  4. The extension depends on the Cairo Language Server, which comes bundled with Scarb. The version of Scarb used in the workspace determines the version of Cairo and Cairo Language Server used by the extension.

Happy coding!

Configuration

This extension can be configured through VS Code's configuration settings. All settings are under the cairo1.* section. Consult the settings UI in VS Code for more documentation.

Support

For questions or inquiries about Cairo, Cairo Language Server and this extension, reach out to us on Telegram or Discord.

Troubleshooting

If you run into issues with the extension, try these debugging steps:

  1. Make sure you have the latest version of the extension installed.
  2. Make sure you have the latest version of Scarb installed.
  3. Make sure the problem is also not appearing while running scarb build.
  4. Try the latest nightly release of Scarb, to verify the bug is not fixed yet. This is simple to do with asdf: 
    asdf install scarb latest:nightly
asdf local scarb latest:nightly
    And restart VS Code.
  5. Check out debug logs for hints on what could go wrong.

In normal operation mode, both this extension and Cairo Language Server are pretty silent in their logs. Logs are emitted to the Output panel in VS Code.

You can enable debug logging to learn more about what's going on. By default, the extension is trying to start the language server with the same logging level as the extension is running itself. To change the logging level, do the following:

  1. Open the Command Palette (F1 or Ctrl+Shift+P).
  2. Run the >Developer: Set Log Level... command
  3. Find the Cairo extension on the list.
  4. Choose the Debug level.
  5. Restart VS Code, by running the >Developer: Reload Window command.

When sending logs to developers to debug, please include full logs from both the extension and the language server. If you feel brave enough, you can try some of the more advanced debugging techniques described in CairoLS contribution guidelines.

Submitting bugs/issues

If you have a problem that you think should be fixed, please follow steps below:

  1. Submit a new bug issue
  2. Choose ide label
  3. Fill out the issue template
  4. Attach all relevant screenshots, logs with trace (obtained with steps in Troubleshooting)
  5. Do not forget to attach context like:
    • Scarb version (which version or which nightly?), or commit reference (if built locally),
    • relevant Cairo extension VSCode configuration,
    • Cairo extension version.