Add possibility to specify scarb version in snippet config (#3650)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #

## Introduced changes

Allow to set `scarb_version` in `SnippetConfig`. If scarb version is
incompatible, snippet will be ignored.

## Checklist

<!-- Make sure all of these are complete -->

- [ ] Linked relevant issue
- [x] Updated relevant documentation
- [ ] Added relevant tests
- [x] Performed self-review of the code
- [ ] Added changes to `CHANGELOG.md`

Author: franciszekjob

Cargo.lock

@@ -15,6 +15,8 @@ toml_edit.workspace = true
 camino.workspace = true
 tempfile.workspace = true
 anyhow.workspace = true
+semver.workspace = true
+scarb-api = { path = "../scarb-api" }
 
 [features]
 testing = []

crates/docs/Cargo.toml

@@ -1,6 +1,8 @@
 use std::sync::LazyLock;
 
 use regex::Regex;
+use scarb_api::ScarbCommand;
+use semver::VersionReq;
 use serde::{Deserialize, Serialize};
 
 static RE_SNCAST: LazyLock<Regex> = LazyLock::new(|| {
@@ -52,13 +54,36 @@ impl SnippetType {
     }
 }
 
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Serialize)]
 #[serde(default)]
 pub struct SnippetConfig {
     pub ignored: bool,
     pub package_name: Option<String>,
     pub ignored_output: bool,
     pub replace_network: bool,
+    pub scarb_version: Option<VersionReq>,
+}
+
+#[derive(Deserialize)]
+#[serde(default)]
+struct SnippetConfigProxy {
+    ignored: bool,
+    package_name: Option<String>,
+    ignored_output: bool,
+    replace_network: bool,
+    scarb_version: Option<VersionReq>,
+}
+
+impl Default for SnippetConfigProxy {
+    fn default() -> Self {
+        Self {
+            ignored: false,
+            package_name: None,
+            ignored_output: false,
+            replace_network: true,
+            scarb_version: None,
+        }
+    }
 }
 
 impl Default for SnippetConfig {
@@ -68,10 +93,47 @@ impl Default for SnippetConfig {
             package_name: None,
             ignored_output: false,
             replace_network: true,
+            scarb_version: None,
+        }
+    }
+}
+
+impl SnippetConfig {
+    fn check_scarb_compatibility(&mut self) {
+        if let Some(ref scarb_version_req) = self.scarb_version {
+            let current_scarb_version = ScarbCommand::version()
+                .run()
+                .expect("Failed to get scarb version")
+                .scarb;
+
+            if !scarb_version_req.matches(&current_scarb_version) {
+                self.ignored = true;
+            }
         }
     }
 }
 
+impl<'de> Deserialize<'de> for SnippetConfig {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::de::Deserializer<'de>,
+    {
+        let proxy = SnippetConfigProxy::deserialize(deserializer)?;
+
+        let mut config = SnippetConfig {
+            ignored: proxy.ignored,
+            package_name: proxy.package_name,
+            ignored_output: proxy.ignored_output,
+            replace_network: proxy.replace_network,
+            scarb_version: proxy.scarb_version,
+        };
+
+        config.check_scarb_compatibility();
+
+        Ok(config)
+    }
+}
+
 #[derive(Debug)]
 pub struct Snippet {
     pub command: String,

crates/docs/src/snippet.rs

@@ -30,8 +30,9 @@ Test code:
 {{#include ../../../listings/cheatcodes_reference/tests/test_l1_handler.cairo}}
 ```
 
-<!-- { "package_name": "cheatcodes_reference" } -->
 Let's run the test:
+
+<!-- { "package_name": "cheatcodes_reference", "scarb_version": ">=2.11.4" } -->
 ```shell
 $ snforge test test_l1_handler
 ```

docs/src/appendix/cheatcodes/l1_handler.md

@@ -43,6 +43,8 @@ Test code:
 ```
 
 Let's run the test:
+
+<!-- { "package_name": "cheatcodes_reference", "scarb_version": ">=2.11.4" } -->
 ```shell
 $ snforge test test_mock_call
 ```

docs/src/appendix/cheatcodes/mock_call.md

@@ -36,3 +36,5 @@ account: https://sepolia.starkscan.co/contract/[..]
 - `ignored` - if set to `true`, the snippet will be ignored and not run.
 - `package_name` - the name of the Scarb package in which the snippet should be run.
 - `ignored_output` - if set to `true`, the output of executed command will be ignored.
+- `replace_network` - if set to `true`, the snippet will replace the `--network` argument with devnet used in tests.
+- `scarb_version` - specifies the Scarb version required to run the snippet. If the current Scarb version does not match, the snippet will be ignored. The version should be in the format compatible with [semver](https://semver.org/).