@joinezco/markdown-editor 0.0.1 → 0.0.4

package/src/lib/editor/styles.ts

@@ -19,6 +19,29 @@ export const styleModule: StyleModule = new StyleModule({
         '--ezco-mde-link-color': '#5861ff',
         '--ezco-mde-link-color-hover': '#383ea3',
 
+        // Typography scale based on perfect fourth ratio (1.333)
+        '--ezco-mde-type-ratio': '1.25',
+        '--ezco-mde-base-font-size': '1rem',
+        '--ezco-mde-base-line-height': '1.5',
+        
+        // Font sizes using modular scale
+        '--ezco-mde-text-xs': 'calc(var(--ezco-mde-base-font-size) / var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-sm': 'calc(var(--ezco-mde-text-xs) * var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-base': 'var(--ezco-mde-base-font-size)',
+        '--ezco-mde-text-lg': 'calc(var(--ezco-mde-text-base) * var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-xl': 'calc(var(--ezco-mde-text-lg) * var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-2xl': 'calc(var(--ezco-mde-text-xl) * var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-3xl': 'calc(var(--ezco-mde-text-2xl) * var(--ezco-mde-type-ratio))',
+        '--ezco-mde-text-4xl': 'calc(var(--ezco-mde-text-3xl) * var(--ezco-mde-type-ratio))',
+        
+        // Line heights based on modular scale - inversely related to font size for better readability
+        '--ezco-mde-line-ratio': '1', // Smaller ratio for line height progression
+        '--ezco-mde-leading-loose': 'calc(var(--ezco-mde-base-line-height) * var(--ezco-mde-line-ratio))',
+        '--ezco-mde-leading-relaxed': 'var(--ezco-mde-base-line-height)',
+        '--ezco-mde-leading-normal': 'calc(var(--ezco-mde-base-line-height) / var(--ezco-mde-line-ratio))',
+        '--ezco-mde-leading-snug': 'calc(var(--ezco-mde-leading-normal) / var(--ezco-mde-line-ratio))',
+        '--ezco-mde-leading-tight': 'calc(var(--ezco-mde-leading-snug) / var(--ezco-mde-line-ratio))',
+
         // Default to light mode, overridden by media query
         '--ezco-mde-code-bg': 'var(--ezco-mde-code-bg-light)',
         '--ezco-mde-bg': 'var(--ezco-mde-bg-light)',
@@ -39,6 +62,60 @@ export const styleModule: StyleModule = new StyleModule({
             cursor: 'pointer',
         },
 
+        // Typography styles for Markdown elements using modular scale
+        '& h1': {
+            'font-size': 'var(--ezco-mde-text-4xl)',
+            'line-height': 'var(--ezco-mde-leading-tight)',
+            'margin': '0.67em 0',
+            'font-weight': 'bold',
+        },
+        '& h2': {
+            'font-size': 'var(--ezco-mde-text-3xl)',
+            'line-height': 'var(--ezco-mde-leading-tight)',
+            'margin': '0.75em 0 0.5em 0',
+            'font-weight': 'bold',
+        },
+        '& h3': {
+            'font-size': 'var(--ezco-mde-text-2xl)',
+            'line-height': 'var(--ezco-mde-leading-snug)',
+            'margin': '0.83em 0 0.5em 0',
+            'font-weight': 'bold',
+        },
+        '& h4': {
+            'font-size': 'var(--ezco-mde-text-xl)',
+            'line-height': 'var(--ezco-mde-leading-snug)',
+            'margin': '1em 0 0.5em 0',
+            'font-weight': 'bold',
+        },
+        '& h5': {
+            'font-size': 'var(--ezco-mde-text-lg)',
+            'line-height': 'var(--ezco-mde-leading-normal)',
+            'margin': '1.17em 0 0.5em 0',
+            'font-weight': 'bold',
+        },
+        '& h6': {
+            'font-size': 'var(--ezco-mde-text-base)',
+            'line-height': 'var(--ezco-mde-leading-normal)',
+            'margin': '1.33em 0 0.5em 0',
+            'font-weight': 'bold',
+        },
+        '& p': {
+            'font-size': 'var(--ezco-mde-text-base)',
+            'line-height': 'var(--ezco-mde-leading-relaxed)',
+            'margin': '1em 0',
+        },
+        '& blockquote': {
+            'font-size': 'var(--ezco-mde-text-base)',
+            'line-height': 'var(--ezco-mde-leading-relaxed)',
+            'margin': '1.5em 0',
+            'padding': '0 1em',
+            'border-left': '4px solid #ddd',
+        },
+        '& small': {
+            'font-size': 'var(--ezco-mde-text-sm)',
+            'line-height': 'var(--ezco-mde-leading-normal)',
+        },
+
         // Codeblock styles
         '& .cm-editor': {
             margin: '2rem 0',
@@ -51,6 +128,8 @@ export const styleModule: StyleModule = new StyleModule({
             background: 'var(--ezco-mde-code-bg)',
             padding: '0.1em 0.3em',
             'border-radius': '3px',
+            '-webkit-box-decoration-break': 'clone',
+            'box-decoration-break': 'clone',
         },
         // Table styles
         '&.tableWrapper': {
@@ -121,6 +200,12 @@ export const styleModule: StyleModule = new StyleModule({
         '& li > p': {
             'margin-top': 0,
             'margin-bottom': 0,
+            'font-size': 'var(--ezco-mde-text-base)',
+            'line-height': 'var(--ezco-mde-leading-relaxed)',
+        },
+        '& ol > li > p, & ul > li > p': {
+            'font-size': 'var(--ezco-mde-text-base)',
+            'line-height': 'var(--ezco-mde-leading-relaxed)',
         },
         // Task list styles
         '& li[data-checked="true"]>div>p': {
@@ -162,5 +247,13 @@ export const styleModule: StyleModule = new StyleModule({
                 flex: 1
             }
         },
+        // Make task checkboxes visible when selected (Ctrl-A)
+        // Checkboxes don't natively show selection highlighting,
+        // so add an outline using the system Highlight color
+        '& ul[data-type="taskList"] li > label > input[type="checkbox"]': {
+            '&::selection': {
+                background: 'Highlight',
+            },
+        },
     }
 })

package/src/test/multiview-sync.test.ts

@@ -0,0 +1,137 @@
+import { describe, it, expect, beforeEach, afterEach } from 'vitest'
+import { fileChangeBus } from '@joinezco/codeblock'
+import { EditorView } from '@codemirror/view'
+import { EditorState } from '@codemirror/state'
+
+describe('FileChangeBus', () => {
+    let viewA: EditorView
+    let viewB: EditorView
+    let containerA: HTMLElement
+    let containerB: HTMLElement
+
+    beforeEach(() => {
+        containerA = document.createElement('div')
+        containerB = document.createElement('div')
+        document.body.appendChild(containerA)
+        document.body.appendChild(containerB)
+
+        viewA = new EditorView({
+            state: EditorState.create({ doc: 'initial' }),
+            parent: containerA,
+        })
+        viewB = new EditorView({
+            state: EditorState.create({ doc: 'initial' }),
+            parent: containerB,
+        })
+    })
+
+    afterEach(() => {
+        viewA.destroy()
+        viewB.destroy()
+        containerA.remove()
+        containerB.remove()
+    })
+
+    it('should notify other subscribers but not the source', () => {
+        const received: { view: string; content: string }[] = []
+
+        fileChangeBus.subscribe('test.txt', viewA, (content) => {
+            received.push({ view: 'A', content })
+        })
+        fileChangeBus.subscribe('test.txt', viewB, (content) => {
+            received.push({ view: 'B', content })
+        })
+
+        // Notify from view A — only B should receive
+        fileChangeBus.notify('test.txt', 'hello from A', viewA)
+
+        expect(received).toEqual([{ view: 'B', content: 'hello from A' }])
+    })
+
+    it('should not notify after unsubscribe', () => {
+        const received: string[] = []
+
+        const unsub = fileChangeBus.subscribe('test.txt', viewA, (content) => {
+            received.push(content)
+        })
+        fileChangeBus.subscribe('test.txt', viewB, () => {})
+
+        unsub()
+        fileChangeBus.notify('test.txt', 'hello', viewB)
+
+        expect(received).toEqual([])
+    })
+
+    it('should handle multiple files independently', () => {
+        const received: string[] = []
+
+        fileChangeBus.subscribe('a.txt', viewA, (content) => {
+            received.push('a:' + content)
+        })
+        fileChangeBus.subscribe('b.txt', viewA, (content) => {
+            received.push('b:' + content)
+        })
+
+        fileChangeBus.notify('a.txt', 'one', viewB)
+        fileChangeBus.notify('b.txt', 'two', viewB)
+
+        expect(received).toEqual(['a:one', 'b:two'])
+    })
+
+    it('should sync document content between views via the bus', () => {
+        // Simulate two views on the same file using the bus to sync
+
+        const unsubA = fileChangeBus.subscribe('shared.txt', viewA, (content) => {
+            if (viewA.state.doc.toString() !== content) {
+                viewA.dispatch({ changes: { from: 0, to: viewA.state.doc.length, insert: content } })
+            }
+        })
+        const unsubB = fileChangeBus.subscribe('shared.txt', viewB, (content) => {
+            if (viewB.state.doc.toString() !== content) {
+                viewB.dispatch({ changes: { from: 0, to: viewB.state.doc.length, insert: content } })
+            }
+        })
+
+        // Edit view A and "save" (notify the bus)
+        viewA.dispatch({ changes: { from: 0, to: viewA.state.doc.length, insert: 'updated content' } })
+        fileChangeBus.notify('shared.txt', 'updated content', viewA)
+
+        // View B should have received the update
+        expect(viewB.state.doc.toString()).toBe('updated content')
+        // View A should NOT have been re-dispatched (it was the source)
+        expect(viewA.state.doc.toString()).toBe('updated content')
+
+        unsubA()
+        unsubB()
+    })
+
+    it('should not create infinite loops when both views subscribe', () => {
+        let dispatchCountA = 0
+        let dispatchCountB = 0
+
+        fileChangeBus.subscribe('shared.txt', viewA, (content) => {
+            if (viewA.state.doc.toString() !== content) {
+                dispatchCountA++
+                viewA.dispatch({ changes: { from: 0, to: viewA.state.doc.length, insert: content } })
+                // In the real codeblockView, this dispatch would NOT trigger save because
+                // receivingExternalUpdate is true. So we do NOT re-notify.
+            }
+        })
+        fileChangeBus.subscribe('shared.txt', viewB, (content) => {
+            if (viewB.state.doc.toString() !== content) {
+                dispatchCountB++
+                viewB.dispatch({ changes: { from: 0, to: viewB.state.doc.length, insert: content } })
+            }
+        })
+
+        // Simulate save from A
+        viewA.dispatch({ changes: { from: 0, to: viewA.state.doc.length, insert: 'final' } })
+        fileChangeBus.notify('shared.txt', 'final', viewA)
+
+        // Only B should have dispatched once
+        expect(dispatchCountA).toBe(0)
+        expect(dispatchCountB).toBe(1)
+        expect(viewA.state.doc.toString()).toBe('final')
+        expect(viewB.state.doc.toString()).toBe('final')
+    })
+})

package/TEST_README.md

@@ -1,359 +0,0 @@
-# Markdown Editor Testing Guide
-
-This document explains how to use the testing setup for the `@joinezco/markdown-editor` library.
-
-## Overview
-
-The testing setup uses **Vitest** with **browser testing capabilities** to test the markdown editor in a real browser environment. This allows us to test DOM interactions, keyboard events, and the actual rendering behavior of the editor.
-
-## Setup
-
-### Dependencies
-
-The following testing dependencies are included:
-
-- `vitest` - Fast unit test framework
-- `@vitest/browser` - Browser testing support
-- `@vitest/ui` - Web UI for test results
-- `playwright` - Browser automation for testing
-- `jsdom` - DOM implementation for Node.js
-- `webdriverio` - WebDriver implementation
-
-### Configuration
-
-The testing is configured in [`vitest.config.ts`](./vitest.config.ts) with:
-
-- **Browser testing enabled** using Playwright with Chromium
-- **Test environment** set up with proper DOM mocking
-- **Coverage reporting** with v8 provider
-- **Custom setup file** for browser environment preparation
-
-## Running Tests
-
-### Available Scripts
-
-```bash
-# Run tests in watch mode
-npm run test
-
-# Run tests with UI
-npm run test:ui
-
-# Run tests in browser mode
-npm run test:browser
-
-# Run tests once and exit
-npm run test:run
-
-# Run tests with coverage
-npm run test:coverage
-```
-
-### Test Files
-
-Tests are located in the `src/test/` directory:
-
-- [`setup.ts`](./src/test/setup.ts) - Global test setup and browser mocks
-- [`utils.ts`](./src/test/utils.ts) - Testing utilities for markdown editor
-- [`editor.test.ts`](./src/test/editor.test.ts) - Core editor functionality tests
-- [`extensions.test.ts`](./src/test/extensions.test.ts) - Extension-specific tests
-
-## Testing Utilities
-
-The [`utils.ts`](./src/test/utils.ts) file provides comprehensive utilities for testing the markdown editor:
-
-### DOM Management
-
-```typescript
-// Create a test container
-const container = createTestContainer()
-
-// Create and initialize editor
-const editor = await createTestEditor(container)
-await waitForEditor(editor)
-
-// Cleanup after test
-cleanupEditor(editor, container)
-```
-
-### Content Management
-
-```typescript
-// Get current markdown content
-const content = getMarkdownContent(editor)
-
-// Set new markdown content
-setMarkdownContent(editor, '# New Content')
-
-// Get HTML output
-const html = getHTMLContent(editor)
-```
-
-### User Interactions
-
-```typescript
-// Focus the editor
-focusEditor(editor)
-
-// Type text
-typeText(editor, 'Hello, World!')
-
-// Simulate key presses
-pressKey(editor, 'b', { ctrl: true }) // Ctrl+B for bold
-
-// Set cursor position
-setSelection(editor, 0, 10) // Select characters 0-10
-```
-
-### Async Operations
-
-```typescript
-// Wait for conditions
-await waitFor(() => editor.isFocused, 5000)
-
-// Wait for editor to be ready
-await waitForEditor(editor)
-```
-
-## Test Categories
-
-### Basic Editor Functionality
-
-Tests core editor features:
-- Editor initialization and DOM rendering
-- Content getting/setting
-- Focus management
-- Selection handling
-
-### Markdown Content Management
-
-Tests markdown processing:
-- Content conversion between markdown and HTML
-- Handling of various markdown syntax
-- Content validation and error handling
-
-### Text Input and Editing
-
-Tests user input:
-- Text insertion at cursor position
-- Line breaks and formatting
-- Keyboard shortcuts (Ctrl+B, Ctrl+I, etc.)
-
-### Extension Testing
-
-Tests specific editor extensions:
-- **Task Lists** - Checkbox rendering and interaction
-- **Tables** - Table rendering and navigation
-- **Links** - Link detection and rendering
-- **Code Blocks** - Syntax highlighting and language support
-- **Slash Commands** - Command menu functionality
-
-### Browser-specific Features
-
-Tests browser interactions:
-- Copy/paste operations
-- Undo/redo functionality
-- Keyboard event handling
-- DOM event simulation
-
-## Writing New Tests
-
-### Basic Test Structure
-
-```typescript
-import { describe, it, expect, beforeEach, afterEach } from 'vitest'
-import { MarkdownEditor } from '../lib/editor'
-import {
-  createTestContainer,
-  createTestEditor,
-  waitForEditor,
-  cleanupEditor,
-} from './utils'
-
-describe('My Feature', () => {
-  let container: HTMLElement
-  let editor: MarkdownEditor
-
-  beforeEach(async () => {
-    container = createTestContainer()
-    editor = await createTestEditor(container)
-    await waitForEditor(editor)
-  })
-
-  afterEach(() => {
-    cleanupEditor(editor, container)
-  })
-
-  it('should do something', () => {
-    // Your test code here
-    expect(editor).toBeDefined()
-  })
-})
-```
-
-### Testing Editor State
-
-```typescript
-it('should update content correctly', () => {
-  setMarkdownContent(editor, '# Test Heading')
-  const content = getMarkdownContent(editor)
-  expect(content).toContain('# Test Heading')
-  
-  const html = getHTMLContent(editor)
-  expect(html).toContain('<h1>Test Heading</h1>')
-})
-```
-
-### Testing User Interactions
-
-```typescript
-it('should handle keyboard shortcuts', () => {
-  focusEditor(editor)
-  typeText(editor, 'bold text')
-  setSelection(editor, 0, 9) // Select "bold text"
-  
-  pressKey(editor, 'b', { ctrl: true })
-  
-  const content = getMarkdownContent(editor)
-  expect(content).toContain('**bold text**')
-})
-```
-
-### Testing Async Operations
-
-```typescript
-it('should handle async updates', async () => {
-  let updateTriggered = false
-  
-  const testEditor = await createTestEditor(container, {
-    onUpdate: () => { updateTriggered = true }
-  })
-  
-  typeText(testEditor, 'New content')
-  
-  await waitFor(() => updateTriggered, 2000)
-  expect(updateTriggered).toBe(true)
-})
-```
-
-## Browser Testing Features
-
-### Real DOM Environment
-
-Tests run in a real browser environment (Chromium via Playwright), providing:
-- Accurate DOM rendering
-- Real event handling
-- Proper CSS layout
-- Browser-specific behaviors
-
-### Visual Testing
-
-While not implemented in the current setup, the browser environment supports:
-- Screenshot comparison testing
-- Visual regression testing
-- Layout testing
-
-### Performance Testing
-
-The browser environment allows for:
-- Measuring render times
-- Testing with large documents
-- Memory usage monitoring
-
-## Debugging Tests
-
-### Using the UI
-
-Run tests with the UI for better debugging:
-
-```bash
-npm run test:ui
-```
-
-This opens a web interface showing:
-- Test results and failures
-- Test execution timeline
-- Code coverage reports
-- Interactive test running
-
-### Browser DevTools
-
-When running browser tests, you can:
-- Set `headless: false` in `vitest.config.ts`
-- Use browser DevTools for debugging
-- Inspect the actual DOM during tests
-
-### Console Logging
-
-Add debug logging in tests:
-
-```typescript
-it('should debug editor state', () => {
-  console.log('Editor state:', editor.state)
-  console.log('Current content:', getMarkdownContent(editor))
-  // ... test code
-})
-```
-
-## Best Practices
-
-### Test Isolation
-
-- Always use `beforeEach`/`afterEach` for setup/cleanup
-- Create fresh editor instances for each test
-- Clean up DOM elements after tests
-
-### Async Handling
-
-- Use `await waitForEditor()` after creating editors
-- Use `waitFor()` for conditional waiting
-- Handle async operations properly
-
-### Realistic Testing
-
-- Test actual user interactions (typing, clicking)
-- Use real markdown content in tests
-- Test edge cases and error conditions
-
-### Performance
-
-- Keep tests focused and fast
-- Use appropriate timeouts
-- Clean up resources properly
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Editor not ready**: Always use `await waitForEditor(editor)` after creation
-2. **DOM not found**: Ensure container is created and editor is initialized
-3. **Async timing**: Use `waitFor()` for conditions that may take time
-4. **Memory leaks**: Always call `cleanupEditor()` in `afterEach`
-
-### Browser Issues
-
-1. **Headless failures**: Set `headless: false` for debugging
-2. **Timeout errors**: Increase timeout values in config
-3. **Worker issues**: Check that worker files are accessible
-
-## Contributing
-
-When adding new tests:
-
-1. Follow the existing test structure
-2. Add utilities to `utils.ts` for reusable functionality
-3. Group related tests in describe blocks
-4. Use descriptive test names
-5. Include both positive and negative test cases
-6. Test browser-specific behaviors when relevant
-
-## Future Enhancements
-
-Potential improvements to the testing setup:
-
-- Visual regression testing with screenshot comparison
-- Performance benchmarking tests
-- Accessibility testing integration
-- Cross-browser testing support
-- Integration with CI/CD pipelines
-- Test data generation utilities