How ebullient/obsidian-show-whitespace-cm6 works
Project Type and Purpose
• Type: Obsidian Community Plugin (Electron‐based, front‐end only)
• Purpose: Highlight leading/trailing whitespace in Markdown editor and live preview via CodeMirror 6 extensions, configurable via a settings tab.
File Structure
• Top‐level:
• manifest.json, manifest‐beta.json – plugin metadata
• src/main.ts – plugin entry point
• src/whitespace-Plugin.ts – registers CodeMirror 6 extensions
• src/whitespace-SettingsTab.ts – plugin settings UI
• src/styles.scss – default CSS styling
• src/i18n – internationalization module
• esbuild.config.mjs / biome.json / tsconfig.json – build & lint configs
• Patterns:
• Plugin API → CodeMirror extension registration
• Separate settings UI component
• Build step bundles TS + SCSS into the final plugin.js & style.css
Pull Architecture Insights from README
• Core components: whitespace visualization engine, settings interface, CSS injection
• Build & release via GitHub workflows (build.yml, release.yml)
• No external services or databases; settings persist via Obsidian’s plugin API
Main Components & Relationships
A. Developer Environment
– Editor & CLI run esbuild (esbuild.config.mjs, biome.json)
– Outputs plugin bundle & CSS
B. Obsidian Host (Electron App)
– Plugin Loader reads manifest.json & plugin bundle
– Storage API persists user settings
– Renders editor area via CodeMirror 6
– Renders Live Preview pane
C. Show-Whitespace Plugin
1. Entry (main.ts)
• onload(): instantiate SettingsTab
• register whitespace Plugin extension
2. whitespace-Plugin.ts
• Defines CodeMirror decorations for leading/trailing whitespace
• Reads plugin settings from Obsidian’s Data API
3. whitespace-SettingsTab.ts
• UI in Obsidian’s Settings → Community Plugins → Show Whitespace
• Provides toggles (leading/trailing/middle, marker outlines)
4. styles.scss → compiled style.css
• CSS variables (--line-end, --line-break)
• Default glyph styles for whitespace markers
5. i18n module (en.ts, index.ts)
• Loads localized labels for settings UI
– Developer Machine
– Build Tools (esbuild, biome)
– Obsidian Host
– CodeMirror 6 Engine
– Show-Whitespace Plugin
· Plugin Entry
· Plugin Runtime (whitespace-Plugin, SettingsTab, i18n)
· CSS Injector (style.css)
– Persistent Settings Store
– Dev → Build Tool: TS/SCSS → bundle.js + style.css
– Build Output → Obsidian Plugin Loader
– Plugin Loader → Plugin Runtime
– Plugin Runtime → CodeMirror 6 (register extensions)
– Plugin Runtime → CSS Injector → Editor DOM
– SettingsTab ↔ Persistent Store (read/write settings)
c. Architectural Patterns
– Plugin-based extension of host application
– Separation of concerns: core functionality (decoration) vs. configuration UI
– Build pipeline compiles TS + SCSS to browser-compatible assets
d. Key Technologies
– TypeScript, SCSS
– CodeMirror 6 Extension API
– Obsidian Plugin API (onload, settings persistence)
– esbuild (bundler), biome (formatter/linter)
– GitHub Actions for CI/CD