obsidian-plugin/fancive_obsidian-parallel-reader
1
0
Fork 0
mirror of https://github.com/fancive/obsidian-parallel-reader.git synced 2026-07-22 06:53:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: add typed wrappers for Obsidian API boundaries

Browse source 
Add CmEditorView, ObsidianEditorWithCm, ObsidianMenuItem, and ObsidianMenu
interfaces to src/types.ts. Replace (editor as any).cm and (it: any) casts
in main.ts with these typed wrappers, eliminating all any casts in the
scroll-sync and file-menu code paths.

https://claude.ai/code/session_016QvEfqw6YZ3RjwBHrJ4w8S
This commit is contained in:
Claude 2026-04-26 06:08:46 +00:00
parent 87904811e2
commit 57d25501d6
No known key found for this signature in database
2 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
main.ts
View file

@ -41,7 +41,15 @@ import {
} from './src/settings';
import { ParallelReaderSettingTab } from './src/settings-tab';
import { deltaExtractorForFormat, parseSseBuffer, type StreamProgress } from './src/streaming';
import type { CacheEntry, PluginSettings, RawCard, ResolvedCard } from './src/types';
import type {
CacheEntry,
ObsidianEditorWithCm,
ObsidianMenu,
ObsidianMenuItem,
PluginSettings,
RawCard,
ResolvedCard,
} from './src/types';
import { addIconButton, addTextButton, copyToClipboard } from './src/ui-helpers';
import { folderPathsForTarget } from './src/vault';
import { ParallelReaderView, VIEW_TYPE_PARALLEL } from './src/view';
@ -356,29 +364,29 @@ class ParallelReaderPlugin extends Plugin {
return true;
}
addFileMenuItems(menu: any, file: any) {
addFileMenuItems(menu: ObsidianMenu, file: unknown) {
if (!(file instanceof TFile) || !file.path.endsWith('.md')) return;
menu.addSeparator();
menu.addItem((it: any) =>
menu.addItem((it: ObsidianMenuItem) =>
it
.setTitle(this.t('fileMenuGenerate'))
.setIcon('book-open')
.onClick(() => this.runForFile(file, false)),
);
menu.addItem((it: any) =>
menu.addItem((it: ObsidianMenuItem) =>
it
.setTitle(this.t('fileMenuRegen'))
.setIcon('refresh-cw')
.onClick(() => this.runForFile(file, true)),
);
if (this.cacheManager.get(file.path)) {
menu.addItem((it: any) =>
menu.addItem((it: ObsidianMenuItem) =>
it
.setTitle(this.t('fileMenuClear'))
.setIcon('trash')
.onClick(async () => {
await this.cacheManager.delete(file.path);
new Notice(this.t('cacheClearedFile', { name: file.basename }));
new Notice(this.t('cacheClearedFile', { name: (file as TFile).basename }));
}),
);
}
@ -590,7 +598,7 @@ class ParallelReaderPlugin extends Plugin {
const mdView = this.getActiveView();
if (!mdView) return;
const editor = mdView.editor;
const cm = editor && (editor as any).cm;
const cm = editor && (editor as unknown as ObsidianEditorWithCm).cm;
const scrollDom = cm?.scrollDOM ? cm.scrollDOM : mdView.contentEl.querySelector('.cm-scroller');
if (!scrollDom) return;
const handler = createRafThrottledHandler(() => this.handleEditorScroll(mdView));
@ -605,7 +613,7 @@ class ParallelReaderPlugin extends Plugin {
const view = this.getParallelView();
if (!view || !mdView.file || view.sourceFile?.path !== mdView.file.path) return;
const editor = mdView.editor;
const cm = editor && (editor as any).cm;
const cm = editor && (editor as unknown as ObsidianEditorWithCm).cm;
if (!cm?.scrollDOM) return;
const rect = cm.scrollDOM.getBoundingClientRect();
const topY = visibleTopProbeY(rect);
@ -629,7 +637,7 @@ class ParallelReaderPlugin extends Plugin {
findLeafForFile(file: TFile | null) {
if (!file) return null;
for (const leaf of this.app.workspace.getLeavesOfType('markdown')) {
const v = leaf.view as any;
const v = leaf.view as { file?: TFile };
if (v?.file && v.file.path === file.path) return leaf;
}
return null;

31
src/types.ts
View file

@ -109,6 +109,37 @@ export interface PromptPair {
user: string;
}
/* ---------- Obsidian internal API types ---------- */
/** Minimal CodeMirror 6 EditorView shape used for scroll synchronization. */
export interface CmEditorView {
scrollDOM: HTMLElement;
state: {
doc: {
lineAt(pos: number): { number: number };
};
};
posAtCoords(coords: { x: number; y: number }): number | null;
}
/** Obsidian Editor with optional CodeMirror 6 view attached at `.cm`. */
export interface ObsidianEditorWithCm {
cm?: CmEditorView;
}
/** Minimal Obsidian MenuItem builder API used in file-menu callbacks. */
export interface ObsidianMenuItem {
setTitle(title: string): this;
setIcon(icon: string): this;
onClick(callback: () => unknown): this;
}
/** Minimal Obsidian Menu API used to build context-menu entries. */
export interface ObsidianMenu {
addSeparator(): void;
addItem(cb: (item: ObsidianMenuItem) => void): void;
}
/* ---------- Plugin host interface ---------- */
/**