|
| 1 | +# 🛡️ Excalink Plugin v1.0.1 - Security & Quality Update |
| 2 | + |
| 3 | +## Release Overview |
| 4 | + |
| 5 | +Version 1.0.1 addresses critical security concerns and code quality improvements identified during the Obsidian Community Plugin review process. This update ensures the plugin meets all Obsidian plugin development guidelines. |
| 6 | + |
| 7 | +## 🔧 Bug Fixes & Security Updates |
| 8 | + |
| 9 | +### Security Enhancements |
| 10 | + |
| 11 | +- **🛡️ HTML Security**: Replaced all `innerHTML` usage with safe DOM API methods (`textContent`, `createEl()`) |
| 12 | + - Fixed potential XSS vulnerabilities in `FrameSuggestModal.ts` |
| 13 | + - Fixed HTML injection risks in `ExcalinkSettingTab.ts` |
| 14 | + - All user content now safely rendered using Obsidian's DOM helpers |
| 15 | + |
| 16 | +### Styling Improvements |
| 17 | + |
| 18 | +- **🎨 CSS Refactoring**: Moved all inline styles to `styles.css` for better theme compatibility |
| 19 | + - Removed `style` property assignments from JavaScript |
| 20 | + - Added proper CSS classes: `.excalink-description`, `.excalink-plugin-info`, `.modal-button-container` |
| 21 | + - Better integration with Obsidian themes and user customizations |
| 22 | + |
| 23 | +### Performance Optimizations |
| 24 | + |
| 25 | +- **🚀 Console Cleanup**: Significantly reduced console logging to prevent dev console pollution |
| 26 | + - Removed excessive debug statements that were active in production |
| 27 | + - Kept only critical error logging and user-controlled debug output |
| 28 | + - Added `DebugLogger` utility for conditional logging based on user settings |
| 29 | + |
| 30 | +### Code Quality |
| 31 | + |
| 32 | +- **✨ Best Practices**: Enhanced adherence to Obsidian plugin development guidelines |
| 33 | + - Improved security posture with safe DOM manipulation |
| 34 | + - Better separation of concerns with CSS-based styling |
| 35 | + - Cleaner development experience with reduced console noise |
| 36 | + |
| 37 | +## 📋 Files Changed |
| 38 | + |
| 39 | +- `FrameSuggestModal.ts` - Security fixes for DOM manipulation |
| 40 | +- `ExcalinkSettingTab.ts` - HTML security and CSS refactoring |
| 41 | +- `main.ts` - Console logging cleanup |
| 42 | +- `styles.css` - New CSS classes for moved inline styles |
| 43 | +- `DebugLogger.ts` - New utility for conditional logging (NEW FILE) |
| 44 | +- `manifest.json` - Version bump to 1.0.1 |
| 45 | +- `package.json` - Version bump to 1.0.1 |
| 46 | +- `versions.json` - Added 1.0.1 compatibility entry |
| 47 | +- `README.md` - Updated changelog |
| 48 | + |
| 49 | +## 🔄 Migration Notes |
| 50 | + |
| 51 | +This update is fully backward compatible. No user action required: |
| 52 | + |
| 53 | +- All existing settings are preserved |
| 54 | +- Plugin functionality remains unchanged |
| 55 | +- Visual appearance may have minor improvements due to better CSS structure |
| 56 | +- Debug output is now controlled by the "Enable Debug Logging" setting |
| 57 | + |
| 58 | +## 🎯 What's Next |
| 59 | + |
| 60 | +- Awaiting community plugin review approval |
| 61 | +- Planning additional features based on user feedback |
| 62 | +- Continued performance and security improvements |
| 63 | + |
| 64 | +## ✅ Testing |
| 65 | + |
| 66 | +- All functionality tested with the security and styling changes |
| 67 | +- No breaking changes to user workflows |
| 68 | +- Console logging verified to be minimal in production use |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +**Download**: Available from [GitHub Releases](https://github.com/AarambhaAnta/Excalink/releases/tag/v1.0.1) |
| 73 | + |
| 74 | +**Compatibility**: Obsidian 0.15.0+ |
| 75 | + |
| 76 | +### Released: July 20, 2024 |
0 commit comments