Skip to content

Update PROJECT_STRUCTURE.md to reflect current codebase#95

Merged
NullPointerDepressiveDisorder merged 3 commits intoNullPointerDepressiveDisorder:mainfrom
William-Laverty:docs-update-project-structure
Feb 3, 2026
Merged

Update PROJECT_STRUCTURE.md to reflect current codebase#95
NullPointerDepressiveDisorder merged 3 commits intoNullPointerDepressiveDisorder:mainfrom
William-Laverty:docs-update-project-structure

Conversation

@William-Laverty
Copy link
Contributor

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

  • Removed /MiddleDrag/PROJECT_STRUCTURE.md (the inner, outdated one)
  • Root /PROJECT_STRUCTURE.md is now the single canonical version

✅ 2. Added missing source files to documentation

Core/

  • TouchDeviceProviding.swift: Protocol for device monitoring and dependency injection

Managers/

  • AccessibilityMonitor.swift: Accessibility permission polling and app handling
  • AccessibilityWrappers.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 management
  • UpdateManager.swift: App updates via Sparkle framework (offline by default)
  • WindowHelper.swift: Window detection under cursor

Additional improvements

  • Added all unit test files to documentation
  • Added Mocks/ directory with MockDeviceMonitor.swift
  • Updated "Component Responsibilities" section with new components
  • Added "Protocol-Oriented Design" to design patterns
  • Updated "Adding New Features" section with new entry points
  • Minor formatting improvements for consistency

Fixes #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
Copilot AI review requested due to automatic review settings February 2, 2026 09:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Karan Mohindroo <96403086+NullPointerDepressiveDisorder@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Karan Mohindroo <96403086+NullPointerDepressiveDisorder@users.noreply.github.com>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contrabution!

@NullPointerDepressiveDisorder NullPointerDepressiveDisorder merged commit 01c4d0a into NullPointerDepressiveDisorder:main Feb 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update PROJECT_STRUCTURE.md to reflect current codebase

2 participants

Comments