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

Jump to bottom

fix(toml): Update frontmatter parser for RFC 3503 #14792

Merged
merged 10 commits into from
Nov 15, 2024
Merged

fix(toml): Update frontmatter parser for RFC 3503 #14792

merged 10 commits into from
Nov 15, 2024

Conversation

epage
Copy link
Contributor

@epage epage commented Nov 7, 2024

What does this PR try to resolve?

We removed rejected syntax in #13861 haven't update frontmatter parsing to what RFC 3503 says.

This adds tests and fixes various cases to ensure we correctly detect the frontmatter and the infostring.

This is part of #12207

How should we test and review this PR?

Additional information

@rustbot
Copy link
Collaborator

rustbot commented Nov 7, 2024

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 7, 2024
@epage epage mentioned this pull request Nov 7, 2024
Open
35 tasks
@epage
test(toml): Import common assertion
f018624
@epage
test(toml): Clean up manifest expanding helper
d769cb5
@epage
test(toml): Separate manifest expansion from code fence tests
2ea0d97
@epage
test(toml): Expand code fence tests
c88c789
@epage
refactor(toml): Remove 'tick' language
8c88f23 
We've switched to dashes
@epage
refactor(toml): Remove references to multiple fence chars
45c2ff8
@epage
refactor(toml): Preserve the full newline for shebang
51db441 
The shebang is thrown away so this has no end-user impact
@epage
fix(toml): Don't error on infostrings with trailing whitespace
8918634
@epage
fix(toml): Don't error on leading whitespace in infostring
c1248ad 
According to the [RFC](https://rust-lang.github.io/rfcs/3503-frontmatter.html):

> Opens with 3+ dashes followed by 0+ whitespace,
> an optional term (one or more characters excluding whitespace and commas),
> 0+ whitespace, and a newline
@epage
fix(toml): Strip blank linkes before frontmatter
82836b0 
From the [RFC](https://rust-lang.github.io/rfcs/3503-frontmatter.html)

> When parsing Rust source, after stripping the shebang (#!), rustc will strip the frontmatter:
>
> - May include 0+ blank lines (whitespace + newline)

The question is what is a non-newline whitespace and what is a newline.
Looking at the [Reference](https://doc.rust-lang.org/reference/whitespace.html),
the answer is "unsure", particularly because the Rust language doesn't
generally try to distinguish them.
I kept things basic for now and we can revisit later.
@epage epage force-pushed the fence branch 3 times, most recently from 50ccca4 to a2b96da Compare November 14, 2024 15:52
@epage epage mentioned this pull request Nov 15, 2024
Open
ehuss
ehuss approved these changes Nov 15, 2024
View reviewed changes
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ehuss ehuss enabled auto-merge November 15, 2024 20:33
@ehuss ehuss added this pull request to the merge queue Nov 15, 2024
Merged via the queue into rust-lang:master with commit 9c3c48f Nov 15, 2024
20 checks passed
@epage epage deleted the fence branch November 15, 2024 22:05
@weihanglo weihanglo mentioned this pull request Nov 16, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 16, 2024
@bors
Auto merge of rust-lang#133094 - weihanglo:update-cargo, r=weihanglo
b74a83e 
Update cargo

15 commits in 4a2d8dc636445b276288543882e076f254b3ae95..69e595908e2c420e7f0d1be34e6c5b984c8cfb84
2024-11-09 19:10:33 +0000 to 2024-11-16 01:26:11 +0000
- refactor(fingerprint): Track the intent for each use of `UnitHash` (rust-lang/cargo#14826)
- fix(toml): Update frontmatter parser for RFC 3503 (rust-lang/cargo#14792)
- docs(unstable): Move -Zwarnings from stable to unstable section (rust-lang/cargo#14827)
- Simplify English used in guide (rust-lang/cargo#14825)
- feat(resolver): Stabilize resolver v3 (rust-lang/cargo#14754)
- docs: Clean up doc comments (rust-lang/cargo#14823)
- fix(remove): On error, suggest other dependencies  (rust-lang/cargo#14818)
- Always include Cargo.lock in published crates (rust-lang/cargo#14815)
- fix(build-rs)!: Updates from an audit (rust-lang/cargo#14817)
- feat(rustdoc): diplay env vars in extra verbose mode  (rust-lang/cargo#14812)
- Migrate build-rs to the Cargo repo (rust-lang/cargo#14786)
- chore(ci): Check for clippy `correctness` (rust-lang/cargo#14796)
- git: do not validate submodules of fresh checkouts (rust-lang/cargo#14605)
- refactor: clone-on-write when needed for InternedString (rust-lang/cargo#14808)
- fix(docs): typo in cargo-fmt.md (rust-lang/cargo#14805)
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 16, 2024
@bors
Auto merge of rust-lang#133094 - weihanglo:update-cargo, r=weihanglo
3e4849e 
Update cargo

15 commits in 4a2d8dc636445b276288543882e076f254b3ae95..69e595908e2c420e7f0d1be34e6c5b984c8cfb84
2024-11-09 19:10:33 +0000 to 2024-11-16 01:26:11 +0000
- refactor(fingerprint): Track the intent for each use of `UnitHash` (rust-lang/cargo#14826)
- fix(toml): Update frontmatter parser for RFC 3503 (rust-lang/cargo#14792)
- docs(unstable): Move -Zwarnings from stable to unstable section (rust-lang/cargo#14827)
- Simplify English used in guide (rust-lang/cargo#14825)
- feat(resolver): Stabilize resolver v3 (rust-lang/cargo#14754)
- docs: Clean up doc comments (rust-lang/cargo#14823)
- fix(remove): On error, suggest other dependencies  (rust-lang/cargo#14818)
- Always include Cargo.lock in published crates (rust-lang/cargo#14815)
- fix(build-rs)!: Updates from an audit (rust-lang/cargo#14817)
- feat(rustdoc): diplay env vars in extra verbose mode  (rust-lang/cargo#14812)
- Migrate build-rs to the Cargo repo (rust-lang/cargo#14786)
- chore(ci): Check for clippy `correctness` (rust-lang/cargo#14796)
- git: do not validate submodules of fresh checkouts (rust-lang/cargo#14605)
- refactor: clone-on-write when needed for InternedString (rust-lang/cargo#14808)
- fix(docs): typo in cargo-fmt.md (rust-lang/cargo#14805)
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 17, 2024
@bors
Auto merge of rust-lang#133094 - weihanglo:update-cargo, r=weihanglo
5afd5ad 
Update cargo

15 commits in 4a2d8dc636445b276288543882e076f254b3ae95..69e595908e2c420e7f0d1be34e6c5b984c8cfb84
2024-11-09 19:10:33 +0000 to 2024-11-16 01:26:11 +0000
- refactor(fingerprint): Track the intent for each use of `UnitHash` (rust-lang/cargo#14826)
- fix(toml): Update frontmatter parser for RFC 3503 (rust-lang/cargo#14792)
- docs(unstable): Move -Zwarnings from stable to unstable section (rust-lang/cargo#14827)
- Simplify English used in guide (rust-lang/cargo#14825)
- feat(resolver): Stabilize resolver v3 (rust-lang/cargo#14754)
- docs: Clean up doc comments (rust-lang/cargo#14823)
- fix(remove): On error, suggest other dependencies  (rust-lang/cargo#14818)
- Always include Cargo.lock in published crates (rust-lang/cargo#14815)
- fix(build-rs)!: Updates from an audit (rust-lang/cargo#14817)
- feat(rustdoc): diplay env vars in extra verbose mode  (rust-lang/cargo#14812)
- Migrate build-rs to the Cargo repo (rust-lang/cargo#14786)
- chore(ci): Check for clippy `correctness` (rust-lang/cargo#14796)
- git: do not validate submodules of fresh checkouts (rust-lang/cargo#14605)
- refactor: clone-on-write when needed for InternedString (rust-lang/cargo#14808)
- fix(docs): typo in cargo-fmt.md (rust-lang/cargo#14805)
@weihanglo weihanglo added this to the 1.84.0 milestone Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ehuss ehuss ehuss approved these changes

Assignees

@ehuss ehuss

Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Milestone
1.84.0
Development

Successfully merging this pull request may close these issues.
4 participants
@epage @rustbot @ehuss @weihanglo