vvzvlad/gitmost
1
0
Fork 0
Code Issues 14 Pull Requests 12 Packages Projects Releases Activity

feat(git-sync): drop legacy docmost:meta back-compat (vaults wipe+rebuild)

Browse Source 
Per owner: test data, no migration. parsePageFile no longer reads the old
docmost:meta block — a file without a gitmost_id frontmatter is simply un-tracked
(adopt). Vaults are a cache: rm -rf on the transition, rebuilt native from
Docmost. Simplifies the format work (no fallback). Doc updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
claude code agent 227
2026-06-24 04:28:35 +03:00
parent d8007480ac
commit 0c916ca086
3 changed files with 19 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/git-sync/src/lib/page-file.ts
View File

@@ -1,25 +1,22 @@
import { parseDocmostMarkdown } from "./markdown-document";
/**
* The THIN page-file format (design: docs/backlog/git-sync-thin-meta.md, option
* C). A page file is CLEAN markdown with a minimal YAML frontmatter carrying ONLY
* the page's durable identity:
* The native-Obsidian page-file format (design: docs/backlog/git-sync-thin-meta.md).
* A page file is CLEAN markdown with a minimal YAML frontmatter carrying ONLY the
* page's durable identity:
*
* ---
* id: 019ef6fc-2638-7ce1-9ce3-2756ce038480
* gitmost_id: 019ef6fc-2638-7ce1-9ce3-2756ce038480
* ---
* <clean markdown body>
*
* Everything else is derived (title = filename, parentPageId = enclosing folder,
* spaceId = the vault, updatedAt = git). The `id` (a Docmost pageId) is the only
* non-derivable bit and travels WITH the file so identity survives any move,
* spaceId = the vault, updatedAt = git). `gitmost_id` (a Docmost pageId) is the
* only non-derivable bit and travels WITH the file so identity survives any move,
* even one git's rename detection misses. Third-party editors (Obsidian, …) see
* clean markdown; the frontmatter is hidden in their preview.
*
* MIGRATION: a file may still carry the LEGACY `<!-- docmost:meta {…} -->` block
* (the pre-thin format). `parsePageFile` reads the id from the frontmatter first,
* then falls back to the legacy meta — so old vaults keep working and a re-sync
* rewrites them into the thin format.
* No backward-compat with the old `docmost:meta` format: vaults are a cache, wiped
* and rebuilt native. A file WITHOUT a `gitmost_id` frontmatter is an un-tracked
* (e.g. hand-written) file -> the caller ADOPTS it (creates a page, writes the id).
*/
/**
@@ -56,23 +53,12 @@ export function parsePageFile(full: string): {
} {
const text = (full ?? "").replace(/\r\n/g, "\n");
// 1. Thin format: YAML frontmatter.
// Native format: a `gitmost_id` YAML frontmatter. Anything else (no frontmatter,
// or frontmatter without the key) is an un-tracked file -> adopt.
const fm = text.match(FRONTMATTER_RE);
if (fm) {
return { id: readIdFromYaml(fm[1]), body: text.slice(fm[0].length).trim() };
}
// 2. Legacy format: `<!-- docmost:meta -->` block (migration fallback).
if (/^\s*<!--\s*docmost:meta/.test(text)) {
try {
const { meta, body } = parseDocmostMarkdown(text);
return { id: meta?.pageId ?? null, body };
} catch {
// a corrupt legacy block -> treat as an un-tracked plain file (adopt).
}
}
// 3. Plain markdown — un-tracked (no identity yet).
return { id: null, body: text.trim() };
}

10
packages/git-sync/test/page-file.test.ts
View File

@@ -1,6 +1,5 @@
import { describe, it, expect } from "vitest";
import { parsePageFile, serializePageFile } from "../src/lib/page-file";
import { serializeDocmostMarkdownBody } from "../src/lib/index";
describe("page-file thin format", () => {
it("round-trips id frontmatter + clean body", () => {
@@ -20,15 +19,6 @@ describe("page-file thin format", () => {
expect(parsePageFile("---\ngitmost_id: 'xyz'\n---\nbody").id).toBe("xyz");
});
it("MIGRATION: falls back to a legacy docmost:meta block for the id", () => {
const legacy = serializeDocmostMarkdownBody(
{ version: 1, pageId: "legacy-1", title: "T", spaceId: "sp" },
"old body",
);
const { id, body } = parsePageFile(legacy);
expect(id).toBe("legacy-1");
expect(body).toContain("old body");
});
it("ADOPT: a plain hand-written file has no id and keeps its whole body", () => {
const { id, body } = parsePageFile("# Just a note\n\nwritten in Obsidian");