mirror of https://github.com/johannesjo/super-productivity.git synced 2026-07-18 17:05:48 +00:00

History

Johannes Millan c73eeff75b fix(sync-md): prevent crash from sync oscillation when adding subtask to markdown file When a user adds a subtask by editing the markdown file directly, the MD→SP sync creates the task which triggers SP hooks, which trigger SP→MD sync, which writes the file, which the file watcher detects, creating a rapid sync oscillation loop that crashes the app. Three-layer fix: 1. Stop file watcher for the entire MD→SP sync duration and cancel pending SP→MD debounce timers 2. Add a cooldown after MD→SP sync (set before and after in finally block) to suppress SP hooks that fire as side-effects 3. Simplify lazySetInterval with async/await and a stopped flag to prevent zombie rescheduling when cancelled during async callbacks Also fixes a file watcher race condition where polling could start before initial mtime was resolved. Fixes #6021		2026-03-24 14:12:50 +01:00
..
docs	feat(sync-md): new approach and make it work better	2025-07-07 18:39:14 +02:00
scripts	fix: all console errors	2025-07-22 20:34:12 +02:00
src	fix(sync-md): prevent crash from sync oscillation when adding subtask to markdown file	2026-03-24 14:12:50 +01:00
.gitignore	feat(sync-md): new approach and make it work better	2025-07-07 18:39:14 +02:00
.prettierrc.json	feat(syncMd): add comprehensive test suite and development configuration	2025-07-10 14:56:19 +02:00
eslint.config.js	chore(deps): upgrade ESLint to v9 with flat config	2026-01-10 16:08:11 +01:00
jest.config.cjs	fix(sync-md): prevent crash from sync oscillation when adding subtask to markdown file	2026-03-24 14:12:50 +01:00
jest.config.js.bak	fix(sync-md): fix failing tests after parser changes	2025-07-10 19:17:41 +02:00
package-lock.json	chore(deps): bump the npm_and_yarn group across 5 directories with 2 updates (#6659 )	2026-02-28 14:19:16 +01:00
package.json	build: update vite dep	2025-10-28 11:07:52 +01:00
README.md	fix(sync): fix stale comments, doc refs, and preserve lastSeq on clean-slate	2026-02-12 16:27:56 +01:00
tsconfig.json	feat(sync-md): new approach and make it work better	2025-07-07 18:39:14 +02:00
vite.config.ts	feat(sync-md): new approach and make it work better	2025-07-07 18:39:14 +02:00

README.md

Sync-MD Plugin v2.0.0

A SuperProductivity plugin that enables bidirectional synchronization between markdown files and project tasks.

Features

Bidirectional Sync: Keep markdown files and SuperProductivity tasks in sync
Batch API Integration: Efficient bulk operations for better performance
Smart Debouncing: 10-second delays prevent conflicts during active editing
Real-time Monitoring: File system watching with automatic sync triggers
Task Hierarchy: Preserves parent-child relationships in markdown
Modern Architecture: Built with Solid.js UI and modular TypeScript

Quick Start

# Install dependencies
npm install

# Development mode with hot reload
npm run dev:watch

# Build for production
npm run build

# Package as plugin
npm run package

Architecture

Core Components

src/fileWatcherBatch.ts - Main sync engine with batch API support
src/background.ts - Plugin lifecycle and message handling
src/App.tsx - Solid.js UI for configuration
src/utils/ - Reusable utilities (parser, debouncer, file ops)

Build System

build-proper.js - Main build script
build-plugin.js - Package as distributable ZIP
watch-and-build.js - Development with auto-rebuild

Configuration

{
  projectId: "project-uuid",
  filePath: "/path/to/tasks.md",
  syncDirection: "fileToProject" | "projectToFile" | "bidirectional"
}

Markdown Format

- [ ] Parent task
  - [x] <!-- sp:task-id --> Completed subtask
  - [ ] Pending subtask

Tasks are linked using HTML comments containing unique IDs.

Testing

# Run all tests
npm test

# Watch mode
npm run test:watch

# Coverage report
npm run test:coverage

Cleanup

To remove old/unnecessary files after updating:

chmod +x cleanup.sh
./cleanup.sh