92 lines
2.9 KiB
Rust
92 lines
2.9 KiB
Rust
//! Common frontmatter helpers and shared types.
|
|
|
|
use chrono::{DateTime, Utc};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::error::LintError;
|
|
|
|
/// Reference to a session-store entry range. Stored in `sources` /
|
|
/// `last_sources` arrays for traceability back to raw session logs.
|
|
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
pub struct SourceRef {
|
|
pub session_id: String,
|
|
/// `[start_entry, end_entry]` inclusive range of session-store entry indices.
|
|
pub range: [u64; 2],
|
|
}
|
|
|
|
/// Trait every kind-specific frontmatter implements so the linter can
|
|
/// drive them uniformly.
|
|
pub trait Frontmatter: Sized {
|
|
/// Hard upper bound on body chars (excluding the frontmatter block).
|
|
const BODY_LIMIT: usize;
|
|
|
|
fn created_at(&self) -> DateTime<Utc>;
|
|
fn updated_at(&self) -> DateTime<Utc>;
|
|
}
|
|
|
|
const FRONTMATTER_DELIM: &str = "---";
|
|
|
|
/// Split a markdown document into `(yaml_frontmatter, body)`.
|
|
///
|
|
/// Expects the document to start with `---\n` and have a closing
|
|
/// `---\n` (or `---` at EOF) somewhere downstream. Trailing newline
|
|
/// after the closing delimiter is consumed.
|
|
pub fn split_frontmatter(content: &str) -> Result<(&str, &str), LintError> {
|
|
// The opening delimiter must be the very first line.
|
|
let after_open = content
|
|
.strip_prefix(FRONTMATTER_DELIM)
|
|
.and_then(|s| s.strip_prefix('\n').or(Some(s)))
|
|
.ok_or(LintError::MissingFrontmatter)?;
|
|
|
|
// Look for the closing `---` on its own line.
|
|
let mut yaml_end = None;
|
|
let mut byte_offset = 0usize;
|
|
for line in after_open.split_inclusive('\n') {
|
|
let trimmed = line.trim_end_matches('\n').trim_end_matches('\r');
|
|
if trimmed == FRONTMATTER_DELIM {
|
|
yaml_end = Some((byte_offset, byte_offset + line.len()));
|
|
break;
|
|
}
|
|
byte_offset += line.len();
|
|
}
|
|
|
|
let (yaml_end_excl, body_start) = yaml_end
|
|
.ok_or_else(|| LintError::MalformedFrontmatter("missing closing `---` line".to_string()))?;
|
|
|
|
let yaml = &after_open[..yaml_end_excl];
|
|
let body = &after_open[body_start..];
|
|
Ok((yaml, body))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn splits_simple() {
|
|
let doc = "---\nfoo: 1\n---\nbody here\n";
|
|
let (y, b) = split_frontmatter(doc).unwrap();
|
|
assert_eq!(y, "foo: 1\n");
|
|
assert_eq!(b, "body here\n");
|
|
}
|
|
|
|
#[test]
|
|
fn no_leading_delim_errors() {
|
|
let err = split_frontmatter("hello").unwrap_err();
|
|
assert!(matches!(err, LintError::MissingFrontmatter));
|
|
}
|
|
|
|
#[test]
|
|
fn no_closing_delim_errors() {
|
|
let err = split_frontmatter("---\nfoo: 1\nno close\n").unwrap_err();
|
|
assert!(matches!(err, LintError::MalformedFrontmatter(_)));
|
|
}
|
|
|
|
#[test]
|
|
fn handles_empty_body() {
|
|
let doc = "---\nfoo: 1\n---\n";
|
|
let (_, b) = split_frontmatter(doc).unwrap();
|
|
assert_eq!(b, "");
|
|
}
|
|
}
|