Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(toml): Remove unstable rejrected frontmatter syntax for cargo script #13861

Merged
merged 2 commits into from
May 6, 2024
Merged

fix(toml): Remove unstable rejrected frontmatter syntax for cargo script #13861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c3bc8d
Revert "feat(embedded): Add prefix-char frontmatter syntax support"
epage May 4, 2024
229385b
fix(toml): Remove dashed and hashed frontmatter syntax
epage May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 5 additions & 130 deletions src/cargo/util/toml/embedded.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}

Expand Down Expand Up @@ -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
Expand All @@ -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")
}
Expand All @@ -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
Expand All @@ -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::*;
Expand Down Expand Up @@ -351,10 +323,10 @@ strip = true

[workspace]
"#,
si!(r#"```cargo
si!(r#"---cargo
[dependencies]
time="0.1.25"
```
---
fn main() {}
"#),
);
Expand Down Expand Up @@ -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() {}
"#),
);
}
Expand Down
16 changes: 8 additions & 8 deletions tests/testsuite/script.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!");
Expand Down Expand Up @@ -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!");
Expand Down Expand Up @@ -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!");
Expand Down Expand Up @@ -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!");
Expand Down