feat: support skipping examples

README.md

@@ -42,4 +42,6 @@ At the moment, expressions and assignments queries are supported.
 A line that follows an expression query will be used as an assertion.
 Blank lines matter. Even trailing ones.
 
+Examples can be skipped by including the word `skip` in the info string.
+
 The name eelco is in homage to the original author of Nix, Eelco Dolstra.

src/examples.rs

@@ -38,14 +38,16 @@ pub(crate) fn obtain(glob: &str) -> anyhow::Result<Vec<Example>> {
                 let comrak::nodes::NodeCodeBlock { info, literal, .. } = code_block;
                 let line = ast.sourcepos.start.line;
                 let id = ExampleId::new(path, line);
+                let mut info_words = info.split_ascii_whitespace();
 
-                let maybe_result = match info.split_ascii_whitespace().next() {
-                    Some(NIX_REPL_LANG_TAG) => {
+                let maybe_result = match (info_words.next(), info_words.contains(&"skip")) {
+                    (_, true) => None,
+                    (Some(NIX_REPL_LANG_TAG), _) => {
                         let repl_example =
                             ReplExample::try_new(id.clone(), literal.clone()).map(Example::Repl);
                         Some(repl_example)
                     }
-                    Some("nix") => {
+                    (Some("nix"), _) => {
                         let expression_example =
                             ExpressionExample::new(id.clone(), literal.clone());
                         Some(Ok(Example::Expression(expression_example)))

tests/misc.rs

@@ -46,3 +46,23 @@ fn all_examples_tested() {
         );
     });
 }
+
+#[test]
+fn skip() {
+    with_eelco(|file, eelco| {
+        file.write_str(indoc! {"
+            ```nix skip
+            assert false; null
+            ```
+            ```nix foo skip
+            assert false; null
+            ```
+            ```nix
+            null
+            ```
+        "})
+            .unwrap();
+
+        eelco.assert().success();
+    })
+}