From ce31969a445afc2fe2f91f6be6efbe58783bd32a Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Sun, 7 Dec 2025 14:44:42 +0000 Subject: [PATCH] Fix and apply editorconfig --- .editorconfig | 3 +- .github/workflows/check.yml | 2 +- docs/architecture/data-flow.md | 264 +++++----- docs/architecture/index.md | 8 +- docs/config/authentication.md | 6 +- frontend/local-client-cli/tsconfig.json | 6 +- frontend/local-client-cli/webpack.config.js | 56 +-- .../obsidian-plugin/src/vault-link-plugin.ts | 452 +++++++++--------- frontend/obsidian-plugin/tsconfig.json | 32 +- scripts/check.sh | 11 +- scripts/e2e.sh | 1 - 11 files changed, 423 insertions(+), 418 deletions(-) diff --git a/.editorconfig b/.editorconfig index 7074dff5..ade62e59 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,5 +11,6 @@ indent_style = space indent_size = 4 tab_width = 4 -[*.{yml,yaml}] +[*.{yml,yaml,md}] indent_size = 2 +tab_width = 2 diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index e2421e27..f3fad1df 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -22,7 +22,7 @@ jobs: with: node-version: "22.x" check-latest: true - + - name: Setup Rust toolchain uses: dtolnay/rust-toolchain@stable with: diff --git a/docs/architecture/data-flow.md b/docs/architecture/data-flow.md index 5b256f1d..832c5624 100644 --- a/docs/architecture/data-flow.md +++ b/docs/architecture/data-flow.md @@ -125,37 +125,37 @@ sequenceDiagram ``` ┌─────────┐ │ Client │ -└────┬────┘ - │ 1. Detect file change - │ - ├─► 2. Read file content - │ - ├─► 3. Create upload message - │ { - │ type: "upload_file", - │ path: "notes/daily.md", - │ content: "...", - │ version: 42, - │ timestamp: "2024-01-01T12:00:00Z" - │ } - │ - ▼ +└───┬─-───┘ + │ 1. Detect file change + │ + ├─► 2. Read file content + │ + ├─► 3. Create upload message + │ { + │ type: "upload_file", + │ path: "notes/daily.md", + │ content: "...", + │ version: 42, + │ timestamp: "2024-01-01T12:00:00Z" + │ } + │ + ▼ ┌─────────┐ │ Server │ -└────┬────┘ - │ 4. Validate message - │ - ├─► 5. Check permissions - │ - ├─► 6. Apply OT (if conflicts) - │ - ├─► 7. Store in database - │ - ├─► 8. Update version - │ - ├─► 9. Broadcast to clients - │ - └─► 10. Send ACK to uploader +└───┬────-┘ + │ 4. Validate message + │ + ├─► 5. Check permissions + │ + ├─► 6. Apply OT (if conflicts) + │ + ├─► 7. Store in database + │ + ├─► 8. Update version + │ + ├─► 9. Broadcast to clients + │ + └─► 10. Send ACK to uploader ``` ### Download @@ -163,36 +163,36 @@ sequenceDiagram ``` ┌─────────┐ │ Server │ -└────┬────┘ - │ 1. File updated by another client - │ - ├─► 2. Broadcast notification - │ { - │ type: "file_updated", - │ path: "notes/daily.md", - │ version: 43 - │ } - │ - ▼ +└───┬─-───┘ + │ 1. File updated by another client + │ + ├─► 2. Broadcast notification + │ { + │ type: "file_updated", + │ path: "notes/daily.md", + │ version: 43 + │ } + │ + ▼ ┌─────────┐ │ Client │ -└────┬────┘ - │ 3. Receive notification - │ - ├─► 4. Request file download - │ { - │ type: "download_file", - │ path: "notes/daily.md", - │ version: 43 - │ } - │ - ▼ +└───┬─-───┘ + │ 3. Receive notification + │ + ├─► 4. Request file download + │ { + │ type: "download_file", + │ path: "notes/daily.md", + │ version: 43 + │ } + │ + ▼ ┌─────────┐ │ Server │ -└────┬────┘ - │ 5. Retrieve from database - │ - └─► 6. Send file content +└───┬─=───┘ + │ 5. Retrieve from database + │ + └─► 6. Send file content { type: "file_content", path: "notes/daily.md", @@ -201,9 +201,9 @@ sequenceDiagram } │ ▼ - ┌─────────┐ - │ Client │ - └────┬────┘ + ┌─────────┐ + │ Client │ + └───-─┬───┘ │ 7. Write to filesystem │ └─► 8. Update local metadata @@ -215,30 +215,30 @@ sequenceDiagram ┌─────────┐ │ Client │ └────┬────┘ - │ 1. File deleted locally - │ - ├─► 2. Send delete message - │ { - │ type: "delete_file", - │ path: "notes/old.md" - │ } - │ - ▼ + │ 1. File deleted locally + │ + ├─► 2. Send delete message + │ { + │ type: "delete_file", + │ path: "notes/old.md" + │ } + │ + ▼ ┌─────────┐ │ Server │ └────┬────┘ - │ 3. Mark as deleted in DB - │ (soft delete for history) - │ - ├─► 4. Broadcast deletion - │ - └─► 5. ACK to sender + │ 3. Mark as deleted in DB + │ (soft delete for history) + │ + ├─► 4. Broadcast deletion + │ + └─► 5. ACK to sender │ ▼ - ┌─────────┐ - │ Other │ - │ Clients │ - └────┬────┘ + ┌─────────┐ + │ Other │ + │ Clients │ + └────┬────┘ │ 6. Delete local file │ └─► 7. Update metadata @@ -252,32 +252,32 @@ sequenceDiagram Time → Client A Server Client B - │ │ │ - │ Edit file v10 │ │ - │ "Add line A" │ │ Edit file v10 - │ │ │ "Add line B" - │ │ │ - ├─── Upload @ t1 ─────────►│ │ - │ │◄────── Upload @ t2 ────────┤ - │ │ │ - │ │ 1. Receive both edits │ - │ │ (based on v10) │ - │ │ │ - │ │ 2. Apply first edit │ - │ │ → v11 (line A added) │ - │ │ │ - │ │ 3. Transform second edit │ - │ │ against first │ - │ │ │ - │ │ 4. Apply transformed edit │ - │ │ → v12 (both lines) │ - │ │ │ - │◄──── v12 content ────────┤ │ - │ ├───── v12 content ─────────►│ - │ │ │ - │ Apply v12 │ │ Apply v12 - │ (has both lines) │ │ (has both lines) - │ │ │ + │ │ │ + │ Edit file v10 │ │ + │ "Add line A" │ │ Edit file v10 + │ │ │ "Add line B" + │ │ │ + ├─── Upload @ t1 ─────────►│ │ + │ │◄────── Upload @ t2 ────────┤ + │ │ │ + │ │ 1. Receive both edits │ + │ │ (based on v10) │ + │ │ │ + │ │ 2. Apply first edit │ + │ │ → v11 (line A added) │ + │ │ │ + │ │ 3. Transform second edit │ + │ │ against first │ + │ │ │ + │ │ 4. Apply transformed edit │ + │ │ → v12 (both lines) │ + │ │ │ + │◄──── v12 content ────────┤ │ + │ ├───── v12 content ─────────►│ + │ │ │ + │ Apply v12 │ │ Apply v12 + │ (has both lines) │ │ (has both lines) + │ │ │ ``` ### Conflict Resolution Steps @@ -361,11 +361,11 @@ VALUES (?, ?, ?); ```json { - "type": "upload_file", - "path": "notes/example.md", - "content": "File content here...", - "base_version": 10, - "timestamp": "2024-01-01T12:00:00Z" + "type": "upload_file", + "path": "notes/example.md", + "content": "File content here...", + "base_version": 10, + "timestamp": "2024-01-01T12:00:00Z" } ``` @@ -373,8 +373,8 @@ VALUES (?, ?, ?); ```json { - "type": "download_file", - "path": "notes/example.md" + "type": "download_file", + "path": "notes/example.md" } ``` @@ -382,8 +382,8 @@ VALUES (?, ?, ?); ```json { - "type": "delete_file", - "path": "notes/old.md" + "type": "delete_file", + "path": "notes/old.md" } ``` @@ -391,8 +391,8 @@ VALUES (?, ?, ?); ```json { - "type": "list_files", - "since_version": 0 + "type": "list_files", + "since_version": 0 } ``` @@ -402,11 +402,11 @@ VALUES (?, ?, ?); ```json { - "type": "file_updated", - "path": "notes/example.md", - "version": 11, - "size": 1024, - "hash": "abc123..." + "type": "file_updated", + "path": "notes/example.md", + "version": 11, + "size": 1024, + "hash": "abc123..." } ``` @@ -414,10 +414,10 @@ VALUES (?, ?, ?); ```json { - "type": "file_content", - "path": "notes/example.md", - "content": "Updated content...", - "version": 11 + "type": "file_content", + "path": "notes/example.md", + "content": "Updated content...", + "version": 11 } ``` @@ -425,9 +425,9 @@ VALUES (?, ?, ?); ```json { - "type": "file_deleted", - "path": "notes/old.md", - "version": 12 + "type": "file_deleted", + "path": "notes/old.md", + "version": 12 } ``` @@ -435,9 +435,9 @@ VALUES (?, ?, ?); ```json { - "type": "sync_complete", - "total_files": 150, - "current_version": 200 + "type": "sync_complete", + "total_files": 150, + "current_version": 200 } ``` @@ -445,9 +445,9 @@ VALUES (?, ?, ?); ```json { - "type": "error", - "message": "File too large", - "code": "FILE_TOO_LARGE" + "type": "error", + "message": "File too large", + "code": "FILE_TOO_LARGE" } ``` diff --git a/docs/architecture/index.md b/docs/architecture/index.md index 5d4c6d73..f5eca5e3 100644 --- a/docs/architecture/index.md +++ b/docs/architecture/index.md @@ -11,10 +11,10 @@ Central sync server with multiple clients. High-level architecture and design de │ Obsidian Plugin │ Obsidian Plugin │ CLI Client │ │ (User A - Device1) │ (User A - Device2│ (Server/Backup) │ └──────────┬──────────┴─────────┬─────────┴──────────┬────────┘ - │ │ │ - │ WebSocket │ WebSocket │ WebSocket - │ │ │ - └────────────────────┼────────────────────┘ + │ │ │ + │ WebSocket │ WebSocket │ WebSocket + │ │ │ + └────────────────────┼────────────────────┘ │ ┌───────────▼───────────┐ │ Sync Server │ diff --git a/docs/config/authentication.md b/docs/config/authentication.md index 944e56f2..11425b5b 100644 --- a/docs/config/authentication.md +++ b/docs/config/authentication.md @@ -243,9 +243,9 @@ users: 2. Client sends authentication message: ```json { - "type": "auth", - "token": "user-token", - "vault": "vault-name" + "type": "auth", + "token": "user-token", + "vault": "vault-name" } ``` 3. Server validates: diff --git a/frontend/local-client-cli/tsconfig.json b/frontend/local-client-cli/tsconfig.json index ce04f662..25f249c9 100644 --- a/frontend/local-client-cli/tsconfig.json +++ b/frontend/local-client-cli/tsconfig.json @@ -4,7 +4,7 @@ "module": "ESNext", "lib": [ "DOM", // to get `fetch` & `WebSocket` - "ES2024" + "ES2024" ], "outDir": "./dist", "rootDir": "./src", @@ -18,5 +18,7 @@ "declarationMap": true, "sourceMap": true }, - "exclude": ["dist"] + "exclude": [ + "dist" + ] } diff --git a/frontend/local-client-cli/webpack.config.js b/frontend/local-client-cli/webpack.config.js index 32b3b125..f8f48534 100644 --- a/frontend/local-client-cli/webpack.config.js +++ b/frontend/local-client-cli/webpack.config.js @@ -2,32 +2,32 @@ const path = require("path"); const webpack = require("webpack"); module.exports = { - entry: { - cli: "./src/cli.ts", - healthcheck: "./src/healthcheck.ts" - }, - target: "node", - mode: "production", - optimization: { - minimize: false - }, - module: { - rules: [ - { - test: /\.ts$/, - use: "ts-loader" - } - ] - }, - resolve: { - extensions: [".ts", ".js"] - }, - output: { - globalObject: "this", - filename: "[name].js", - path: path.resolve(__dirname, "dist") - }, - plugins: [ - new webpack.BannerPlugin({ banner: "#!/usr/bin/env node", raw: true }) - ] + entry: { + cli: "./src/cli.ts", + healthcheck: "./src/healthcheck.ts" + }, + target: "node", + mode: "production", + optimization: { + minimize: false + }, + module: { + rules: [ + { + test: /\.ts$/, + use: "ts-loader" + } + ] + }, + resolve: { + extensions: [".ts", ".js"] + }, + output: { + globalObject: "this", + filename: "[name].js", + path: path.resolve(__dirname, "dist") + }, + plugins: [ + new webpack.BannerPlugin({ banner: "#!/usr/bin/env node", raw: true }) + ] }; diff --git a/frontend/obsidian-plugin/src/vault-link-plugin.ts b/frontend/obsidian-plugin/src/vault-link-plugin.ts index 54e302f8..12ba1060 100644 --- a/frontend/obsidian-plugin/src/vault-link-plugin.ts +++ b/frontend/obsidian-plugin/src/vault-link-plugin.ts @@ -1,9 +1,9 @@ import type { - MarkdownView, - Editor, - MarkdownFileInfo, - TAbstractFile, - WorkspaceLeaf + MarkdownView, + Editor, + MarkdownFileInfo, + TAbstractFile, + WorkspaceLeaf } from "obsidian"; import { Notice, Platform, Plugin, TFile } from "obsidian"; import "../manifest.json"; @@ -12,19 +12,19 @@ import { StatusBar } from "./views/status-bar/status-bar"; import { LogsView } from "./views/logs/logs-view"; import { StatusDescription } from "./views/status-description/status-description"; import { - SyncClient, - rateLimit, - DEFAULT_SETTINGS, - Logger, - debugging + SyncClient, + rateLimit, + DEFAULT_SETTINGS, + Logger, + debugging } from "sync-client"; import { ObsidianFileSystemOperations } from "./obsidian-file-system"; import { SyncSettingsTab } from "./views/settings/settings-tab"; import { EditorStatusDisplayManager } from "./views/editor-status-display-manager/editor-status-display-manager"; import { remoteCursorsTheme } from "./views/cursors/remote-cursor-theme"; import { - remoteCursorsPlugin, - RemoteCursorsPluginValue + remoteCursorsPlugin, + RemoteCursorsPluginValue } from "./views/cursors/remote-cursors-plugin"; import { LocalCursorUpdateListener } from "./views/cursors/local-cursor-update-listener"; import { renderCursorsInFileExplorer } from "./views/cursors/file-explorer"; @@ -33,252 +33,252 @@ const MIN_WAIT_BETWEEN_UPDATES_IN_MS = 250; const IS_DEBUG_BUILD = process.env.NODE_ENV === "development"; export default class VaultLinkPlugin extends Plugin { - private readonly rateLimitedUpdatesPerFile = new Map< - string, - () => Promise - >(); + private readonly rateLimitedUpdatesPerFile = new Map< + string, + () => Promise + >(); - private readonly syncClient: SyncClient | undefined; - private settingsTab: SyncSettingsTab | undefined; + private readonly syncClient: SyncClient | undefined; + private settingsTab: SyncSettingsTab | undefined; - public async onload(): Promise { - this.app.workspace.onLayoutReady(async () => { - // eslint-disable-next-line - if ((globalThis as any).VAULT_LINK_RUNNING_INSTANCE) { - new Notice( - "Another instance of VaultLink is already running. Please disable the duplicate instance." - ); - throw new Error("VaultLink instance already running"); - } - // eslint-disable-next-line - (globalThis as any).VAULT_LINK_RUNNING_INSTANCE = this; + public async onload(): Promise { + this.app.workspace.onLayoutReady(async () => { + // eslint-disable-next-line + if ((globalThis as any).VAULT_LINK_RUNNING_INSTANCE) { + new Notice( + "Another instance of VaultLink is already running. Please disable the duplicate instance." + ); + throw new Error("VaultLink instance already running"); + } + // eslint-disable-next-line + (globalThis as any).VAULT_LINK_RUNNING_INSTANCE = this; - const client = await this.createSyncClient(); + const client = await this.createSyncClient(); - this.registerObsidianExtensions(client); + this.registerObsidianExtensions(client); - this.registerEditorEvents(client); + this.registerEditorEvents(client); - this.register(async () => { - await client.waitUntilFinished(); - await client.destroy(); - }); + this.register(async () => { + await client.waitUntilFinished(); + await client.destroy(); + }); - await client.start(); - }); - } + await client.start(); + }); + } - public onUserEnable(): void { - new Notice( - "VaultLink has been enabled, check out the docs for tips on getting started!" - ); - void this.activateView(HistoryView.TYPE).catch((e: unknown) => { - this.syncClient?.logger.error( - `Failed to open history view on enable: ${e}` - ); - }); - void this.activateView(LogsView.TYPE).catch((e: unknown) => { - this.syncClient?.logger.error( - `Failed to open logs view on enable: ${e}` - ); - }); - this.openSettings(); - } + public onUserEnable(): void { + new Notice( + "VaultLink has been enabled, check out the docs for tips on getting started!" + ); + void this.activateView(HistoryView.TYPE).catch((e: unknown) => { + this.syncClient?.logger.error( + `Failed to open history view on enable: ${e}` + ); + }); + void this.activateView(LogsView.TYPE).catch((e: unknown) => { + this.syncClient?.logger.error( + `Failed to open logs view on enable: ${e}` + ); + }); + this.openSettings(); + } - public openSettings(): void { - // eslint-disable-next-line - (this.app as any).setting.open(); // this is undocumented - // eslint-disable-next-line - (this.app as any).setting.openTab(this.settingsTab); // this is undocumented - } + public openSettings(): void { + // eslint-disable-next-line + (this.app as any).setting.open(); // this is undocumented + // eslint-disable-next-line + (this.app as any).setting.openTab(this.settingsTab); // this is undocumented + } - public closeSettings(): void { - // eslint-disable-next-line - (this.app as any).setting.close(); // this is undocumented - } + public closeSettings(): void { + // eslint-disable-next-line + (this.app as any).setting.close(); // this is undocumented + } - public async activateView(type: string): Promise { - const { workspace } = this.app; + public async activateView(type: string): Promise { + const { workspace } = this.app; - let leaf: WorkspaceLeaf | null = null; - const leaves = workspace.getLeavesOfType(type); + let leaf: WorkspaceLeaf | null = null; + const leaves = workspace.getLeavesOfType(type); - if (leaves.length > 0) { - [leaf] = leaves; - } else { - leaf = workspace.getRightLeaf(false); - await leaf?.setViewState({ type: type, active: true }); - } + if (leaves.length > 0) { + [leaf] = leaves; + } else { + leaf = workspace.getRightLeaf(false); + await leaf?.setViewState({ type: type, active: true }); + } - if (leaf) { - await workspace.revealLeaf(leaf); - } - } + if (leaf) { + await workspace.revealLeaf(leaf); + } + } - private async createSyncClient(): Promise { - DEFAULT_SETTINGS.ignorePatterns.push( - ".obsidian/**", - ".git/**", - ".trash/**", - "**/.DS_Store" - ); + private async createSyncClient(): Promise { + DEFAULT_SETTINGS.ignorePatterns.push( + ".obsidian/**", + ".git/**", + ".trash/**", + "**/.DS_Store" + ); - const client = await SyncClient.create({ - fs: new ObsidianFileSystemOperations( - this.app.vault, - this.app.workspace - ), - persistence: { - load: this.loadData.bind(this), - save: this.saveData.bind(this) - }, - nativeLineEndings: Platform.isWin ? "\r\n" : "\n", - ...(IS_DEBUG_BUILD - ? { - fetch: debugging.slowFetchFactory(1), - webSocket: debugging.slowWebSocketFactory( - 1, - new Logger() - ) - } - : {}) - }); + const client = await SyncClient.create({ + fs: new ObsidianFileSystemOperations( + this.app.vault, + this.app.workspace + ), + persistence: { + load: this.loadData.bind(this), + save: this.saveData.bind(this) + }, + nativeLineEndings: Platform.isWin ? "\r\n" : "\n", + ...(IS_DEBUG_BUILD + ? { + fetch: debugging.slowFetchFactory(1), + webSocket: debugging.slowWebSocketFactory( + 1, + new Logger() + ) + } + : {}) + }); - if (IS_DEBUG_BUILD) { - debugging.logToConsole(client); - } + if (IS_DEBUG_BUILD) { + debugging.logToConsole(client); + } - return client; - } + return client; + } - private registerObsidianExtensions(client: SyncClient): void { - const statusDescription = new StatusDescription(client); + private registerObsidianExtensions(client: SyncClient): void { + const statusDescription = new StatusDescription(client); - this.settingsTab = new SyncSettingsTab({ - app: this.app, - plugin: this, - syncClient: client, - statusDescription - }); - this.addSettingTab(this.settingsTab); + this.settingsTab = new SyncSettingsTab({ + app: this.app, + plugin: this, + syncClient: client, + statusDescription + }); + this.addSettingTab(this.settingsTab); - new StatusBar(this, client); + new StatusBar(this, client); - this.registerView(HistoryView.TYPE, (leaf) => { - const view = new HistoryView(client, leaf); - this.register(async () => view.onClose()); - return view; - }); + this.registerView(HistoryView.TYPE, (leaf) => { + const view = new HistoryView(client, leaf); + this.register(async () => view.onClose()); + return view; + }); - this.registerView(LogsView.TYPE, (leaf) => new LogsView(client, leaf)); + this.registerView(LogsView.TYPE, (leaf) => new LogsView(client, leaf)); - this.registerEditorExtension([remoteCursorsTheme, remoteCursorsPlugin]); + this.registerEditorExtension([remoteCursorsTheme, remoteCursorsPlugin]); - client.addRemoteCursorsUpdateListener((cursors) => { - RemoteCursorsPluginValue.setCursors(cursors, this.app); - renderCursorsInFileExplorer(cursors, this.app); - }); + client.addRemoteCursorsUpdateListener((cursors) => { + RemoteCursorsPluginValue.setCursors(cursors, this.app); + renderCursorsInFileExplorer(cursors, this.app); + }); - const cursorListener = new LocalCursorUpdateListener( - client, - this.app.workspace - ); - this.register(() => { - cursorListener.dispose(); - }); + const cursorListener = new LocalCursorUpdateListener( + client, + this.app.workspace + ); + this.register(() => { + cursorListener.dispose(); + }); - this.app.workspace.updateOptions(); + this.app.workspace.updateOptions(); - this.addRibbonIcons(); + this.addRibbonIcons(); - const editorStatusDisplayManager = new EditorStatusDisplayManager( - this, - this.app.workspace, - client - ); - this.register(() => { - editorStatusDisplayManager.dispose(); - }); + const editorStatusDisplayManager = new EditorStatusDisplayManager( + this, + this.app.workspace, + client + ); + this.register(() => { + editorStatusDisplayManager.dispose(); + }); - this.register(() => { - // eslint-disable-next-line - (globalThis as any).VAULT_LINK_RUNNING_INSTANCE = null; - }); - } + this.register(() => { + // eslint-disable-next-line + (globalThis as any).VAULT_LINK_RUNNING_INSTANCE = null; + }); + } - private addRibbonIcons(): void { - this.addRibbonIcon( - HistoryView.ICON, - "Open VaultLink events", - async (_: MouseEvent) => this.activateView(HistoryView.TYPE) - ); + private addRibbonIcons(): void { + this.addRibbonIcon( + HistoryView.ICON, + "Open VaultLink events", + async (_: MouseEvent) => this.activateView(HistoryView.TYPE) + ); - this.addRibbonIcon( - LogsView.ICON, - "Open VaultLink logs", - async (_: MouseEvent) => this.activateView(LogsView.TYPE) - ); - } + this.addRibbonIcon( + LogsView.ICON, + "Open VaultLink logs", + async (_: MouseEvent) => this.activateView(LogsView.TYPE) + ); + } - private registerEditorEvents(client: SyncClient): void { - [ - this.app.workspace.on( - "editor-change", - async ( - _editor: Editor, - info: MarkdownView | MarkdownFileInfo - ) => { - const { file } = info; - if (file) { - await this.rateLimitedUpdate(file.path, client); - } - } - ), - this.app.vault.on("create", async (file: TAbstractFile) => { - if (file instanceof TFile) { - await client.syncLocallyCreatedFile(file.path); - } - }), - this.app.vault.on("modify", async (file: TAbstractFile) => { - if (file instanceof TFile) { - await this.rateLimitedUpdate(file.path, client); - } - }), - this.app.vault.on("delete", async (file: TAbstractFile) => { - await client.syncLocallyDeletedFile(file.path); - }), - this.app.vault.on( - "rename", - async (file: TAbstractFile, oldPath: string) => { - if (file instanceof TFile) { - await client.syncLocallyUpdatedFile({ - oldPath, - relativePath: file.path - }); - } - } - ) - ].forEach((event) => { - this.registerEvent(event); - }); - } + private registerEditorEvents(client: SyncClient): void { + [ + this.app.workspace.on( + "editor-change", + async ( + _editor: Editor, + info: MarkdownView | MarkdownFileInfo + ) => { + const { file } = info; + if (file) { + await this.rateLimitedUpdate(file.path, client); + } + } + ), + this.app.vault.on("create", async (file: TAbstractFile) => { + if (file instanceof TFile) { + await client.syncLocallyCreatedFile(file.path); + } + }), + this.app.vault.on("modify", async (file: TAbstractFile) => { + if (file instanceof TFile) { + await this.rateLimitedUpdate(file.path, client); + } + }), + this.app.vault.on("delete", async (file: TAbstractFile) => { + await client.syncLocallyDeletedFile(file.path); + }), + this.app.vault.on( + "rename", + async (file: TAbstractFile, oldPath: string) => { + if (file instanceof TFile) { + await client.syncLocallyUpdatedFile({ + oldPath, + relativePath: file.path + }); + } + } + ) + ].forEach((event) => { + this.registerEvent(event); + }); + } - private async rateLimitedUpdate( - path: string, - client: SyncClient - ): Promise { - if (!this.rateLimitedUpdatesPerFile.has(path)) { - this.rateLimitedUpdatesPerFile.set( - path, - rateLimit( - async () => - client.syncLocallyUpdatedFile({ - relativePath: path - }), - MIN_WAIT_BETWEEN_UPDATES_IN_MS - ) - ); - } - await this.rateLimitedUpdatesPerFile.get(path)?.(); - } + private async rateLimitedUpdate( + path: string, + client: SyncClient + ): Promise { + if (!this.rateLimitedUpdatesPerFile.has(path)) { + this.rateLimitedUpdatesPerFile.set( + path, + rateLimit( + async () => + client.syncLocallyUpdatedFile({ + relativePath: path + }), + MIN_WAIT_BETWEEN_UPDATES_IN_MS + ) + ); + } + await this.rateLimitedUpdatesPerFile.get(path)?.(); + } } diff --git a/frontend/obsidian-plugin/tsconfig.json b/frontend/obsidian-plugin/tsconfig.json index 4c39e97b..81af03a7 100644 --- a/frontend/obsidian-plugin/tsconfig.json +++ b/frontend/obsidian-plugin/tsconfig.json @@ -1,17 +1,17 @@ { - "compilerOptions": { - "baseUrl": ".", - "module": "ESNext", - "target": "ES2023", - "strict": true, - "moduleResolution": "bundler", - "allowSyntheticDefaultImports": true, - "lib": [ - "DOM", - "ES2024" - ] - }, - "exclude": [ - "./dist" - ] -} \ No newline at end of file + "compilerOptions": { + "baseUrl": ".", + "module": "ESNext", + "target": "ES2023", + "strict": true, + "moduleResolution": "bundler", + "allowSyntheticDefaultImports": true, + "lib": [ + "DOM", + "ES2024" + ] + }, + "exclude": [ + "./dist" + ] +} diff --git a/scripts/check.sh b/scripts/check.sh index 6300c592..e8a40985 100755 --- a/scripts/check.sh +++ b/scripts/check.sh @@ -2,7 +2,6 @@ set -e -# Parse arguments FIX_MODE=false if [[ "$1" == "--fix" ]]; then FIX_MODE=true @@ -33,12 +32,16 @@ else npm ci fi -echo "Checking .editorconfig compliance" +cd .. + +# Use git ls-files to only check tracked files, respecting .gitignore if [[ "$FIX_MODE" == true ]]; then - npx eclint fix '../**/*' '!../node_modules/**' '!../frontend/node_modules/**' '!../sync-server/target/**' '!../frontend/dist/**' '!../.git/**' + git ls-files | xargs npx eclint fix else - npx eclint check '../**/*' '!../node_modules/**' '!../frontend/node_modules/**' '!../sync-server/target/**' '!../frontend/dist/**' '!../.git/**' + git ls-files | xargs npx eclint check fi + +cd frontend npm run build npm run test npm run lint diff --git a/scripts/e2e.sh b/scripts/e2e.sh index 93f6c3a4..a5b5cf3b 100755 --- a/scripts/e2e.sh +++ b/scripts/e2e.sh @@ -109,4 +109,3 @@ while true; do sleep 0.2 done -