admin/basicmachines-co-basic-memory
1
0
Fork 0
mirror of https://github.com/basicmachines-co/basic-memory synced 2026-06-21 13:47:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): rename read-note --include-frontmatter to --frontmatter

Browse Source 
Keep --include-frontmatter as a deprecated alias for back-compat (the old
name shipped in 0.22.0). The MCP tool parameter include_frontmatter is
unchanged.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Drew Cain <groksrc@gmail.com>
This commit is contained in:
Drew Cain
2026-06-12 11:35:16 -05:00
parent 6d2ff99b8f
commit 83f60054df
2 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/cli/test_cli_tool_rich_output.py
+15 -2
View File
@@ -456,7 +456,7 @@ def test_read_note_rich_include_frontmatter(mock_mcp):
frontmatter block must be stripped from the Markdown body or it renders
again under the panel.
"""
result = _tty_runner(["tool", "read-note", "test-note", "--include-frontmatter"])
result = _tty_runner(["tool", "read-note", "test-note", "--frontmatter"])
assert result.exit_code == 0, f"CLI failed: {result.output}"
# Frontmatter panel appears with key/value data
@@ -776,7 +776,7 @@ def test_read_note_plain_include_frontmatter(mock_mcp):
With the flag, content IS the file (frontmatter block included); plain mode
prints it verbatim and must not prepend a synthesized key/value block.
"""
result = _tty_runner(["tool", "read-note", "test-note", "--plain", "--include-frontmatter"])
result = _tty_runner(["tool", "read-note", "test-note", "--plain", "--frontmatter"])
assert result.exit_code == 0, f"CLI failed: {result.output}"
# ONLY the literal file: no header line, output starts at the fence
@@ -787,6 +787,19 @@ def test_read_note_plain_include_frontmatter(mock_mcp):
assert result.output.count("title: Test Note") == 1
@patch(
"basic_memory.cli.commands.tool.mcp_read_note",
new_callable=AsyncMock,
return_value=READ_NOTE_RESULT_WITH_FRONTMATTER,
)
def test_read_note_include_frontmatter_alias(mock_mcp):
"""--include-frontmatter still works as a deprecated alias for --frontmatter."""
result = _tty_runner(["tool", "read-note", "test-note", "--plain", "--include-frontmatter"])
assert result.exit_code == 0, f"CLI failed: {result.output}"
assert result.output.startswith("---\ntitle: Test Note")
@patch(
"basic_memory.cli.commands.tool.mcp_read_note",
new_callable=AsyncMock,