Skip to content

CHANGELOG.md

Latest commit

 

History

History
299 lines (244 loc) · 14.2 KB

CHANGELOG.md

File metadata and controls

299 lines (244 loc) · 14.2 KB

Changelog

All notable changes to OverType will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[1.2.7] - 2025-09-30

Fixed

  • Issue #55: Double-escaping of HTML entities in code blocks - HTML special characters (<, >, &, ") inside inline code spans are now properly escaped once instead of twice
    • Removed redundant escapeHtml() calls when rendering code sanctuaries
    • Fixes issue where `<angle brackets>` would display as &amp;lt;angle brackets&amp;gt; instead of &lt;angle brackets&gt;
    • Also fixed the same issue for inline code within link text
    • Thanks to @lyricat for identifying and fixing this issue (PR #56)

Added

  • Comprehensive test suite for HTML entity escaping in code blocks

[1.2.6] - 2025-09-08

Fixed

  • Re-enabled code button inside links - Now that the sanctuary pattern properly handles inline code within link text, the code button works correctly without Unicode placeholder issues
  • Removed unnecessary code - Deleted the isInsideLink function that was no longer needed, reducing bundle size

Changed

  • README update - Replaced Synesthesia section with Hyperclay information

[1.2.5] - 2025-09-08

Fixed

  • URL formatting protection - Markdown formatting characters in URLs are now preserved as literal text
    • Implemented "protected regions" strategy for URL portions of links
    • Backticks, asterisks, underscores, and tildes in URLs remain unchanged
    • Link text can still contain formatted content (bold, italic, code, etc.)
    • Fixes issue where [Link](https://example.com/path/file) would break the URL
  • Italic underscore handling - Underscores now require word boundaries for italic formatting
    • Prevents false matches in words like bold_with_underscore
    • Single underscores only create italic at word boundaries

Added

  • Comprehensive sanctuary parsing test suite for URL protection
  • Release process documentation in contrib_docs/

[1.2.4] - 2025-09-04

Fixed

  • Issue #48: Code formatting inside links - Code button now disabled when cursor is inside a link
    • Added isInsideLink() detection to toolbar to prevent placeholder issues
    • Prevents Unicode placeholders from appearing when trying to format code within link text
  • Issue #47: Tailwind CSS animation conflict - Renamed keyframe to avoid clashes
    • Changed @keyframes pulse to @keyframes overtype-pulse
    • Fixes conflict with Tailwind's animate-pulse utility class
  • Issue #45: HTML output methods confusion - Methods now have distinct purposes
    • getRenderedHTML() returns HTML with syntax markers (for debugging)
    • getRenderedHTML({ cleanHTML: true }) returns clean HTML without OverType markup
    • getCleanHTML() added as convenience alias for clean HTML
    • getPreviewHTML() returns actual DOM content from preview layer
  • Issue #43: TypeScript support - Added comprehensive TypeScript definitions
    • TypeScript definitions included in package (dist/overtype.d.ts)
    • Added types field to package.json
    • Definitions automatically tested during build process
    • Full type support for all OverType features including themes, options, and methods
  • Toolbar configuration - Made toolbar button config more robust
    • Fixed missing semicolon in toolbar.js
    • Added proper fallback for undefined buttonConfig

Added

  • TypeScript definition testing integrated into build process
    • test-types.ts validates all type definitions
    • Build fails if TypeScript definitions have errors
    • Added test:types npm script for standalone testing

Changed

  • Link tooltip styles now use !important to prevent CSS reset overrides
    • Ensures tooltip remains visible even with aggressive parent styles

[1.2.3] - 2025-08-23

Added

  • Smart List Continuation (Issue #26) - GitHub-style automatic list continuation
    • Press Enter at the end of a list item to create a new one
    • Press Enter on an empty list item to exit the list
    • Press Enter in the middle of text to split it into two items
    • Supports bullet lists (-, *, +), numbered lists, and checkboxes
    • Numbered lists automatically renumber when items are added or removed
    • Enabled by default with smartLists: true option

[1.2.2] - 2025-08-23

Fixed

  • Issue #32: Alignment problems with tables and code blocks
    • Code fences (```) are now preserved and visible in the preview
    • Content inside code blocks is no longer parsed as markdown
    • Used semantic <pre><code> blocks while keeping fences visible
  • Fixed double-escaping of HTML entities in code blocks
    • Changed from using innerHTML to textContent when extracting code block content
    • Removed unnecessary text manipulation in _applyCodeBlockBackgrounds()
    • Special characters like >, <, & now display correctly in code blocks

[1.2.1] - 2025-08-23

Fixed

  • Tab indentation can now be properly undone with Ctrl/Cmd+Z
    • Previously, tabbing operations were not tracked in the undo history
    • Users can now undo/redo tab insertions and multi-line indentations

[1.2.0] - 2025-08-21

Added

  • View Modes - Three distinct editing/viewing modes accessible via toolbar dropdown
    • Normal Edit Mode: Default WYSIWYG markdown editing with syntax highlighting
    • Plain Textarea Mode: Shows raw markdown without preview overlay
    • Preview Mode: Read-only rendered preview with proper typography and clickable links
  • API Methods for HTML Export
    • getRenderedHTML(processForPreview): Get rendered HTML of current content
    • getPreviewHTML(): Get the exact HTML displayed in preview layer
    • Enables external preview generation and HTML export functionality
  • View Mode API Methods
    • showPlainTextarea(boolean): Programmatically switch to/from plain textarea mode
    • showPreviewMode(boolean): Programmatically switch to/from preview mode
  • Enhanced Link Handling
    • Links now always have real hrefs (pointer-events controls clickability)
    • Links properly hidden in preview mode (no more visible ](url) syntax)
    • Simplified implementation without dynamic href updates
  • CSS Isolation Improvements
    • Middle-ground CSS reset prevents parent styles from leaking into editor
    • Protects against inherited margins, padding, borders, and decorative styles
    • Maintains proper inheritance for fonts and colors
  • Dropdown Menu System
    • Fixed positioning dropdown menus that work with scrollable toolbar
    • Dropdown appends to document.body to avoid overflow clipping
    • Proper z-index management for reliable visibility
  • Comprehensive Test Suite
    • Added tests for preview mode functionality
    • Added tests for link parsing and XSS prevention
    • Added tests for new API methods (getValue, getRenderedHTML, getPreviewHTML)
    • Test coverage includes view mode switching, HTML rendering, and post-processing

Fixed

  • Preview Mode Link Rendering - URL syntax parts now properly hidden in preview mode
  • Code Block Backgrounds - Restored pale yellow background in normal mode
  • Dropdown Menu Positioning - Fixed dropdown being cut off by toolbar overflow
  • Cave Theme Styling
    • Eye icon button now has proper contrast when active (dropdown-active state)
    • Code blocks in preview mode use appropriate dark background (#11171F)
  • Toolbar Scrolling - Toolbar now scrolls horizontally on all screen sizes as intended
  • CSS Conflicts - Parent page styles no longer interfere with editor styling

Changed

  • Link implementation simplified - always uses real hrefs with CSS controlling interaction
  • Post-processing for lists and code blocks now works in both browser and Node.js environments
  • Toolbar overflow changed from hidden to auto for horizontal scrolling
  • Dropdown menus use fixed positioning instead of absolute
  • Removed overscroll-behavior: none to restore scroll-through behavior
    • Users can now continue scrolling the parent page when reaching editor boundaries
    • Trade-off: Minor visual desync during Safari elastic bounce vs trapped scrolling

[1.1.8] - 2025-01-20

Fixed

  • Android bold/italic rendering regression from v1.1.3
    • Removed font-synthesis: none to restore synthetic bold/italic on Android devices
    • Updated font stack to avoid 'ui-monospace' pitfalls while maintaining Android support
    • Font stack now properly includes: SF Mono, Roboto Mono, Noto Sans Mono, Droid Sans Mono
    • Fixes issue where Android users could not see bold or italic text formatting

[1.1.7] - 2025-01-20

Security

  • Fixed XSS vulnerability where javascript: protocol links could execute arbitrary code (#25)
    • Added URL sanitization to block dangerous protocols (javascript:, data:, vbscript:, etc.)
    • Safe protocols allowed: http://, https://, mailto:, ftp://, ftps://
    • Relative URLs and hash links continue to work normally
    • Dangerous URLs are neutralized to "#" preventing code execution

[1.1.6] - 2025-01-20

Fixed

  • URLs with markdown characters (underscores, asterisks) no longer break HTML structure (#23)
    • Implemented "URL Sanctuary" pattern to protect link URLs from markdown processing
    • Links are now treated as protected zones where markdown syntax is literal text
    • Fixes malformed HTML when URLs contain _, __, *, ** characters
    • Preserves proper href attributes and visual rendering

1.1.5 - 2025-01-20

Added

  • TypeScript definitions file (src/overtype.d.ts) with complete type definitions (#20)
  • TypeScript test file (test-types.ts) for type validation

Fixed

  • Text selection desynchronization during overscroll on browsers with elastic scrolling (#17)
    • Added overscroll-behavior: none to prevent bounce animation at scroll boundaries
    • Ensures text selection stays synchronized between textarea and preview layers

1.1.4 - 2025-01-19

Fixed

  • Code blocks no longer render markdown formatting - __init__ displays correctly (#14)
    • Post-processing strips all formatting from lines inside code blocks
    • Preserves plain text display for asterisks, underscores, backticks, etc.

1.1.3 - 2025-01-19

Fixed

  • Inline triple backticks no longer mistaken for code blocks (#15)
    • Code fences now only recognized when alone on a line or followed by language identifier
    • Prevents cascade failures where inline backticks break subsequent code blocks
  • Android cursor misalignment on bold text (#16)
    • Updated font stack to avoid problematic ui-monospace on Android
    • Added explicit Android fonts: Roboto Mono, Noto Sans Mono, Droid Sans Mono
    • Added font-synthesis: none and font-variant-ligatures: none to prevent width drift

1.1.2 - 2025-01-19

Added

  • textareaProps option to pass native HTML attributes to textarea (required, maxLength, name, etc.) (#8)
  • autoResize option for auto-expanding editor height based on content
  • minHeight and maxHeight options for controlling auto-resize bounds
  • Form integration example in README showing how to use with HTML form validation

Fixed

  • Height issue when toolbar and stats bar are enabled - container now uses CSS Grid properly (#9)
  • Grid layout issue where editors without toolbars would collapse to min-height
  • Added explicit grid-row positions for toolbar, wrapper, and stats elements
  • Stats bar now positioned at bottom of container using grid (not absolute positioning)

Changed

  • Container uses CSS Grid layout (grid-template-rows: auto 1fr auto) for proper height distribution
  • Toolbar takes auto height, editor wrapper takes remaining space (1fr), stats bar takes auto height
  • Bundle size: 60.89 KB minified (16.8 KB gzipped)

1.1.1 - 2025-01-18

Changed

  • Link tooltips now use CSS Anchor Positioning for perfect placement
  • Tooltips position directly below the rendered link text (not approximated)
  • Removed Floating UI dependency, reducing bundle size from 73KB to 59KB minified
  • Parser now adds anchor names to rendered links for CSS positioning
  • Demo page redesigned to match dark terminal aesthetic
  • Added "SEE ALL DEMOS" button to index.html

Fixed

  • Link tooltip positioning now accurate relative to rendered text

1.1.0 - 2025-01-18

Added

  • Gmail/Google Docs style link tooltips - cursor in link shows clickable URL tooltip (#4)
  • Tab key support - inserts 2 spaces, supports multi-line indent/outdent with Shift+Tab (#3)
  • Comprehensive "Limitations" section in README documenting design constraints (#5)
  • @floating-ui/dom dependency for tooltip positioning

Fixed

  • Inline code with underscores/asterisks no longer incorrectly formatted (#2, PR #6 by @joshdoman)
  • Code elements now properly inherit font-size, preventing alignment breaks (#1)
  • Tab key no longer causes focus loss and cursor misalignment (#3)

Changed

  • Links now use tooltip interaction instead of Cmd/Ctrl+Click (better UX)
  • README limitations section moved below Examples for better flow
  • Build size increased to 73KB minified (from 45KB) due to Floating UI library

Contributors

  • Josh Doman (@joshdoman) - Fixed inline code formatting preservation

1.0.6 - 2024-08-17

Added

  • Initial public release on Hacker News
  • Core transparent textarea overlay functionality
  • Optional toolbar with markdown formatting buttons
  • Keyboard shortcuts for common markdown operations
  • Solar (light) and Cave (dark) themes
  • DOM persistence and recovery
  • Mobile optimization
  • Stats bar showing word/character count

Features at Launch

  • 👻 Invisible textarea overlay for seamless editing
  • 🎨 Global theming system
  • ⌨️ Keyboard shortcuts (Cmd/Ctrl+B for bold, etc.)
  • 📱 Mobile optimized with responsive design
  • 🔄 DOM persistence aware (works with HyperClay)
  • 🚀 Lightweight ~45KB minified
  • 🎯 Optional toolbar
  • ✨ Smart shortcuts with selection preservation
  • 🔧 Framework agnostic