Skip to content

Validate front matter in CI #1577

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

Merged
merged 3 commits into from
Apr 15, 2025
Merged

Validate front matter in CI #1577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
722cf78
Make front matter test more lenient
senekor Apr 15, 2025
e8d109a
Don't create aliases for new blog posts
senekor Apr 15, 2025
6d240cd
Validate front matter in CI
senekor Apr 15, 2025
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
1 change: 1 addition & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:

- run: cargo clippy --workspace -- -D warnings
- run: cargo fmt --check --all
- run: cargo test --package front_matter

build:
runs-on: ubuntu-latest
Expand Down
39 changes: 24 additions & 15 deletions front_matter/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use serde::{Deserialize, Serialize};
use toml::value::Date;

/// The front matter of a markdown blog post.
#[derive(Debug, PartialEq, Serialize, Deserialize)]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct FrontMatter {
/// Deprecated. The plan was probably to have more specialized templates
/// at some point. That didn't materialize, all posts are rendered with the
Expand Down Expand Up @@ -42,7 +42,7 @@ pub struct FrontMatter {
pub extra: Extra,
}

#[derive(Debug, Default, PartialEq, Serialize, Deserialize)]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Extra {
pub team: Option<String>,
pub team_url: Option<String>,
Expand Down Expand Up @@ -73,8 +73,12 @@ pub fn parse(markdown: &str) -> eyre::Result<(FrontMatter, &str)> {
}

/// Normalizes the front matter of a markdown file.
pub fn normalize(markdown: &str, slug: &str, inside_rust: bool) -> eyre::Result<String> {
let (mut front_matter, content) = parse(markdown)?;
pub fn normalize(
front_matter: &FrontMatter,
slug: &str,
inside_rust: bool,
) -> eyre::Result<FrontMatter> {
let mut front_matter = front_matter.clone();

// migrate "author" to "authors" key
if let Some(author) = front_matter.author.take() {
Expand Down Expand Up @@ -104,20 +108,15 @@ pub fn normalize(markdown: &str, slug: &str, inside_rust: bool) -> eyre::Result<
slug = slug.split_once('@').map(|(s, _)| s).unwrap_or(slug),
);
}
front_matter.aliases = vec![format!("{}.html", front_matter.path)];

if front_matter.extra.team.is_some() ^ front_matter.extra.team_url.is_some() {
bail!("extra.team and extra.team_url must always come in a pair");
}

Ok(format!(
"\
+++
{}\
+++
{content}",
toml::to_string_pretty(&front_matter)?
))
let serialized = toml::to_string_pretty(&front_matter)?;
let deserialized = toml::from_str(&serialized)?;

Ok(deserialized)
}

#[cfg(test)]
Expand Down Expand Up @@ -146,11 +145,21 @@ mod tests {
.contains("content/inside-rust/");

let content = fs::read_to_string(&post).unwrap();
let normalized = normalize(&content, slug, inside_rust).unwrap_or_else(|err| {
let (front_matter, rest) = parse(&content).unwrap();
let normalized = normalize(&front_matter, slug, inside_rust).unwrap_or_else(|err| {
panic!("failed to normalize {:?}: {err}", post.file_name().unwrap());
});

if content != normalized {
if front_matter != normalized {
let normalized = format!(
"\
+++\n\
{}\
+++\n\
{rest}\
",
toml::to_string_pretty(&normalized).unwrap(),
);
if env::var("FIX_FRONT_MATTER").is_ok() {
fs::write(post, normalized).unwrap();
continue;
Expand Down