From c244a94e4a77c0798c5a45d3004ec2389378b394 Mon Sep 17 00:00:00 2001
From: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Date: Thu, 29 Feb 2024 11:41:11 +0000
Subject: [PATCH] update development setup in sdk-docs (#3506)

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
---
 .../development_environment_advice.rs         | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/docs/sdk/src/reference_docs/development_environment_advice.rs b/docs/sdk/src/reference_docs/development_environment_advice.rs
index 431769597936..21bbe78836c4 100644
--- a/docs/sdk/src/reference_docs/development_environment_advice.rs
+++ b/docs/sdk/src/reference_docs/development_environment_advice.rs
@@ -111,3 +111,74 @@
 //! If you have a powerful remote server available, you may consider using
 //! [cargo-remote](https://github.com/sgeisler/cargo-remote) to execute cargo commands on it,
 //! freeing up local resources for other tasks like `rust-analyzer`.
+//!
+//! When using `cargo-remote`, you can configure your editor to perform the the typical
+//! "check-on-save" remotely as well. The configuration for VSCode is as follows:
+//!
+//! ```json
+//! {
+//! 	"rust-analyzer.cargo.buildScripts.overrideCommand": [
+//! 		"cargo",
+//! 		"remote",
+//! 		"--build-env",
+//! 		"SKIP_WASM_BUILD=1",
+//! 		"--",
+//! 		"check",
+//! 		"--message-format=json",
+//! 		"--all-targets",
+//! 		"--all-features",
+//! 		"--target-dir=target/rust-analyzer"
+//! 	],
+//! 	"rust-analyzer.check.overrideCommand": [
+//! 		"cargo",
+//! 		"remote",
+//! 		"--build-env",
+//! 		"SKIP_WASM_BUILD=1",
+//! 		"--",
+//! 		"check",
+//! 		"--workspace",
+//! 		"--message-format=json",
+//! 		"--all-targets",
+//! 		"--all-features",
+//! 		"--target-dir=target/rust-analyzer"
+//! 	],
+//! }
+//! ```
+//!
+//! //! and the same in Lua for `neovim/nvim-lspconfig`:
+//!
+//! ```lua
+//! ["rust-analyzer"] = {
+//!   cargo = {
+//!     buildScripts = {
+//!       overrideCommand = {
+//!         "cargo",
+//!         "remote",
+//!         "--build-env",
+//!         "SKIP_WASM_BUILD=1",
+//!         "--",
+//!         "check",
+//!         "--message-format=json",
+//!         "--all-targets",
+//!         "--all-features",
+//!         "--target-dir=target/rust-analyzer"
+//!       },
+//!     },
+//!     check = {
+//!       overrideCommand = {
+//!         "cargo",
+//!         "remote",
+//!         "--build-env",
+//!         "SKIP_WASM_BUILD=1",
+//!         "--",
+//!         "check",
+//!         "--workspace",
+//!         "--message-format=json",
+//!         "--all-targets",
+//!         "--all-features",
+//!         "--target-dir=target/rust-analyzer"
+//!       },
+//!     },
+//!   },
+//! },
+//! ```