How xryul/obsidian-image-converter works
Project type and purpose
• This is an ObsidianMD plugin (“Image Converter for ObsidianMD”) written in TypeScript/JavaScript, running entirely in the user’s local Vault.
• Purpose: intercept image paste/drop events or context-menu actions in Obsidian, then convert, resize, compress, crop, annotate, rotate, flip, rename, and re-link images in Markdown notes—fully offline with no external binaries.
File structure
• Top-level:
• manifest.json, main.js, styles.css – the plugin’s public interface for Obsidian
• src/ – TypeScript sources, organized by feature (e.g., AsyncLock.ts, ImageProcessor.ts, Crop.ts, many “Modal” classes, settings classes)
• Examples/, README.md, LICENSE, package.json, esbuild.config.mjs – docs, sample usage, build config
• src/ contains:
• UI & Interaction: ContextMenu.ts, PresetSelectionModal.ts, ProcessAllVaultModal.ts, ProcessCurrentNote.ts, ProcessFolderModal.ts, ProcessSingleImageModal.ts
• Core Processing: BatchImageProcessor.ts, ImageProcessor.ts, ImageResizer.ts, ImageConverterSettings.ts, FolderAndFilenameManagement.ts, LinkFormatter & LinkFormatSettings, VariableProcessor.ts
• Image Features: Crop.ts, ImageAlignmentManager.ts, ImageAnnotation.ts, …
• Utilities: AsyncLock.ts, SupportedImageFormats.ts, UTIF.js/d.ts, heic-to.d.ts
README for additional insights
• Confirms features: convert/compress/resize/align/annotate/crop/rotate/flip/rename/batch, all offline.
• Lists technology: Pure JS, FabricJS for annotation, UTIF for TIF support.
• No backend or external services—everything runs via Obsidian’s plugin API and local file I/O.
Detailed capturing of essential elements
• Don’t fragment too much: group related TS classes under “Image Processing” or “UI Modals” as appropriate
• Asynchronous locking, batch vs single-image flows
• Settings flow: Settings → passed into UI & Processing stages