Update PROJECT_STRUCTURE.md to reflect current codebase #95
Conversation
Fixes NullPointerDepressiveDisorder#90 ## Changes ### Added missing files to documentation: **Core/** - TouchDeviceProviding.swift: Protocol for device monitoring/dependency injection **Managers/** - AccessibilityMonitor.swift: Accessibility permission polling and app handling - AccessibilityWrappers.swift: Wrappers for accessibility system APIs (testability) **Utilities/** - ScreenHelper.swift: Multi-monitor screen coordinate handling - SystemGestureHelper.swift: System trackpad settings and process management - UpdateManager.swift: App updates via Sparkle framework - WindowHelper.swift: Window detection under cursor ### Added test files to documentation: - All unit test files now documented - Added Mocks/ directory with MockDeviceMonitor ### Consolidation: - Removed duplicate /MiddleDrag/PROJECT_STRUCTURE.md (root version is canonical) ### Updated component responsibilities: - Added descriptions for new Manager layer components - Added descriptions for new Utility layer components - Added Protocol-Oriented Design to design patterns - Updated "Adding New Features" section with new entry points
There was a problem hiding this comment.
Pull request overview
This PR updates PROJECT_STRUCTURE.md to accurately reflect the current codebase structure, addressing issue #90.
Changes:
- Consolidated duplicate PROJECT_STRUCTURE.md files by removing the outdated inner copy
- Added documentation for 7 missing source files across Core/, Managers/, and Utilities/ directories
- Expanded test section from 3 files to all 17 test files including the Mocks/ directory
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| PROJECT_STRUCTURE.md | Updated with all current source files, complete test listing, expanded component responsibilities, and updated design patterns |
| MiddleDrag/PROJECT_STRUCTURE.md | Removed duplicate outdated documentation file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ├── workflows/ # CI/CD workflows | ||
| │ └── *.yml # GitHub Actions workflow files | ||
| ├── ISSUE_TEMPLATE/ # Issue templates | ||
| └── copilot-instructions.md # Copilot configuration |
There was a problem hiding this comment.
The reference to copilot-instructions.md should be removed as this file doesn't exist in the repository. This was specifically mentioned in checklist item #4 of issue #90: "Remove mention of .github/copilot-instructions.md from the .github/ section (file doesn't exist)". The line should be deleted entirely.
| └── copilot-instructions.md # Copilot configuration |
|
|
||
| The refactored code maintains minimal dependencies: | ||
| - No external Swift packages required | ||
| - No external Swift packages required (except Sparkle for updates) |
There was a problem hiding this comment.
The dependencies documentation is incomplete. The project uses both Sparkle (for updates) and Sentry (for analytics/error reporting) as external packages, but only Sparkle is mentioned. The line should be updated to mention both dependencies, for example: "No external Swift packages required (except Sparkle for updates and Sentry for analytics)".
| - No external Swift packages required (except Sparkle for updates) | |
| - No external Swift packages required (except Sparkle for updates and Sentry for analytics/error reporting) |
1 participant
Summary
Fixes #90
Updates the project structure documentation to accurately reflect the current source files, following the checklist provided in the issue.
Changes
✅ 1. Consolidated duplicate PROJECT_STRUCTURE.md files
/MiddleDrag/PROJECT_STRUCTURE.md(the inner, outdated one)/PROJECT_STRUCTURE.mdis now the single canonical version✅ 2. Added missing source files to documentation
Core/
TouchDeviceProviding.swift: Protocol for device monitoring and dependency injectionManagers/
AccessibilityMonitor.swift: Accessibility permission polling and app handlingAccessibilityWrappers.swift: Wrappers for accessibility system APIs (enables testability)Utilities/
ScreenHelper.swift: Multi-monitor screen coordinate handling (Cocoa ↔ Quartz)SystemGestureHelper.swift: System trackpad settings and process managementUpdateManager.swift: App updates via Sparkle framework (offline by default)WindowHelper.swift: Window detection under cursorAdditional improvements
Mocks/directory withMockDeviceMonitor.swift