Skip to content

Commit eb91722

Browse files
author
MbappeWU
committed
feat: MacSweep v1.0.0 — initial release
macOS system cleaner with Smart Scan, 8 cleanup modules, storage visualization, and i18n (en/zh) support.
0 parents  commit eb91722

File tree

4 files changed

+204
-0
lines changed

4 files changed

+204
-0
lines changed

‎.gitignore‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# ==============================================================================
2+
# MacSweep .gitignore — Commercial Distribution
3+
# Only README, LICENSE, and release assets are tracked in the public repo.
4+
# All source code is excluded from version control.
5+
# ==============================================================================
6+
7+
# ---------- Core Source Code (HIDDEN) ----------
8+
bin/
9+
lib/
10+
modules/
11+
gui/
12+
xcode/
13+
tests/
14+
config.yaml
15+
16+
# ---------- Hidden Backups ----------
17+
.install.sh.bak
18+
.macsweep.rb.bak
19+
20+
# ---------- Build Artifacts ----------
21+
build/
22+
dist/
23+
*.app
24+
*.dmg
25+
*.zip
26+
node_modules/
27+
28+
# ---------- IDE & OS ----------
29+
.DS_Store
30+
*.swp
31+
*.swo
32+
.vscode/
33+
.idea/
34+
*.xcworkspace
35+
*.xcuserdata
36+
37+
# ---------- Claude / Dev Context ----------
38+
.claude/
39+
40+
# ---------- Release & CI (keep private) ----------
41+
.github/
42+
43+
# ---------- Misc ----------
44+
*.log
45+
*.tmp
46+
/tmp/
47+
48+
# Payment server secrets
49+
payment/.env
50+
payment/node_modules/

‎CHANGELOG.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Changelog
2+
3+
## [1.0.0] - 2026-03-04
4+
5+
### Features
6+
- Smart Scan: one-click full-system scan across 6 modules (cache, logs, downloads, dev junk, large files, leftovers)
7+
- 3-layer safety engine: whitelist protection, safety classification (safe/caution), and audit logging
8+
- Storage Map: visual disk usage breakdown with interactive donut chart
9+
- System Data: real-time CPU, memory, disk, and battery monitoring
10+
- Module-level detail pages: file browser with filtering, sorting, and bulk selection
11+
- Ignore List: persistent path exclusion with glob pattern support
12+
- Smart Rules: configurable auto-selection rules for recurring cleanup patterns
13+
- Settings: locale (EN/ZH), delete method (trash/permanent), privacy consent management
14+
- About page with privacy policy and terms of service (bilingual)
15+
16+
### Security
17+
- AppleScript injection protection with control character filtering
18+
- TOCTOU race condition mitigation on file deletion paths
19+
- Shell injection prevention (direct execFile calls, no `bash -c`)
20+
- Path prefix matching hardened with trailing `/` validation
21+
- CORS restricted to specific localhost ports
22+
- Module ID whitelist validation
23+
- HOME environment variable validation at startup
24+
- Safe tilde expansion function
25+
- Argument terminators (`--`) on all `rm`/`mv` calls
26+
27+
### GUI
28+
- Toast notification system (success/warning/error)
29+
- Reusable ErrorState and EmptyState components
30+
- Privacy consent modal with links to full policy/terms
31+
- Animated state transitions with Framer Motion
32+
- Responsive layout with Tailwind CSS 4.2
33+
34+
### Build & Distribution
35+
- Universal binary (arm64 + x86_64) via `build.sh`
36+
- Node.js runtime bundling with production dependency trimming
37+
- DMG creation with Applications shortcut (`--dmg`)
38+
- Apple notarization support (`--notarize`)
39+
- Post-build verification (`--verify`)
40+
- Privacy manifest (PrivacyInfo.plist) bundled into app Resources
41+
42+
### Testing
43+
- CLI: 19 tests across 6 modules (bash unit tests)
44+
- GUI: 31 tests (Vitest + React Testing Library)
45+
- Utility functions (formatSize, shortenPath, clamp)
46+
- Store reducer (13 state management tests)
47+
- Toast component (rendering, auto-dismiss, multiple toasts)
48+
49+
### Compliance
50+
- Apple Privacy Manifest: File Timestamp (C617.1) + Disk Space (E174.1) API declarations
51+
- NSPrivacyTracking = NO, no user data collection
52+
- Bilingual privacy policy and terms of service

‎LICENSE‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
MacSweep - Proprietary Software License
2+
3+
Copyright (c) 2024-2026 WU LEIZHI. All rights reserved.
4+
5+
This software and associated documentation files (the "Software") are
6+
proprietary and confidential. Unauthorized copying, modification,
7+
distribution, or use of this Software, via any medium, is strictly
8+
prohibited.
9+
10+
The Software is provided under a paid license. You may use the Software
11+
only after purchasing a valid license. Each license is tied to a single
12+
user and a single device.
13+
14+
You may NOT:
15+
- Copy, modify, or distribute the Software
16+
- Reverse engineer, decompile, or disassemble the Software
17+
- Remove or alter any proprietary notices
18+
- Sublicense, rent, or lease the Software
19+
- Use the Software for any unlawful purpose
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23+
OTHER LIABILITY ARISING FROM THE USE OF THE SOFTWARE.
24+
25+
For licensing inquiries: macsweep@wuleizhi.com

‎README.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# MacSweep
2+
3+
Safety-first macOS storage cleaner. Reclaim disk space with confidence.
4+
5+
## Download
6+
7+
**[Download MacSweep v1.0.0](https://github.com/user/macSweep/releases/latest)** (macOS 12+, Apple Silicon & Intel)
8+
9+
## Features
10+
11+
- **6 Cleaning Modules** — caches, logs, downloads, developer junk, large files, app leftovers
12+
- **Safety Engine** — hardcoded path protection, two-tier allow/deny, audit logging
13+
- **Trash-First Deletion** — files go to Trash by default, recoverable for 30 days
14+
- **Native macOS App** — beautiful GUI with real-time scan progress
15+
- **CLI Included** — `macsweep scan`, `macsweep clean` for power users
16+
- **No Root Required** — runs entirely in user space
17+
18+
## Screenshots
19+
20+
<!-- TODO: Add screenshots -->
21+
22+
## Safety Model
23+
24+
MacSweep uses a three-layer safety system:
25+
26+
1. **Protected Paths** — system paths and sensitive data are hardcoded as untouchable (`/System`, `~/.ssh`, `~/Library/Keychains`, etc.)
27+
2. **Directory-Only Protection** — `~/Documents`, `~/Desktop` directories are preserved; only their cleanable children are flagged
28+
3. **Allowed Clean Prefixes** — only files under explicitly safe paths (`~/Library/Caches`, `~/Library/Logs`, etc.) can be cleaned
29+
30+
Every operation is recorded in `~/Library/Logs/MacSweep/operations.log`.
31+
32+
## System Requirements
33+
34+
- macOS 12 (Monterey) or later
35+
- Apple Silicon or Intel Mac
36+
- ~150 MB disk space
37+
38+
## Installation
39+
40+
1. Download `MacSweep.dmg` from the [Releases page](https://github.com/user/macSweep/releases/latest)
41+
2. Open the DMG and drag MacSweep to Applications
42+
3. Launch MacSweep from Applications or Spotlight
43+
44+
The CLI tool is bundled inside the app. To use it:
45+
```bash
46+
# Add to PATH (one-time setup)
47+
sudo ln -sf /Applications/MacSweep.app/Contents/Resources/cli/bin/macsweep /usr/local/bin/macsweep
48+
```
49+
50+
## Pricing
51+
52+
**Free download. Pro upgrade unlocks everything.**
53+
54+
| | Free | Pro |
55+
|--|------|-----|
56+
| **Price** | $0 | $1.99/mo or $12.99/yr |
57+
| Full disk scan | Yes | Yes |
58+
| Clean caches & logs | Up to 500 MB/mo | Unlimited |
59+
| All 6 modules | 3 modules | All 6 modules |
60+
| CLI tool | - | Included |
61+
| Real-time monitoring | - | Included |
62+
| Priority updates | - | Yes |
63+
64+
> **Launch Special:** $9.99/year for early adopters (limited time)
65+
>
66+
> Lifetime license available: **$29.99** (one-time, up to 3 Macs)
67+
68+
## Support
69+
70+
- Issues: [GitHub Issues](https://github.com/user/macSweep/issues)
71+
- Email: macsweep@wuleizhi.com
72+
73+
## License
74+
75+
MacSweep is proprietary software. See [LICENSE](LICENSE) for details.
76+
77+
Copyright (c) 2024-2026 WU LEIZHI. All rights reserved.

0 commit comments

Comments
 (0)