🧹 Janitor: Refactor YAML frontmatter delimiter to use FRONTMATTER_DELIMITER constant - #294
🧹 Janitor: Refactor YAML frontmatter delimiter to use FRONTMATTER_DELIMITER constant#294matta wants to merge 1 commit into
Conversation
Extract the YAML frontmatter delimiter magic string ("---") into a shared `FRONTMATTER_DELIMITER` constant in `models.rs` and apply it to `graph.rs`, `models.rs`, and `parser.rs`.
This acts as a single source of truth for generating and parsing task files.
Co-authored-by: matta <37314+matta@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Merging to
|
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors the codebase to improve maintainability and reduce the risk of errors by replacing a hardcoded string literal with a dedicated constant. The change centralizes the definition of the YAML frontmatter delimiter, ensuring consistency across different parts of the application that interact with task file parsing and generation. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a good refactoring that replaces the hardcoded YAML frontmatter delimiter "---" with a shared constant, FRONTMATTER_DELIMITER. This improves maintainability and consistency across the codebase. The changes are applied correctly across parsing, generation, and file checking logic. I have one suggestion to improve performance by avoiding an unnecessary string allocation.
| if let Some(stripped) = yaml_payload.strip_prefix(&format!("{}\n", FRONTMATTER_DELIMITER)) { | ||
| yaml_payload = stripped.to_string(); | ||
| } |
There was a problem hiding this comment.
Using format! here creates a new String on the heap for every call, which is an unnecessary allocation. You can achieve the same result more efficiently by chaining strip_prefix calls using and_then to avoid this allocation.
| if let Some(stripped) = yaml_payload.strip_prefix(&format!("{}\n", FRONTMATTER_DELIMITER)) { | |
| yaml_payload = stripped.to_string(); | |
| } | |
| if let Some(stripped) = yaml_payload.strip_prefix(FRONTMATTER_DELIMITER).and_then(|s| s.strip_prefix("\n")) { | |
| yaml_payload = stripped.to_string(); | |
| } |
1 participant
🧹 Janitor: Refactor YAML frontmatter delimiter to use new FRONTMATTER_DELIMITER constant
📉 Diff:
+8 lines, -8 lines🎯 Goal: Extract constants for semantically identical literals.
💡 Before: The magic string
"---"was hardcoded ingraph.rs,models.rs, andparser.rsfor both generating and parsing Markdown files with YAML frontmatter.✨ After: Added
pub const FRONTMATTER_DELIMITER: &str = "---";tomodels.rs. Replaced hardcoded usages with the single source of truth, removing duplication and reducing potential bugs in future refactors.✅ Verification: Ran
just checkandjust test. Tests pass and behavior remains identical.PR created automatically by Jules for task 8273171995898991543 started by @matta