SetupEditor.md

This is some basic Visual Studio Code setup. If you're using a different IDE, skip this. The goal is to ensure that students see the same thing as the instructor.

Setup your Integrated Development Environment

While teaching, the instructor will use Microsoft Visual Studio Code. It's free, runs the same on Windows, Mac and Linux, and integrates well with a Rust environment.

Extensions You Need

You should have Rust Analyzer installed as a pre-requesite. If you don't, let me know and I'll help at the first break.

• Rust Analyzer
  • Provides everything from syntax highlighting to inline error checking, macro expansion and debugger integration.
  • Part of the core RustUp distribution.
  • Regularly Updated.
• CodeLLDB
  • Integrates well with Rust-Analyzer.
  • Provides inline debugging.
  • This is optional for this class, but you probably want it anyway

Extensions You Don't Need - But Probably Want

• Crates
  • Let's you know when dependencies are outdated.
• Better TOML
  • Makes editing Rust's TOML configuration easier

Some Configuration Tweaks

Live demo

Enable Breakpoints Everywhere

* Open Settings (`crtl` + `comma`)
* Search for "everywhere".
* Check "Allow Setting Breakpoints in any file"
    * This helps the debugger work with Rust, even if optimizations have moved your code around.

Enable Realtime Clippy

* Open Settings (`ctrl` + `comma`)
* Search for "cargo check"
* Change "Rust Analyzer > Check Command" to "clippy"
    * By default, `cargo check` provides a very quick "did it compile?" check for your code.
    * Rust has a great linter called "Clippy" built in.
    * This helps reduce errors as you work, and often provides quick refactors into idiomatic Rust.