XML Element Indexer

XML Element Indexer

A powerful Visual Studio Code extension that provides intelligent indexing for XML elements with multiple indexing modes and performance optimizations.

Features 🚀 Multiple Indexing Modes Full Mode: Index all XML elements in the entire document Cursor Mode: Index elements around the current cursor position Inline Mode: Index only elements on the current line Range Mode: Index elements within a configurable range ⚡ Performance Optimized Smart caching system to minimize re-parsing Configurable performance thresholds Large file handling with optimized parsing strategies Real-time performance monitoring 🎨 Visual Enhancements Clear, non-intrusive inline decorations Customizable appearance Smart positioning to avoid overlap Responsive to cursor movement 🛠️ Developer Friendly Extensive configuration options Command palette integration Status bar indicators Detailed error handling Installation Open Visual Studio Code Press Ctrl+P / Cmd+P to open the Quick Open dialog Type ext install xml-element-indexer Click Install Alternatively, search for "XML Element Indexer" in the Extensions view (Ctrl+Shift+X / Cmd+Shift+X).

Usage Commands Access all commands through the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

XML Element Indexer: Toggle - Enable/disable the indexer XML Element Indexer: Set Mode - Choose indexing mode XML Element Indexer: Clear Cache - Clear the parsing cache XML Element Indexer: Show Status - Display current status Keyboard Shortcuts Alt+X - Toggle indexer on/off Alt+Shift+X - Quick mode switch Quick Start Open any XML file The extension activates automatically See indexed numbers appear next to XML elements Use Alt+X to toggle on/off Switch modes based on your needs Configuration Configure the extension through VS Code settings (File > Preferences > Settings):

JSON

Collapse { // Enable/disable the extension "xmlElementIndexer.enabled": true,

// Default indexing mode "xmlElementIndexer.mode": "cursor",

// Cursor mode settings "xmlElementIndexer.cursorMode.radius": 10,

// Range mode settings "xmlElementIndexer.rangeMode.before": 20, "xmlElementIndexer.rangeMode.after": 20,

// Performance settings "xmlElementIndexer.performance.maxFileSize": 1048576, "xmlElementIndexer.performance.cacheTimeout": 5000, "xmlElementIndexer.performance.debounceDelay": 100,

// Appearance settings "xmlElementIndexer.appearance.color": "#888888", "xmlElementIndexer.appearance.backgroundColor": "transparent", "xmlElementIndexer.appearance.fontWeight": "normal", "xmlElementIndexer.appearance.fontSize": "0.9em" } Configuration Options General Settings Setting Type Default Description enabled boolean true Enable/disable the extension mode string "cursor" Default indexing mode (full, cursor, inline, range) Mode-Specific Settings Cursor Mode

cursorMode.radius: Number of lines to index around cursor (default: 10) Range Mode

rangeMode.before: Lines to index before cursor (default: 20) rangeMode.after: Lines to index after cursor (default: 20) Performance Settings Setting Type Default Description performance.maxFileSize number 1048576 Maximum file size in bytes (1MB) performance.cacheTimeout number 5000 Cache expiration time in ms performance.debounceDelay number 100 Debounce delay for updates in ms Examples Basic XML Indexing XML

[1] Content [2] Content [3] Content [4] Mode Examples Full Mode: Indexes entire document

Perfect for: Getting a complete overview of document structure Cursor Mode: Indexes elements within radius of cursor

Perfect for: Working with specific sections without distraction Inline Mode: Only indexes current line

Perfect for: Minimal distraction, focused editing Range Mode: Configurable range around cursor

Perfect for: Custom workspace preferences Performance Tips Large Files: The extension automatically optimizes for files over 1MB Complex Documents: Use cursor or range mode for better performance Real-time Updates: Adjust debounce delay if experiencing lag Cache Management: Clear cache if indices seem incorrect Troubleshooting Indices not showing Check if extension is enabled: Alt+X Verify file is recognized as XML Try clearing cache: Command Palette → "Clear Cache" Performance issues Switch to cursor or inline mode for large files Increase debounce delay in settings Check status bar for performance warnings Incorrect indices Clear cache and re-index Check for malformed XML