#![allow(clippy::missing_errors_doc)]
use anyhow::Result;
use serde::Serialize;
use serde_json::Value;
use std::path::Path;
use crate::commands::set::parse_kv;
use crate::commands::{FilesOrOutcome, collect_files, mutation, require_file_or_glob};
use crate::output::{CommandOutcome, Format};
use hyalo_core::filter::{self, PropertyFilter};
use hyalo_core::frontmatter;
use hyalo_core::index::SnapshotIndex;
#[derive(Debug, Serialize)]
pub(crate) struct AppendPropertyResult {
pub(crate) property: String,
pub(crate) value: String,
pub(crate) modified: Vec<String>,
pub(crate) skipped: Vec<String>,
pub(crate) total: usize,
pub(crate) scanned: usize,
pub(crate) dry_run: bool,
}
fn append_value_in_memory(
props: &mut indexmap::IndexMap<String, Value>,
name: &str,
raw_value: &str,
new_val: &Value,
) -> Result<bool> {
match props.get(name).cloned() {
None | Some(Value::Null) => {
props.insert(name.to_owned(), Value::Array(vec![new_val.clone()]));
Ok(true)
}
Some(Value::Array(mut seq)) => {
let already_present = seq.iter().any(|v| match v {
Value::String(s) => s.eq_ignore_ascii_case(raw_value),
Value::Number(n) => n.to_string().eq_ignore_ascii_case(raw_value),
Value::Bool(b) => b.to_string().eq_ignore_ascii_case(raw_value),
_ => false,
});
if already_present {
Ok(false)
} else {
seq.push(new_val.clone());
props.insert(name.to_owned(), Value::Array(seq));
Ok(true)
}
}
Some(Value::String(existing)) => {
if existing.eq_ignore_ascii_case(raw_value) {
Ok(false)
} else {
let list = Value::Array(vec![Value::String(existing), new_val.clone()]);
props.insert(name.to_owned(), list);
Ok(true)
}
}
Some(Value::Number(n)) => {
if n.to_string().eq_ignore_ascii_case(raw_value) {
Ok(false)
} else {
let list = Value::Array(vec![Value::Number(n), new_val.clone()]);
props.insert(name.to_owned(), list);
Ok(true)
}
}
Some(Value::Bool(b)) => {
if b.to_string().eq_ignore_ascii_case(raw_value) {
Ok(false)
} else {
let list = Value::Array(vec![Value::Bool(b), new_val.clone()]);
props.insert(name.to_owned(), list);
Ok(true)
}
}
Some(other) => {
let kind = match &other {
Value::Object(_) => "mapping",
_ => "unknown",
};
anyhow::bail!("property '{name}' is a {kind} value — cannot append to it");
}
}
}
#[allow(clippy::too_many_arguments)]
pub fn append(
dir: &Path,
property_args: &[String],
files: &[String],
globs: &[String],
where_property_filters: &[PropertyFilter],
where_tag_filters: &[String],
format: Format,
snapshot_index: &mut Option<SnapshotIndex>,
index_path: Option<&Path>,
dry_run: bool,
) -> Result<CommandOutcome> {
if property_args.is_empty() {
let out = crate::output::format_error(
format,
"append requires at least one --property K=V",
None,
Some("example: hyalo append --property aliases=my-alias --file note.md"),
None,
);
return Ok(CommandOutcome::UserError(out));
}
if let Some(outcome) = require_file_or_glob(files, globs, "append", format) {
return Ok(outcome);
}
for arg in property_args {
match parse_kv(arg) {
Err(msg) => {
let out = crate::output::format_error(format, &msg, None, None, None);
return Ok(CommandOutcome::UserError(out));
}
Ok((key, _)) => {
if let Some(outcome) = super::reject_filter_in_mutation_property(key, format) {
return Ok(outcome);
}
}
}
}
let parsed_args: Vec<(&str, &str, Value)> = {
let mut v = Vec::with_capacity(property_args.len());
for arg in property_args {
let (name, raw_value) =
parse_kv(arg).map_err(|e| anyhow::anyhow!("invalid property argument: {e}"))?;
let parsed = frontmatter::parse_value(raw_value, None)
.map_err(|e| anyhow::anyhow!("failed to parse value for property '{name}': {e}"))?;
v.push((name, raw_value, parsed));
}
v
};
let files = collect_files(dir, files, globs, format)?;
let files = match files {
FilesOrOutcome::Files(f) => f,
FilesOrOutcome::Outcome(o) => return Ok(o),
};
let scanned = files.len();
let mut prop_results: Vec<(Vec<String>, Vec<String>)> =
vec![(Vec::new(), Vec::new()); parsed_args.len()];
let mut index_dirty = false;
for (full_path, rel_path) in &files {
let mut props = match frontmatter::read_frontmatter(full_path) {
Ok(p) => p,
Err(e) if frontmatter::is_parse_error(&e) => {
crate::warn::warn(format!("skipping {rel_path}: {e}"));
continue;
}
Err(e) => return Err(e),
};
if !filter::matches_frontmatter_filters(&props, where_property_filters, where_tag_filters) {
continue;
}
let mut file_changed = false;
for (i, (name, raw_value, new_val)) in parsed_args.iter().enumerate() {
match append_value_in_memory(&mut props, name, raw_value, new_val) {
Ok(true) => {
prop_results[i].0.push(rel_path.clone()); file_changed = true;
}
Ok(false) => {
prop_results[i].1.push(rel_path.clone()); }
Err(e) => return Err(e),
}
}
if file_changed && !dry_run {
frontmatter::write_frontmatter(full_path, &props)?;
mutation::update_index_entry(
snapshot_index,
rel_path,
props,
full_path,
&mut index_dirty,
)?;
}
}
if !dry_run {
mutation::save_index_if_dirty(snapshot_index, index_path, index_dirty)?;
}
let mut results: Vec<serde_json::Value> = Vec::new();
for ((name, raw_value, _), (modified, skipped)) in
parsed_args.iter().zip(prop_results.into_iter())
{
let total = modified.len() + skipped.len();
let result = AppendPropertyResult {
property: (*name).to_owned(),
value: (*raw_value).to_owned(),
modified,
skipped,
total,
scanned,
dry_run,
};
results
.push(serde_json::to_value(&result).expect("derived Serialize impl should not fail"));
}
let output = mutation::unwrap_single_result(results);
Ok(CommandOutcome::success(crate::output::format_success(
format, &output,
)))
}
#[cfg(test)]
mod tests {
use super::*;
use std::fs;
macro_rules! md {
($s:expr) => {
$s.strip_prefix('\n').unwrap_or($s)
};
}
#[test]
fn append_creates_new_list() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
title: Note
---
"),
)
.unwrap();
let outcome = append(
tmp.path(),
&["aliases=my-note".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert_eq!(parsed["property"], "aliases");
assert_eq!(parsed["value"], "my-note");
assert_eq!(parsed["modified"].as_array().unwrap().len(), 1);
let content = fs::read_to_string(tmp.path().join("note.md")).unwrap();
assert!(content.contains("my-note"));
}
#[test]
fn append_to_existing_list() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
aliases:
- old-name
---
"),
)
.unwrap();
append(
tmp.path(),
&["aliases=new-name".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let content = fs::read_to_string(tmp.path().join("note.md")).unwrap();
assert!(content.contains("old-name"));
assert!(content.contains("new-name"));
}
#[test]
fn append_to_list_skips_duplicate() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
aliases:
- my-note
---
"),
)
.unwrap();
let outcome = append(
tmp.path(),
&["aliases=my-note".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert_eq!(parsed["skipped"].as_array().unwrap().len(), 1);
assert_eq!(parsed["modified"].as_array().unwrap().len(), 0);
}
#[test]
fn append_promotes_scalar_string() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
author: Alice
---
"),
)
.unwrap();
append(
tmp.path(),
&["author=Bob".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let content = fs::read_to_string(tmp.path().join("note.md")).unwrap();
assert!(content.contains("Alice"));
assert!(content.contains("Bob"));
assert!(content.contains("- "));
}
#[test]
fn append_promotes_scalar_skips_duplicate() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
author: Alice
---
"),
)
.unwrap();
let outcome = append(
tmp.path(),
&["author=Alice".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert_eq!(parsed["skipped"].as_array().unwrap().len(), 1);
}
#[test]
fn append_multiple_returns_array() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
title: Note
---
"),
)
.unwrap();
let outcome = append(
tmp.path(),
&["aliases=a".to_owned(), "tags=rust".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert!(parsed.is_array());
assert_eq!(parsed.as_array().unwrap().len(), 2);
}
#[test]
fn append_requires_file_or_glob() {
let tmp = tempfile::tempdir().unwrap();
let outcome = append(
tmp.path(),
&["aliases=x".to_owned()],
&[],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
#[test]
fn append_requires_at_least_one_property() {
let tmp = tempfile::tempdir().unwrap();
let outcome = append(
tmp.path(),
&[],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
#[test]
fn append_invalid_kv_returns_user_error() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("note.md"), "---\ntitle: x\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["no-equals-sign".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
#[test]
fn append_empty_key_returns_user_error() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("note.md"), "---\ntitle: x\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["=value".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
#[test]
fn append_preserves_body() {
let tmp = tempfile::tempdir().unwrap();
let body = "# Heading\n\nSome content.\n";
fs::write(
tmp.path().join("note.md"),
format!("---\ntitle: Note\n---\n{body}"),
)
.unwrap();
append(
tmp.path(),
&["aliases=my-note".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let content = fs::read_to_string(tmp.path().join("note.md")).unwrap();
assert!(content.contains(body), "body was corrupted:\n{content}");
}
#[test]
fn append_multiple_properties_single_read_write() {
let tmp = tempfile::tempdir().unwrap();
fs::write(
tmp.path().join("note.md"),
md!(r"
---
title: Note
---
"),
)
.unwrap();
let outcome = append(
tmp.path(),
&["aliases=a".to_owned(), "aliases=b".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert!(parsed.is_array());
let content = fs::read_to_string(tmp.path().join("note.md")).unwrap();
assert!(content.contains('a'));
assert!(content.contains('b'));
}
#[test]
fn append_where_property_filter_skips_nonmatching() {
use hyalo_core::filter::parse_property_filter;
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("match.md"), "---\nstatus: draft\n---\n").unwrap();
fs::write(
tmp.path().join("no-match.md"),
"---\nstatus: published\n---\n",
)
.unwrap();
let filter = parse_property_filter("status=draft").unwrap();
let outcome = append(
tmp.path(),
&["aliases=draft-copy".to_owned()],
&[],
&["*.md".to_owned()],
&[filter],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert_eq!(parsed["modified"].as_array().unwrap().len(), 1);
assert_eq!(parsed["scanned"].as_u64().unwrap(), 2);
assert!(parsed["scanned"].as_u64().unwrap() > parsed["total"].as_u64().unwrap());
let match_content = fs::read_to_string(tmp.path().join("match.md")).unwrap();
assert!(match_content.contains("draft-copy"));
let no_match_content = fs::read_to_string(tmp.path().join("no-match.md")).unwrap();
assert!(!no_match_content.contains("draft-copy"));
}
#[test]
fn append_where_tag_filter_skips_nonmatching() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("tagged.md"), "---\ntags:\n - rust\n---\n").unwrap();
fs::write(tmp.path().join("untagged.md"), "---\ntitle: Other\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["aliases=rust-note".to_owned()],
&[],
&["*.md".to_owned()],
&[],
&["rust".to_owned()],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
let CommandOutcome::Success { output: out, .. } = outcome else {
panic!("expected success")
};
let parsed: serde_json::Value = serde_json::from_str(&out).unwrap();
assert_eq!(parsed["modified"].as_array().unwrap().len(), 1);
assert_eq!(parsed["scanned"].as_u64().unwrap(), 2);
assert!(parsed["scanned"].as_u64().unwrap() > parsed["total"].as_u64().unwrap());
let tagged_content = fs::read_to_string(tmp.path().join("tagged.md")).unwrap();
assert!(tagged_content.contains("rust-note"));
let untagged_content = fs::read_to_string(tmp.path().join("untagged.md")).unwrap();
assert!(!untagged_content.contains("rust-note"));
}
#[test]
fn append_rejects_gte_filter_in_property() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("note.md"), "---\ntitle: x\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["priority>=3".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
match outcome {
CommandOutcome::UserError(msg) => {
assert!(msg.contains("--where-property"), "msg: {msg}");
}
other => panic!("expected UserError, got: {other:?}"),
}
}
#[test]
fn append_rejects_neq_filter_in_property() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("note.md"), "---\ntitle: x\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["status!=draft".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
#[test]
fn append_rejects_regex_filter_in_property() {
let tmp = tempfile::tempdir().unwrap();
fs::write(tmp.path().join("note.md"), "---\ntitle: x\n---\n").unwrap();
let outcome = append(
tmp.path(),
&["name~=pattern".to_owned()],
&["note.md".to_owned()],
&[],
&[],
&[],
Format::Json,
&mut None,
None,
false,
)
.unwrap();
assert!(matches!(outcome, CommandOutcome::UserError(_)));
}
}