Auto merge of #13861 - epage:frontmatter, r=ehuss

fix(toml): Remove unstable rejrected frontmatter syntax for cargo script ### What does this PR try to resolve? With rust-lang/rfcs#3503 approved, we no longer need to allow easy, high fidelity experiments with alternative cargo script syntax. ### How should we test and review this PR? ### Additional information We still need to improve the experience for users writing bad syntax but that can come later.
rust-lang · May 6, 2024 · cfbc4b7 · cfbc4b7
2 parents 85a4d70 + 229385b
commit cfbc4b7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 138 deletions.
diff --git a/src/cargo/util/toml/embedded.rs b/src/cargo/util/toml/embedded.rs
@@ -185,7 +185,7 @@ fn sanitize_name(name: &str) -> String {
 struct Source<'s> {
     shebang: Option<&'s str>,
     info: Option<&'s str>,
-    frontmatter: Option<String>,
+    frontmatter: Option<&'s str>,
     content: &'s str,
 }
 
@@ -218,12 +218,7 @@ fn split_source(input: &str) -> CargoResult<Source<'_>> {
     }
 
     // Experiment: let us try which char works better
-    let tick_char = source
-        .content
-        .chars()
-        .filter(|c| ['`', '#', '-'].contains(c))
-        .next()
-        .unwrap_or('`');
+    let tick_char = '-';
 
     let tick_end = source
         .content
@@ -234,13 +229,6 @@ fn split_source(input: &str) -> CargoResult<Source<'_>> {
         0 => {
             return Ok(source);
         }
-        1 if tick_char == '#' => {
-            // Attribute
-            return Ok(source);
-        }
-        2 if tick_char == '#' => {
-            return split_prefix_source(source, "##");
-        }
         1 | 2 => {
             anyhow::bail!("found {tick_end} `{tick_char}` in rust frontmatter, expected at least 3")
         }
@@ -255,7 +243,7 @@ fn split_source(input: &str) -> CargoResult<Source<'_>> {
     let Some((frontmatter, content)) = source.content.split_once(fence_pattern) else {
         anyhow::bail!("no closing `{fence_pattern}` found for frontmatter");
     };
-    source.frontmatter = Some(frontmatter.to_owned());
+    source.frontmatter = Some(frontmatter);
     source.content = content;
 
     let (line, content) = source
@@ -271,22 +259,6 @@ fn split_source(input: &str) -> CargoResult<Source<'_>> {
     Ok(source)
 }
 
-fn split_prefix_source<'s>(mut source: Source<'s>, prefix: &str) -> CargoResult<Source<'s>> {
-    let mut frontmatter = String::new();
-    while let Some(rest) = source.content.strip_prefix(prefix) {
-        if !rest.is_empty() && !rest.starts_with(' ') {
-            anyhow::bail!("frontmatter must have a space between `##` and the content");
-        }
-        let (line, rest) = rest.split_once('\n').unwrap_or((rest, ""));
-        frontmatter.push_str("  ");
-        frontmatter.push_str(line);
-        frontmatter.push('\n');
-        source.content = rest;
-    }
-    source.frontmatter = Some(frontmatter);
-    Ok(source)
-}
-
 #[cfg(test)]
 mod test_expand {
     use super::*;
@@ -351,10 +323,10 @@ strip = true
 
 [workspace]
 "#,
-            si!(r#"```cargo
+            si!(r#"---cargo
 [dependencies]
 time="0.1.25"
-```
+---
 fn main() {}
 "#),
         );
@@ -382,110 +354,13 @@ name = "test-"
 [profile.release]
 strip = true
 
-[workspace]
-"#,
-            si!(r#"```
-[dependencies]
-time="0.1.25"
-```
-fn main() {}
-"#),
-        );
-    }
-
-    #[test]
-    fn test_dash_fence() {
-        snapbox::assert_matches(
-            r#"[[bin]]
-name = "test-"
-path = [..]
-
-[dependencies]
-time = "0.1.25"
-
-[package]
-autobenches = false
-autobins = false
-autoexamples = false
-autotests = false
-build = false
-edition = "2021"
-name = "test-"
-
-[profile.release]
-strip = true
-
 [workspace]
 "#,
             si!(r#"---
 [dependencies]
 time="0.1.25"
 ---
 fn main() {}
-"#),
-        );
-    }
-
-    #[test]
-    fn test_hash_fence() {
-        snapbox::assert_matches(
-            r#"[[bin]]
-name = "test-"
-path = [..]
-
-[dependencies]
-time = "0.1.25"
-
-[package]
-autobenches = false
-autobins = false
-autoexamples = false
-autotests = false
-build = false
-edition = "2021"
-name = "test-"
-
-[profile.release]
-strip = true
-
-[workspace]
-"#,
-            si!(r#"###
-[dependencies]
-time="0.1.25"
-###
-fn main() {}
-"#),
-        );
-    }
-
-    #[test]
-    fn test_hash_prefix() {
-        snapbox::assert_matches(
-            r#"[[bin]]
-name = "test-"
-path = [..]
-
-[dependencies]
-time = "0.1.25"
-
-[package]
-autobenches = false
-autobins = false
-autoexamples = false
-autotests = false
-build = false
-edition = "2021"
-name = "test-"
-
-[profile.release]
-strip = true
-
-[workspace]
-"#,
-            si!(r#"## [dependencies]
-## time="0.1.25"
-fn main() {}
 "#),
         );
     }

diff --git a/tests/testsuite/script.rs b/tests/testsuite/script.rs
@@ -210,10 +210,10 @@ fn requires_z_flag() {
 #[cargo_test]
 fn clean_output_with_edition() {
     let script = r#"#!/usr/bin/env cargo
-```cargo
+---
 [package]
 edition = "2018"
-```
+---
 
 fn main() {
     println!("Hello world!");
@@ -241,9 +241,9 @@ fn main() {
 #[cargo_test]
 fn warning_without_edition() {
     let script = r#"#!/usr/bin/env cargo
-```cargo
+---
 [package]
-```
+---
 
 fn main() {
     println!("Hello world!");
@@ -714,10 +714,10 @@ fn did_you_mean_command_stable() {
 fn test_name_same_as_dependency() {
     Package::new("script", "1.0.0").publish();
     let script = r#"#!/usr/bin/env cargo
-```cargo
+---
 [dependencies]
 script = "1.0.0"
-```
+---
 
 fn main() {
     println!("Hello world!");
@@ -751,10 +751,10 @@ fn main() {
 #[cargo_test]
 fn test_path_dep() {
     let script = r#"#!/usr/bin/env cargo
-```cargo
+---
 [dependencies]
 bar.path = "./bar"
-```
+---
 
 fn main() {
     println!("Hello world!");