-
Notifications
You must be signed in to change notification settings - Fork 544
docs(ref): Specify frontmatter #1974
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ | |
- [Input format](input-format.md) | ||
- [Keywords](keywords.md) | ||
- [Identifiers](identifiers.md) | ||
- [Frontmatter](frontmatter.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I put this under "Lexical structure" because this shebang is there |
||
- [Comments](comments.md) | ||
- [Whitespace](whitespace.md) | ||
- [Tokens](tokens.md) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
r[frontmatter] | ||
# Frontmatter | ||
|
||
r[frontmatter.syntax] | ||
```grammar,lexer | ||
FRONTMATTER -> | ||
FRONTMATTER_FENCE INFOSTRING? LF | ||
(FRONTMATTER_LINE LF )* | ||
FRONTMATTER_FENCE[^matched-fence] LF | ||
|
||
FRONTMATTER_FENCE -> `---` `-`* | ||
|
||
INFOSTRING -> (XID_Start | `_`) ( XID_Continue | `-` | `.` )* | ||
|
||
FRONTMATTER_LINE -> (~INVALID_FRONTMATTER_LINE_START (~INVALID_FRONTMATTER_LINE_CONTINUE)*)? | ||
|
||
INVALID_FRONTMATTER_LINE_START -> (FRONTMATTER_FENCE[^escaped-fence] | LF) | ||
|
||
INVALID_FRONTMATTER_LINE_CONTINUE -> LF | ||
Comment on lines
+6
to
+19
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thinking more on this, I feel like I should be explicit where frontmatter whitespace is allowed. I assume I should then pull out a whitespace grammar rule to build on that.
Comment on lines
+6
to
+19
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Something that i don't make explicit is |
||
``` | ||
|
||
[^matched-fence]: The closing fence must have the same number of `-` as the opening fence | ||
[^escaped-fence]: A `FRONTMATTER_FENCE` at the beginning of a `FRONTMATTER_LINE` is only invalid if it has the same or more `-` as the `FRONTMATTER_FENCE` | ||
|
||
Frontmatter is an optional section for content intended for external tools without requiring these tools to have full knowledge of the Rust grammar. | ||
|
||
r[frontmatter.document] | ||
Frontmatter may only be preceded by a [shebang] and whitespace. | ||
|
||
r[frontmatter.fence] | ||
The delimiters are referred to as a "fence." | ||
The opening and closing fences must be at the start of a line. | ||
They must be a matching pair of three or more hyphens (`-`). | ||
|
||
r[frontmatter.infostring] | ||
Following the opening fence may be an infostring for identifying the intention of the contained content. | ||
An infostring may be preceded by non-newline whitespace. | ||
|
||
r[frontmatter.body] | ||
The body of the frontmatter may contain any content except for a line starting with as many or more hyphens (`-`) than in the fences. | ||
|
||
[shebang]: input-format.md#shebang-removal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not stable yet: rust-lang/rust#136889