1use std::path::{Path, PathBuf};
16use std::time::{SystemTime, UNIX_EPOCH};
17
18use crate::constants::{INSTRUCTIONS_TRUNCATION_MARKER, MAX_INSTRUCTIONS_BYTES};
19
20pub const INSTRUCTION_FILENAMES: &[&str] = &["AGENTS.md", "MERMAID.md"];
25
26const MAX_WALK_DEPTH: usize = 32;
29
30#[derive(Debug, Clone)]
33pub struct InstructionSource {
34 pub path: PathBuf,
35 pub mtime: SystemTime,
36 pub byte_len: usize,
37}
38
39#[derive(Debug, Clone)]
43pub struct LoadedInstructions {
44 pub path: PathBuf,
48 pub content: String,
51 pub mtime: SystemTime,
54 pub byte_len: usize,
56 pub truncated: bool,
59 pub sources: Vec<InstructionSource>,
61}
62
63impl LoadedInstructions {
64 pub fn approx_tokens(&self) -> usize {
67 self.content.len() / 4
68 }
69}
70
71#[derive(Debug, PartialEq, Eq)]
74pub enum ReloadOutcome {
75 Unchanged,
77 LoadedFirst { tokens: usize },
80 Reloaded {
82 old_tokens: usize,
83 new_tokens: usize,
84 },
85 Removed,
87}
88
89pub fn find_instruction_files(start: &Path) -> Vec<PathBuf> {
99 find_instruction_files_bounded(start, home_dir_boundary().as_deref())
100}
101
102fn home_dir_boundary() -> Option<PathBuf> {
110 let home = std::env::var_os("HOME");
111 #[cfg(windows)]
112 let resolved = pick_home_boundary(
113 home.as_deref(),
114 std::env::var_os("USERPROFILE").as_deref(),
115 std::env::var_os("HOMEDRIVE").as_deref(),
116 std::env::var_os("HOMEPATH").as_deref(),
117 );
118 #[cfg(not(windows))]
120 let resolved = pick_home_boundary(home.as_deref(), None, None, None);
121 resolved
122}
123
124fn pick_home_boundary(
130 home: Option<&std::ffi::OsStr>,
131 userprofile: Option<&std::ffi::OsStr>,
132 homedrive: Option<&std::ffi::OsStr>,
133 homepath: Option<&std::ffi::OsStr>,
134) -> Option<PathBuf> {
135 fn nonempty(v: Option<&std::ffi::OsStr>) -> Option<&std::ffi::OsStr> {
136 v.filter(|s| !s.is_empty())
137 }
138 if let Some(home) = nonempty(home) {
139 return Some(PathBuf::from(home));
140 }
141 if let Some(profile) = nonempty(userprofile) {
142 return Some(PathBuf::from(profile));
143 }
144 if let (Some(drive), Some(path)) = (nonempty(homedrive), nonempty(homepath)) {
145 let mut combined = drive.to_os_string();
146 combined.push(path);
147 return Some(PathBuf::from(combined));
148 }
149 None
150}
151
152fn find_instruction_files_bounded(start: &Path, home: Option<&Path>) -> Vec<PathBuf> {
156 let mut current = start.to_path_buf();
157 for _ in 0..MAX_WALK_DEPTH {
158 if home == Some(current.as_path()) {
163 return Vec::new();
164 }
165 let found: Vec<PathBuf> = INSTRUCTION_FILENAMES
166 .iter()
167 .map(|name| current.join(name))
168 .filter(|candidate| candidate.is_file())
169 .collect();
170 if !found.is_empty() {
171 return found;
172 }
173 if current.join(".git").exists() {
177 return Vec::new();
178 }
179 match current.parent() {
181 Some(parent) if parent != current => current = parent.to_path_buf(),
182 _ => return Vec::new(),
183 }
184 }
185 Vec::new()
186}
187
188pub fn load_from_path(path: &Path) -> Option<LoadedInstructions> {
192 load_from_paths(&[path.to_path_buf()])
193}
194
195pub fn load_from_paths(paths: &[PathBuf]) -> Option<LoadedInstructions> {
198 let mut sources = Vec::new();
199 let mut bodies = Vec::new();
200 let mut total_byte_len = 0usize;
201 let mut latest_mtime = UNIX_EPOCH;
202
203 for path in paths {
204 let Ok(metadata) = std::fs::metadata(path) else {
210 continue;
211 };
212 let Ok(mtime) = metadata.modified() else {
213 continue;
214 };
215 let true_len = metadata.len() as usize;
216 let Ok((bytes, _truncated)) =
222 crate::utils::read_file_capped(path, MAX_INSTRUCTIONS_BYTES.saturating_add(1))
223 else {
224 continue;
225 };
226 let raw = String::from_utf8_lossy(&bytes).into_owned();
227 total_byte_len = total_byte_len.saturating_add(true_len);
228 if mtime > latest_mtime {
229 latest_mtime = mtime;
230 }
231 sources.push(InstructionSource {
232 path: path.to_path_buf(),
233 mtime,
234 byte_len: true_len,
235 });
236 bodies.push((path.to_path_buf(), raw));
237 }
238 let primary = sources.first()?.path.clone();
239 let sections = label_instruction_bodies(bodies);
240 let byte_len = total_byte_len;
241 let (content, truncated) = combine_and_cap_sections(sections, MAX_INSTRUCTIONS_BYTES);
242 Some(LoadedInstructions {
243 path: primary,
244 content,
245 mtime: latest_mtime,
246 byte_len,
247 truncated,
248 sources,
249 })
250}
251
252pub fn refresh(
259 current: Option<LoadedInstructions>,
260 cwd: &Path,
261) -> (Option<LoadedInstructions>, ReloadOutcome) {
262 match current {
263 Some(prior) => {
264 let paths: Vec<PathBuf> = if prior.sources.is_empty() {
266 vec![prior.path.clone()]
267 } else {
268 prior
269 .sources
270 .iter()
271 .map(|source| source.path.clone())
272 .collect()
273 };
274 let changed = if prior.sources.is_empty() {
275 std::fs::metadata(&prior.path)
276 .and_then(|m| m.modified())
277 .map(|mtime| mtime != prior.mtime)
278 .unwrap_or(true)
279 } else {
280 prior.sources.iter().any(|source| {
281 std::fs::metadata(&source.path)
282 .and_then(|m| m.modified())
283 .map(|mtime| mtime != source.mtime)
284 .unwrap_or(true)
285 })
286 };
287 if !changed {
288 return (Some(prior), ReloadOutcome::Unchanged);
289 }
290 let old_tokens = prior.approx_tokens();
291 match load_from_paths(&paths) {
292 Some(reloaded) => {
293 let new_tokens = reloaded.approx_tokens();
294 (
295 Some(reloaded),
296 ReloadOutcome::Reloaded {
297 old_tokens,
298 new_tokens,
299 },
300 )
301 },
302 None => {
303 (None, ReloadOutcome::Removed)
306 },
307 }
308 },
309 None => {
310 match load_from_paths(&find_instruction_files(cwd)) {
313 Some(loaded) => {
314 let tokens = loaded.approx_tokens();
315 (Some(loaded), ReloadOutcome::LoadedFirst { tokens })
316 },
317 None => (None, ReloadOutcome::Unchanged),
318 }
319 },
320 }
321}
322
323const INSTRUCTION_SECTION_SEPARATOR: &str = "\n\n---\n\n";
325
326fn label_instruction_bodies(bodies: Vec<(PathBuf, String)>) -> Vec<String> {
332 bodies
333 .into_iter()
334 .map(|(path, body)| {
335 let name = path
336 .file_name()
337 .and_then(|name| name.to_str())
338 .unwrap_or("instructions");
339 format!("# Project Instructions: {}\n\n{}", name, body)
340 })
341 .collect()
342}
343
344fn combine_and_cap_sections(sections: Vec<String>, cap: usize) -> (String, bool) {
362 const SEP: &str = INSTRUCTION_SECTION_SEPARATOR;
363 let marker = INSTRUCTIONS_TRUNCATION_MARKER;
364
365 let full = sections.join(SEP);
366 if full.len() <= cap {
367 return (full, false);
368 }
369 let Some(winner) = sections.last() else {
372 return (String::new(), false);
373 };
374 if winner.len() >= cap {
378 let cut = winner.floor_char_boundary(cap);
379 let mut clipped = winner[..cut].to_string();
380 clipped.push_str(marker);
381 return (clipped, true);
382 }
383 let earlier_len = sections.len() - 1;
388 let earlier_full = sections[..earlier_len].join(SEP);
389 let avail = cap.saturating_sub(winner.len() + SEP.len());
390 let cut = earlier_full.floor_char_boundary(avail);
391 if cut == 0 {
392 let mut body = winner.clone();
395 body.push_str(marker);
396 return (body, true);
397 }
398 let mut body = String::with_capacity(cut + marker.len() + SEP.len() + winner.len());
399 body.push_str(&earlier_full[..cut]);
400 body.push_str(marker);
401 body.push_str(SEP);
402 body.push_str(winner.as_str());
403 (body, true)
404}
405
406#[cfg(test)]
407mod tests {
408 use super::*;
409 use std::fs;
410 use std::sync::Mutex;
411
412 static FS_LOCK: Mutex<()> = Mutex::new(());
415
416 fn temp_dir(name: &str) -> PathBuf {
417 let p = std::env::temp_dir().join(format!("mermaid_instructions_test_{}", name));
418 let _ = fs::remove_dir_all(&p);
419 fs::create_dir_all(&p).expect("create temp dir");
420 p
421 }
422
423 #[test]
424 fn find_instruction_files_finds_in_cwd() {
425 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
426 let dir = temp_dir("cwd");
427 fs::write(dir.join("MERMAID.md"), "rules").unwrap();
428 let found = find_instruction_files(&dir);
429 assert_eq!(found, vec![dir.join("MERMAID.md")]);
430 let _ = fs::remove_dir_all(&dir);
431 }
432
433 #[test]
434 fn find_instruction_files_loads_both_in_precedence_order() {
435 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
436 let dir = temp_dir("both");
437 fs::write(dir.join("AGENTS.md"), "agent rules").unwrap();
438 fs::write(dir.join("MERMAID.md"), "mermaid rules").unwrap();
439 let found = find_instruction_files(&dir);
440 assert_eq!(found, vec![dir.join("AGENTS.md"), dir.join("MERMAID.md")]);
442 let loaded = load_from_paths(&found).expect("load combined");
443 assert!(loaded.content.contains("# Project Instructions: AGENTS.md"));
444 assert!(loaded.content.contains("agent rules"));
445 assert!(
446 loaded
447 .content
448 .contains("# Project Instructions: MERMAID.md")
449 );
450 assert!(loaded.content.contains("mermaid rules"));
451 assert!(
453 loaded.content.find("mermaid rules") > loaded.content.find("agent rules"),
454 "MERMAID.md must come last so its guidance overrides AGENTS.md"
455 );
456 assert_eq!(loaded.sources.len(), 2);
457 let _ = fs::remove_dir_all(&dir);
458 }
459
460 #[test]
461 fn find_instruction_files_walks_up_to_git_root() {
462 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
463 let root = temp_dir("walkup");
464 fs::create_dir(root.join(".git")).unwrap();
465 fs::write(root.join("MERMAID.md"), "root rules").unwrap();
466 let sub = root.join("subdir/deeper");
467 fs::create_dir_all(&sub).unwrap();
468 let found = find_instruction_files(&sub);
469 assert_eq!(found, vec![root.join("MERMAID.md")]);
470 let _ = fs::remove_dir_all(&root);
471 }
472
473 #[test]
474 fn find_instruction_files_stops_at_git_root_without_file() {
475 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
476 let root = temp_dir("git_no_md");
477 fs::create_dir(root.join(".git")).unwrap();
478 let parent = root.parent().unwrap();
481 let above_md = parent.join("MERMAID.md");
482 fs::write(&above_md, "outside").unwrap();
483 let sub = root.join("subdir");
484 fs::create_dir_all(&sub).unwrap();
485 let found = find_instruction_files(&sub);
486 assert!(found.is_empty(), "walk must stop at .git boundary");
487 let _ = fs::remove_dir_all(&root);
488 let _ = fs::remove_file(&above_md);
489 }
490
491 #[test]
492 fn find_instruction_files_returns_empty_if_absent() {
493 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
494 let dir = temp_dir("absent");
495 fs::create_dir(dir.join(".git")).unwrap();
498 let found = find_instruction_files(&dir);
499 assert!(found.is_empty());
500 let _ = fs::remove_dir_all(&dir);
501 }
502
503 #[test]
504 fn find_instruction_files_stops_at_home_boundary() {
505 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
510 let home = temp_dir("home_boundary");
511 fs::write(home.join("AGENTS.md"), "home rules").unwrap();
512 let child = home.join("project");
513 fs::create_dir_all(&child).unwrap();
514 let found = find_instruction_files_bounded(&child, Some(home.as_path()));
517 assert!(
518 found.is_empty(),
519 "walk must stop at $HOME and not load ~/AGENTS.md, got {found:?}"
520 );
521 let _ = fs::remove_dir_all(&home);
522 }
523
524 #[test]
525 fn single_file_instructions_get_labeled_header() {
526 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
530 let dir = temp_dir("single_header");
531 fs::write(dir.join("MERMAID.md"), "do the thing").unwrap();
532 let loaded = load_from_path(&dir.join("MERMAID.md")).expect("load");
533 assert!(
534 loaded
535 .content
536 .starts_with("# Project Instructions: MERMAID.md"),
537 "single-file instructions must carry a labeled header, got: {:?}",
538 loaded.content
539 );
540 assert!(loaded.content.contains("do the thing"));
541 let _ = fs::remove_dir_all(&dir);
542 }
543
544 #[test]
545 fn load_from_path_truncates_oversized_file() {
546 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
547 let dir = temp_dir("oversized");
548 let path = dir.join("MERMAID.md");
549 let big = "a".repeat(50_000);
551 fs::write(&path, &big).unwrap();
552 let loaded = load_from_path(&path).expect("load");
553 assert!(loaded.truncated);
554 assert_eq!(loaded.byte_len, 50_000); assert!(loaded.content.ends_with(INSTRUCTIONS_TRUNCATION_MARKER));
556 assert_eq!(
558 loaded.content.len(),
559 MAX_INSTRUCTIONS_BYTES + INSTRUCTIONS_TRUNCATION_MARKER.len()
560 );
561 let _ = fs::remove_dir_all(&dir);
562 }
563
564 #[test]
565 fn load_from_path_returns_none_when_missing() {
566 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
567 let dir = temp_dir("missing");
568 assert!(load_from_path(&dir.join("nope.md")).is_none());
569 let _ = fs::remove_dir_all(&dir);
570 }
571
572 #[test]
573 fn refresh_returns_unchanged_when_mtime_stable() {
574 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
575 let dir = temp_dir("stable");
576 let path = dir.join("MERMAID.md");
577 fs::write(&path, "v1").unwrap();
578 let prior = load_from_path(&path).unwrap();
579 let (after, outcome) = refresh(Some(prior.clone()), &dir);
580 assert_eq!(outcome, ReloadOutcome::Unchanged);
581 assert!(after.is_some());
582 let _ = fs::remove_dir_all(&dir);
583 }
584
585 #[test]
586 fn refresh_returns_reloaded_on_content_change() {
587 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
588 let dir = temp_dir("changed");
589 let path = dir.join("MERMAID.md");
590 fs::write(&path, "v1").unwrap();
591 let prior = load_from_path(&path).unwrap();
592 std::thread::sleep(std::time::Duration::from_millis(1100));
595 fs::write(&path, "v2 longer content here").unwrap();
596 let (after, outcome) = refresh(Some(prior), &dir);
597 assert!(matches!(outcome, ReloadOutcome::Reloaded { .. }));
598 let content = after.unwrap().content;
599 assert!(content.contains("# Project Instructions: MERMAID.md"));
600 assert!(content.contains("v2 longer content here"));
601 let _ = fs::remove_dir_all(&dir);
602 }
603
604 #[test]
605 fn refresh_returns_removed_when_file_deleted() {
606 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
607 let dir = temp_dir("removed");
608 let path = dir.join("MERMAID.md");
609 fs::write(&path, "v1").unwrap();
610 let prior = load_from_path(&path).unwrap();
611 fs::remove_file(&path).unwrap();
612 let (after, outcome) = refresh(Some(prior), &dir);
613 assert_eq!(outcome, ReloadOutcome::Removed);
614 assert!(after.is_none());
615 let _ = fs::remove_dir_all(&dir);
616 }
617
618 #[test]
619 fn refresh_returns_loaded_first_on_initial_discovery() {
620 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
621 let dir = temp_dir("first");
622 fs::create_dir(dir.join(".git")).unwrap();
624 fs::write(dir.join("MERMAID.md"), "fresh").unwrap();
626 let (after, outcome) = refresh(None, &dir);
627 assert!(matches!(outcome, ReloadOutcome::LoadedFirst { .. }));
628 let content = after.unwrap().content;
629 assert!(content.contains("# Project Instructions: MERMAID.md"));
630 assert!(content.contains("fresh"));
631 let _ = fs::remove_dir_all(&dir);
632 }
633
634 #[test]
635 fn oversized_agents_does_not_drop_mermaid_winner() {
636 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
641 let dir = temp_dir("agents_huge");
642 fs::write(dir.join("AGENTS.md"), "A".repeat(60_000)).unwrap();
643 fs::write(dir.join("MERMAID.md"), "MERMAID_WINS_SENTINEL").unwrap();
644 let loaded =
645 load_from_paths(&[dir.join("AGENTS.md"), dir.join("MERMAID.md")]).expect("load");
646 assert!(loaded.truncated, "combined body exceeds the cap");
647 assert!(
648 loaded.content.contains("MERMAID_WINS_SENTINEL"),
649 "MERMAID.md (the winner) must survive the cap, not be dropped"
650 );
651 assert!(
652 loaded
653 .content
654 .contains("# Project Instructions: MERMAID.md")
655 );
656 assert!(loaded.content.contains(INSTRUCTIONS_TRUNCATION_MARKER));
657 let marker_at = loaded.content.find(INSTRUCTIONS_TRUNCATION_MARKER).unwrap();
660 let winner_at = loaded.content.find("MERMAID_WINS_SENTINEL").unwrap();
661 assert!(
662 winner_at > marker_at,
663 "MERMAID.md must come after the truncated AGENTS.md"
664 );
665 assert!(
667 loaded.content.len() <= MAX_INSTRUCTIONS_BYTES + INSTRUCTIONS_TRUNCATION_MARKER.len()
668 );
669 let _ = fs::remove_dir_all(&dir);
670 }
671
672 #[test]
673 fn combine_and_cap_protects_the_last_section() {
674 let lower = format!("# Project Instructions: AGENTS.md\n\n{}", "L".repeat(200));
677 let winner = "# Project Instructions: MERMAID.md\n\nWIN".to_string();
678 let (body, truncated) = combine_and_cap_sections(vec![lower, winner], 100);
679 assert!(truncated);
680 assert!(body.contains("WIN"), "winner survives the cap");
681 assert!(body.contains(INSTRUCTIONS_TRUNCATION_MARKER));
682 let marker_at = body.find(INSTRUCTIONS_TRUNCATION_MARKER).unwrap();
683 assert!(
684 body.find("WIN").unwrap() > marker_at,
685 "winner stays last so it overrides on conflict"
686 );
687 assert!(body.len() <= 100 + INSTRUCTIONS_TRUNCATION_MARKER.len());
688 }
689
690 #[test]
691 fn combine_and_cap_clips_winner_when_it_alone_overflows() {
692 let lower = "# Project Instructions: AGENTS.md\n\nlower-content".to_string();
695 let winner = format!("# Project Instructions: MERMAID.md\n\n{}", "W".repeat(300));
696 let (body, truncated) = combine_and_cap_sections(vec![lower, winner], 100);
697 assert!(truncated);
698 assert!(body.ends_with(INSTRUCTIONS_TRUNCATION_MARKER));
699 assert_eq!(body.len(), 100 + INSTRUCTIONS_TRUNCATION_MARKER.len());
700 assert!(
701 !body.contains("lower-content"),
702 "no room for the lower-precedence section"
703 );
704 }
705
706 #[test]
707 fn combine_and_cap_passes_through_when_it_fits() {
708 let a = "# Project Instructions: AGENTS.md\n\naye".to_string();
709 let b = "# Project Instructions: MERMAID.md\n\nbee".to_string();
710 let (body, truncated) = combine_and_cap_sections(vec![a, b], 10_000);
711 assert!(!truncated);
712 assert!(body.contains("aye") && body.contains("bee"));
713 assert!(
714 body.find("bee").unwrap() > body.find("aye").unwrap(),
715 "highest-precedence section stays last"
716 );
717 }
718
719 #[test]
720 fn load_from_paths_tolerates_a_missing_file() {
721 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
725 let dir = temp_dir("partial_load");
726 fs::write(dir.join("AGENTS.md"), "agent rules").unwrap();
727 let missing = dir.join("MERMAID.md"); let loaded = load_from_paths(&[dir.join("AGENTS.md"), missing])
729 .expect("AGENTS.md must still load when MERMAID.md is absent");
730 assert!(loaded.content.contains("# Project Instructions: AGENTS.md"));
731 assert!(loaded.content.contains("agent rules"));
732 assert_eq!(loaded.sources.len(), 1, "only the present file is a source");
733 assert_eq!(loaded.path, dir.join("AGENTS.md"));
734 let _ = fs::remove_dir_all(&dir);
735 }
736
737 #[test]
738 fn load_from_paths_none_when_all_missing() {
739 let _lock = FS_LOCK.lock().unwrap_or_else(|e| e.into_inner());
740 let dir = temp_dir("all_missing");
741 assert!(
742 load_from_paths(&[dir.join("AGENTS.md"), dir.join("MERMAID.md")]).is_none(),
743 "no present files => None"
744 );
745 let _ = fs::remove_dir_all(&dir);
746 }
747
748 #[test]
749 fn pick_home_boundary_resolves_windows_home_vars() {
750 use std::ffi::OsStr;
754 assert_eq!(
756 pick_home_boundary(
757 Some(OsStr::new("/home/me")),
758 Some(OsStr::new("C:\\Users\\me")),
759 None,
760 None
761 ),
762 Some(PathBuf::from("/home/me"))
763 );
764 assert_eq!(
766 pick_home_boundary(None, Some(OsStr::new("C:\\Users\\me")), None, None),
767 Some(PathBuf::from("C:\\Users\\me"))
768 );
769 assert_eq!(
771 pick_home_boundary(
772 None,
773 None,
774 Some(OsStr::new("C:")),
775 Some(OsStr::new("\\Users\\me"))
776 ),
777 Some(PathBuf::from("C:\\Users\\me"))
778 );
779 assert_eq!(
781 pick_home_boundary(Some(OsStr::new("")), Some(OsStr::new("")), None, None),
782 None
783 );
784 assert_eq!(
786 pick_home_boundary(None, None, Some(OsStr::new("C:")), None),
787 None
788 );
789 assert_eq!(
790 pick_home_boundary(None, None, None, Some(OsStr::new("\\Users\\me"))),
791 None
792 );
793 }
794}