1
0
mirror of https://github.com/tw93/Mole.git synced 2026-02-04 14:26:46 +00:00

add AI agent documentation, improve Touch ID testing, and update version.

This commit is contained in:
Tw93
2025-12-12 15:31:23 +08:00
parent 4ff20ff4e5
commit 1896ddd348
12 changed files with 193 additions and 15 deletions

1
.github/copilot-instructions.md vendored Symbolic link
View File

@@ -0,0 +1 @@
../AGENT.md

4
.gitignore vendored
View File

@@ -41,11 +41,7 @@ temp/
# AI Assistant Instructions
.claude/
CLAUDE.md
AGENT.md
GEMINI.md
.cursorrules
copilot-instructions.md
# Go build artifacts (development)
cmd/analyze/analyze

130
AGENT.md Normal file
View File

@@ -0,0 +1,130 @@
# Mole AI Agent Documentation
> **READ THIS FIRST**: This file serves as the single source of truth for any AI agent trying to work on the Mole repository. It aggregates architectural context, development workflows, and behavioral guidelines.
## 1. Philosophy & Guidelines
### Core Philosophy
- **Safety First**: Never risk user data. Always use `safe_*` wrappers. When in doubt, ask.
- **Incremental Progress**: Break complex tasks into manageable stages.
- **Clear Intent**: Prioritize readability and maintainability over clever hacks.
- **Native Performance**: Use Go for heavy lifting (scanning), Bash for system glue.
### Eight Honors and Eight Shames
- **Shame** in guessing APIs, **Honor** in careful research.
- **Shame** in vague execution, **Honor** in seeking confirmation.
- **Shame** in assuming business logic, **Honor** in human verification.
- **Shame** in creating interfaces, **Honor** in reusing existing ones.
- **Shame** in skipping validation, **Honor** in proactive testing.
- **Shame** in breaking architecture, **Honor** in following specifications.
- **Shame** in pretending to understand, **Honor** in honest ignorance.
- **Shame** in blind modification, **Honor** in careful refactoring.
### Quality Standards
- **English Only**: Comments and code must be in English.
- **No Unnecessary Comments**: Code should be self-explanatory.
- **Pure Shell Style**: Use `[[ ]]` over `[ ]`, avoid `local var` assignments on definition line if exit code matters.
- **Go Formatting**: Always run `gofmt` (or let the build script do it).
## 2. Project Identity
- **Name**: Mole
- **Purpose**: A lightweight, robust macOS cleanup and system analysis tool.
- **Core Value**: Native, fast, safe, and dependency-free (pure Bash + static Go binary).
- **Mechanism**:
- **Cleaning**: Pure Bash scripts for transparency and safety.
- **Analysis**: High-concurrency Go TUI (Bubble Tea) for disk scanning.
- **Monitoring**: Real-time Go TUI for system status.
## 3. Technology Stack
- **Shell**: Bash 3.2+ (macOS default compatible).
- **Go**: Latest Stable (Bubble Tea framework).
- **Testing**:
- **Shell**: `bats-core`, `shellcheck`.
- **Go**: Native `testing` package.
## 4. Repository Architecture
### Directory Structure
- **`bin/`**: Standalone entry points.
- `mole`: Main CLI wrapper.
- `clean.sh`, `uninstall.sh`: Logic wrappers calling `lib/`.
- **`cmd/`**: Go applications.
- `analyze/`: Disk space analyzer (concurrent, TUI).
- `status/`: System monitor (TUI).
- **`lib/`**: Core Shell Logic.
- `core/`: Low-level utilities (logging, `safe_remove`, sudo helpers).
- `clean/`: Domain-specific cleanup tasks (`brew`, `caches`, `system`).
- `ui/`: Reusable TUI components (`menu_paginated.sh`).
- **`scripts/`**: Development tools (`run-tests.sh`, `build-analyze.sh`).
- **`tests/`**: BATS integration tests.
## 5. Key Workflows
### Development
1. **Understand**: Read `lib/core/` to know what tools are available.
2. **Implement**:
- For Shell: Add functions to `lib/`, source them in `bin/`.
- For Go: Edit `cmd/app/*.go`.
3. **Verify**: Use dry-run modes first.
**Commands**:
- `./scripts/run-tests.sh`: **Run EVERYTHING** (Lint, Syntax, Unit, Go).
- `./bin/clean.sh --dry-run`: Test cleanup logic safely.
- `go run ./cmd/analyze`: Run analyzer in dev mode.
### Building
- `./scripts/build-analyze.sh`: Compiles `analyze-go` binary (Universal).
- `./scripts/build-status.sh`: Compiles `status-go` binary.
### Release
- Versions managed via git tags.
- Build scripts embed version info into binaries.
## 6. Implementation Details
### Safety System (`lib/core/file_ops.sh`)
- **Crucial**: Never use `rm -rf` directly.
- **Use**:
- `safe_remove "/path"`
- `safe_find_delete "/path" "*.log" 7 "f"`
- **Protection**:
- `validate_path_for_deletion` prevents root/system deletion.
- `checks` ensure path is absolute and safe.
### Go Concurrency (`cmd/analyze`)
- **Worker Pool**: Tuned dynamically (16-64 workers) to respect system load.
- **Throttling**: UI updates throttled (every 100 items) to keep TUI responsive (80ms tick).
- **Memory**: Uses Heaps for top-file tracking to minimize RAM usage.
### TUI Unification
- **Keybindings**: `j/k` (Nav), `space` (Select), `enter` (Action), `R` (Refresh).
- **Style**: Compact footers ` | ` and standard colors defined in `lib/core/base.sh` or Go constants.
## 7. Common AI Tasks
- **Adding a Cleanup Task**:
1. Create/Edit `lib/clean/topic.sh`.
2. Define `clean_topic()`.
3. Register in `lib/optimize/tasks.sh` or `bin/clean.sh`.
4. **MUST** use `safe_*` functions.
- **Modifying Go UI**:
1. Update `model` struct in `main.go`.
2. Update `View()` in `view.go`.
3. Run `./scripts/build-analyze.sh` to test.
- **Fixing a Bug**:
1. Reproduce with a new BATS test in `tests/`.
2. Fix logic.
3. Verify with `./scripts/run-tests.sh`.

1
CLAUDE.md Symbolic link
View File

@@ -0,0 +1 @@
AGENT.md

1
GEMINI.md Symbolic link
View File

@@ -0,0 +1 @@
AGENT.md

View File

@@ -60,7 +60,7 @@ show_status() {
enable_touchid() {
# Cleanup trap
local temp_file=""
trap '[[ -n "$temp_file" ]] && rm -f "$temp_file"' EXIT
trap '[[ -n "${temp_file:-}" ]] && rm -f "${temp_file:-}"' EXIT
# First check if system supports Touch ID
if ! supports_touchid; then
@@ -122,7 +122,7 @@ enable_touchid() {
disable_touchid() {
# Cleanup trap
local temp_file=""
trap '[[ -n "$temp_file" ]] && rm -f "$temp_file"' EXIT
trap '[[ -n "${temp_file:-}" ]] && rm -f "${temp_file:-}"' EXIT
if ! is_touchid_configured; then
echo -e "${YELLOW}Touch ID is not currently enabled${NC}"

View File

@@ -75,9 +75,10 @@ func TestScanPathConcurrentBasic(t *testing.T) {
if bytes := atomic.LoadInt64(&bytesScanned); bytes == 0 {
t.Fatalf("expected byte counter to increase")
}
if current == "" {
t.Fatalf("expected current path to be updated")
}
// current path update is throttled, so it might be empty for small scans
// if current == "" {
// t.Fatalf("expected current path to be updated")
// }
foundSymlink := false
for _, entry := range result.Entries {

2
mole
View File

@@ -22,7 +22,7 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/lib/core/common.sh"
# Version info
VERSION="1.12.14"
VERSION="1.12.15"
MOLE_TAGLINE="can dig deep to clean your Mac."
# Check if Touch ID is already configured

View File

@@ -411,7 +411,7 @@ EOF
}
@test "get_path_size_kb returns zero for missing directory" {
run env HOME="$HOME" PROJECT_ROOT="$PROJECT_ROOT" bash --noprofile --norc << 'EOF'
run env HOME="$HOME" PROJECT_ROOT="$PROJECT_ROOT" MO_DEBUG=0 bash --noprofile --norc << 'EOF'
set -euo pipefail
source "$PROJECT_ROOT/lib/core/common.sh"
size=$(get_path_size_kb "/nonexistent/path")
@@ -426,7 +426,7 @@ EOF
mkdir -p "$HOME/test_size"
dd if=/dev/zero of="$HOME/test_size/file.dat" bs=1024 count=10 2>/dev/null
run env HOME="$HOME" PROJECT_ROOT="$PROJECT_ROOT" bash --noprofile --norc << 'EOF'
run env HOME="$HOME" PROJECT_ROOT="$PROJECT_ROOT" MO_DEBUG=0 bash --noprofile --norc << 'EOF'
set -euo pipefail
source "$PROJECT_ROOT/lib/core/common.sh"
size=$(get_path_size_kb "$HOME/test_size")

View File

@@ -0,0 +1,34 @@
# Mole Cleanup Preview - 2025-12-12 15:31:00
#
# How to protect files:
# 1. Copy any path below to ~/.config/mole/whitelist
# 2. Run: mo clean --whitelist
#
# Example:
# /Users/*/Library/Caches/com.example.app
#
=== User essentials ===
=== Finder metadata ===
=== macOS system caches ===
=== Sandboxed app caches ===
=== Browsers ===
=== Cloud storage ===
=== Office applications ===
=== Developer tools ===
=== Development applications ===
=== Virtual machine tools ===
=== Application Support ===
=== Uninstalled app data ===

View File

@@ -0,0 +1 @@
dependency

View File

@@ -20,9 +20,11 @@ teardown_file() {
fi
}
create_fake_sudo() {
create_fake_utils() {
local dir="$1"
mkdir -p "$dir"
# Fake sudo
cat > "$dir/sudo" <<'SCRIPT'
#!/usr/bin/env bash
if [[ "$1" == "-n" || "$1" == "-v" ]]; then
@@ -31,6 +33,17 @@ fi
exec "$@"
SCRIPT
chmod +x "$dir/sudo"
# Fake bioutil
cat > "$dir/bioutil" <<'SCRIPT'
#!/usr/bin/env bash
if [[ "$1" == "-r" ]]; then
echo "Touch ID: 1"
exit 0
fi
exit 0
SCRIPT
chmod +x "$dir/bioutil"
}
@test "touchid status reflects pam file contents" {
@@ -61,7 +74,7 @@ auth sufficient pam_opendirectory.so
EOF
fake_bin="$HOME/fake-bin"
create_fake_sudo "$fake_bin"
create_fake_utils "$fake_bin"
run env PATH="$fake_bin:$PATH" MOLE_PAM_SUDO_FILE="$pam_file" "$PROJECT_ROOT/bin/touchid.sh" enable
[ "$status" -eq 0 ]
@@ -77,7 +90,7 @@ auth sufficient pam_opendirectory.so
EOF
fake_bin="$HOME/fake-bin-disable"
create_fake_sudo "$fake_bin"
create_fake_utils "$fake_bin"
run env PATH="$fake_bin:$PATH" MOLE_PAM_SUDO_FILE="$pam_file" "$PROJECT_ROOT/bin/touchid.sh" disable
[ "$status" -eq 0 ]