control vscode settings.json from init

Author: makspll

.vscode/.gitignore

@@ -0,0 +1 @@
+settings.json

.vscode/settings.json

@@ -21,3 +21,5 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 glob = "0.3"
 toml = "0.8"
+tera = "1.20"
+json_comments = "0.2"

crates/xtask/Cargo.toml

@@ -1,8 +1,9 @@
-use anyhow::*;
+use anyhow::{Context, *};
 use clap::Parser;
 use itertools::Itertools;
+use json_comments::StripComments;
 use log::*;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 use std::{
     collections::{HashMap, HashSet},
     ffi::{OsStr, OsString},
@@ -1357,8 +1358,59 @@ impl Xtasks {
             Some(Path::new(".")),
         )?;
 
+        // create .vscode settings
+        // read from templates at compile time
+        let vscode_settings = include_str!("../templates/settings.json.tera");
+        let mut tera = tera::Tera::default();
+        let mut context = tera::Context::new();
+        context.insert("dir", &Self::workspace_dir(&app_settings)?);
+        let templated_settings = tera.render_str(vscode_settings, &context)?;
+        let templated_settings_json = Self::read_json_with_comments(templated_settings.as_bytes())
+            .with_context(|| "reading templated vscode settings")?;
+        let vscode_dir = Self::relative_workspace_dir(&app_settings, ".vscode")?;
+        std::fs::create_dir_all(&vscode_dir)?;
+        let vscode_settings_path = vscode_dir.join("settings.json");
+
+        // if the file already exists, merge the settings otherwise create it
+        info!(
+            "Merging vscode settings at {:?}. With overrides generated by template.",
+            vscode_settings_path
+        );
+        if vscode_settings_path.exists() {
+            let existing_settings = std::fs::read_to_string(&vscode_settings_path)?;
+            let mut existing_settings = Self::read_json_with_comments(existing_settings.as_bytes())
+                .with_context(|| "reading existing vscode settings file")?;
+            Self::merge_json(templated_settings_json, &mut existing_settings);
+            let merged_settings = serde_json::to_string_pretty(&existing_settings)?;
+            std::fs::write(&vscode_settings_path, merged_settings)?;
+        } else {
+            std::fs::write(&vscode_settings_path, templated_settings)?;
+        }
+
         Ok(())
     }
+
+    fn read_json_with_comments(bytes: &[u8]) -> Result<serde_json::Value> {
+        let stripped = StripComments::new(bytes);
+        let mut reader = serde_json::Deserializer::from_reader(stripped);
+        let value = serde_json::Value::deserialize(&mut reader)?;
+        Ok(value)
+    }
+
+    /// Override the target json file with some overrides. Will replace values if they already exist, or insert them otherwise.
+    fn merge_json(overrides: serde_json::Value, target: &mut serde_json::Value) {
+        if let (serde_json::Value::Object(overrides), serde_json::Value::Object(target)) =
+            (overrides, target)
+        {
+            for (key, value) in overrides {
+                // simply replace
+                info!("Replacing json key: {} with value: {}", key, value);
+                target.insert(key.clone(), value.clone());
+            }
+        } else {
+            warn!("Could not merge json, overrides and target are not objects");
+        }
+    }
 }
 
 /// Because we are likely already runnnig in the context of a cargo invocation,
@@ -1400,7 +1452,7 @@ fn try_main() -> Result<()> {
 
 fn main() {
     if let Err(e) = try_main() {
-        eprintln!("{}", e);
+        eprintln!("{:?}", e);
         std::process::exit(1);
     }
 }

crates/xtask/src/main.rs

@@ -1,31 +1,11 @@
 {
-    "lldb.displayFormat": "auto",
-    "lldb.showDisassembly": "never",
-    "lldb.dereferencePointers": true,
-    "lldb.consoleMode": "commands",
-    "[rust]": {
-        "editor.formatOnSave": true,
-        "editor.formatOnSaveMode": "file",
-        "editor.defaultFormatter": "rust-lang.rust-analyzer"
-    },
     "rust-analyzer.rustc.source": "discover",
     "rust-analyzer.linkedProjects": [
-        "./crates/bevy_api_gen/Cargo.toml",
+        "{{ dir }}/crates/bevy_api_gen/Cargo.toml",
         "Cargo.toml"
     ],
     "rust-analyzer.check.invocationStrategy": "per_workspace",
-    "rust-analyzer.check.invocationLocation": "workspace",
     "rust-analyzer.check.overrideCommand": [
-        "cargo xtask check"
-    ],
-    "rust-analyzer.cargo.buildScripts.overrideCommand": [
-        "cargo xtask check"
-    ],
-    "rust-analyzer.showUnlinkedFileNotification": false,
-    "rust-analyzer.runnables.extraTestBinaryArgs": [
-        "--show-output"
-    ],
-    "rust-analyzer.runnables.extraArgs": [
-        "--profile=release-with-debug"
+        "{{ dir }}/check.sh"
     ]
 }