public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2026-08-28 14:27:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: merge upstream main into history revision branch

Browse Source
This commit is contained in:
SeleiXi
2026-07-29 23:45:12 +08:00
parent c4d6b768da b22c1bd777
commit 8b7d410327
996 changed files with 75371 additions and 43489 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/modules/features/DocumentHistory/DocumentHistoryModal.ts
+24 -19
View File
@@ -1,6 +1,6 @@
import { TFile, Modal, App, DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, diff_match_patch } from "@/deps.ts";
import { getPathFromTFile, isValidPath } from "@/common/utils.ts";
import { decodeBinary, readString } from "@lib/string_and_binary/convert.ts";
import { decodeBinary, readString } from "@vrtmrz/livesync-commonlib/compat/string_and_binary/convert";
import ObsidianLiveSyncPlugin from "@/main.ts";
import {
type DocumentID,
@@ -9,14 +9,20 @@ import {
LOG_LEVEL_INFO,
LOG_LEVEL_NOTICE,
LOG_LEVEL_VERBOSE,
} from "@lib/common/types.ts";
import { Logger } from "@lib/common/logger.ts";
import { isErrorOfMissingDoc } from "@lib/pouchdb/utils_couchdb.ts";
import { fireAndForget, getDocData, readContent } from "@lib/common/utils.ts";
import { isPlainText, stripPrefix } from "@lib/string_and_binary/path.ts";
} from "@vrtmrz/livesync-commonlib/compat/common/types";
import { Logger } from "@vrtmrz/livesync-commonlib/compat/common/logger";
import { isErrorOfMissingDoc } from "@vrtmrz/livesync-commonlib/compat/pouchdb/utils_couchdb";
import { fireAndForget, getDocData, readContent } from "@vrtmrz/livesync-commonlib/compat/common/utils";
import { isPlainText, stripPrefix } from "@vrtmrz/livesync-commonlib/compat/string_and_binary/path";
import { scheduleOnceIfDuplicated } from "octagonal-wheels/concurrency/lock";
import type { LiveSyncBaseCore } from "@/LiveSyncBaseCore.ts";
import { compatGlobal } from "@lib/common/coreEnvFunctions.ts";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
import {
DOCUMENT_HISTORY_PREFERENCE_KEYS,
loadDocumentHistoryPreference,
saveDocumentHistoryPreference,
} from "./documentHistoryPreferences.ts";
import type PouchDB from "pouchdb-core";
function isImage(path: string) {
const ext = path.split(".").splice(-1)[0].toLowerCase();
@@ -106,12 +112,10 @@ export class DocumentHistoryModal extends Modal {
if (!file && id) {
this.file = this.services.path.id2path(id);
}
// eslint-disable-next-line obsidianmd/no-unsupported-api -- loadLocalStorage is supported in Obsidian 1.7.2+
if (this.app.loadLocalStorage("ols-history-highlightdiff") == "1") {
if (loadDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff)) {
this.showDiff = true;
}
// eslint-disable-next-line obsidianmd/no-unsupported-api -- loadLocalStorage is supported in Obsidian 1.7.2+
if (this.app.loadLocalStorage("ols-history-diffonly") == "1") {
if (loadDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly)) {
this.diffOnly = true;
}
}
@@ -567,10 +571,10 @@ export class DocumentHistoryModal extends Modal {
e.addEventListener("click", () => this.navigateSearch("next"));
});
this.searchResultIndicator = searchRow.createEl("span", { text: "" });
this.searchResultIndicator = searchRow.createSpan({ text: "" });
this.searchResultIndicator.addClass("history-search-result-indicator");
this.searchProgressIndicator = searchRow.createEl("span", { text: "" });
this.searchProgressIndicator = searchRow.createSpan({ text: "" });
this.searchProgressIndicator.addClass("history-search-progress-indicator");
const revNavRow = contentEl.createDiv({ cls: "history-rev-nav-row" });
@@ -620,8 +624,11 @@ export class DocumentHistoryModal extends Modal {
}
checkbox.addEventListener("input", (evt: Event) => {
this.showDiff = checkbox.checked;
// eslint-disable-next-line obsidianmd/no-unsupported-api -- saveLocalStorage is supported in Obsidian 1.7.2+
this.app.saveLocalStorage("ols-history-highlightdiff", this.showDiff == true ? "1" : null);
saveDocumentHistoryPreference(
this.app,
DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff,
this.showDiff
);
this.updateDiffNavVisibility();
void scheduleOnceIfDuplicated("loadRevs", () => this.loadRevs());
});
@@ -636,8 +643,7 @@ export class DocumentHistoryModal extends Modal {
}
checkbox.addEventListener("input", (evt: Event) => {
this.diffOnly = checkbox.checked;
// eslint-disable-next-line obsidianmd/no-unsupported-api -- saveLocalStorage is supported in Obsidian 1.7.2+
this.app.saveLocalStorage("ols-history-diffonly", this.diffOnly == true ? "1" : null);
saveDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly, this.diffOnly);
void scheduleOnceIfDuplicated("loadRevs", () => this.loadRevs());
});
});
@@ -663,7 +669,7 @@ export class DocumentHistoryModal extends Modal {
this.navigateDiff("next");
});
});
this.diffNavIndicator = this.diffNavContainer.createEl("span", { text: "\u2014" });
this.diffNavIndicator = this.diffNavContainer.createSpan({ text: "\u2014" });
this.diffNavIndicator.addClass("diff-nav-indicator");
this.info = contentEl.createDiv("");
@@ -718,7 +724,6 @@ export class DocumentHistoryModal extends Modal {
const { contentEl } = this;
contentEl.empty();
this.BlobURLs.forEach((value) => {
console.log(value);
if (value) URL.revokeObjectURL(value);
});
}
src/modules/features/DocumentHistory/documentHistoryPreferences.ts
+22
View File
@@ -0,0 +1,22 @@
import { requireApiVersion, type App } from "@/deps.ts";
export const DOCUMENT_HISTORY_PREFERENCE_KEYS = {
diffOnly: "ols-history-diffonly",
highlightDiff: "ols-history-highlightdiff",
} as const;
export type DocumentHistoryPreferenceKey =
(typeof DOCUMENT_HISTORY_PREFERENCE_KEYS)[keyof typeof DOCUMENT_HISTORY_PREFERENCE_KEYS];
export function loadDocumentHistoryPreference(app: App, key: DocumentHistoryPreferenceKey): boolean {
if (requireApiVersion("1.8.7")) {
return app.loadLocalStorage(key) === "1";
}
return false;
}
export function saveDocumentHistoryPreference(app: App, key: DocumentHistoryPreferenceKey, enabled: boolean): void {
if (requireApiVersion("1.8.7")) {
app.saveLocalStorage(key, enabled ? "1" : null);
}
}
src/modules/features/DocumentHistory/documentHistoryPreferences.unit.spec.ts
+52
View File
@@ -0,0 +1,52 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
const requireApiVersionMock = vi.hoisted(() => vi.fn<(version: string) => boolean>());
vi.mock("@/deps.ts", () => ({
requireApiVersion: requireApiVersionMock,
}));
import {
DOCUMENT_HISTORY_PREFERENCE_KEYS,
loadDocumentHistoryPreference,
saveDocumentHistoryPreference,
} from "./documentHistoryPreferences.ts";
function createAppStorage() {
return {
loadLocalStorage: vi.fn<(key: string) => unknown>(),
saveLocalStorage: vi.fn<(key: string, value: unknown | null) => void>(),
};
}
describe("document history preferences", () => {
beforeEach(() => {
requireApiVersionMock.mockReset();
});
it("falls back without accessing Vault local storage on older Obsidian versions", () => {
requireApiVersionMock.mockReturnValue(false);
const app = createAppStorage();
expect(loadDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff)).toBe(false);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly, true);
expect(requireApiVersionMock).toHaveBeenCalledWith("1.8.7");
expect(app.loadLocalStorage).not.toHaveBeenCalled();
expect(app.saveLocalStorage).not.toHaveBeenCalled();
});
it("loads and saves Vault-scoped preferences when the API is available", () => {
requireApiVersionMock.mockReturnValue(true);
const app = createAppStorage();
app.loadLocalStorage.mockReturnValue("1");
expect(loadDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly)).toBe(true);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff, true);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff, false);
expect(app.loadLocalStorage).toHaveBeenCalledWith("ols-history-diffonly");
expect(app.saveLocalStorage).toHaveBeenNthCalledWith(1, "ols-history-highlightdiff", "1");
expect(app.saveLocalStorage).toHaveBeenNthCalledWith(2, "ols-history-highlightdiff", null);
});
});