motrix-next (Agent Skills)

GitHub

A full-featured download manager โ€” rebuilt from the ground up

9,420 stars JavaScript 1 Rule Files Full Docs MCP View JSON API

AGENTS.md

# AGENTS.md โ€” Motrix Next

> This file provides context and instructions for AI coding agents.
> For human contributors, see [README.md](README.md) and [CONTRIBUTING.md](docs/CONTRIBUTING.md).

> [!IMPORTANT]
> **All changes must meet industrial-grade quality.** Enforce DRY (extract composables/utilities over duplication), strict TypeScript (no `any`, justify every `as` cast), structured error handling, and full verification (`vue-tsc` + tests pass) before completion.

---

## A. Project Architecture

| Layer               | Stack                                                              |
| ------------------- | ------------------------------------------------------------------ |
| **Frontend**        | Vue 3 Composition API + Pinia + Naive UI + TypeScript              |
| **Backend**         | Rust (Tauri 2) + aria2 sidecar                                     |
| **Build**           | Vite (frontend) + Cargo (backend)                                  |
| **Package Manager** | pnpm (version pinned via `packageManager` field in `package.json`) |
| **Testing**         | Vitest (frontend), cargo test (backend)                            |

### Key File Paths

```
src/
โ”œโ”€โ”€ api/                        # Aria2 JSON-RPC client (frontend wrapper)
โ”œโ”€โ”€ components/preference/      # Settings UI (Basic.vue, Advanced.vue, UpdateDialog.vue)
โ”œโ”€โ”€ composables/                # Vue composables โ€” business logic extracted from components
โ”œโ”€โ”€ layouts/                    # Page-level layouts (MainLayout.vue)
โ”œโ”€โ”€ shared/
โ”‚   โ”œโ”€โ”€ types.ts                # All TypeScript interfaces (AppConfig, TauriUpdate, etc.)
โ”‚   โ”œโ”€โ”€ constants.ts            # DEFAULT_APP_CONFIG, proxy scopes, tracker URLs, timing constants
โ”‚   โ”œโ”€โ”€ configKeys.ts           # needRestartKeys + re-exports of aria2Options.json lists
โ”‚   โ”œโ”€โ”€ aria2Options.json       # SINGLE SOURCE for engine option lists (TS + Rust both consume)
โ”‚   โ”œโ”€โ”€ logger.ts               # Structured logging (console + webview bridge)
โ”‚   โ”œโ”€โ”€ timing.ts               # Timing constants (polling intervals, debounce delays)
โ”‚   โ”œโ”€โ”€ guards.ts               # Type guard utilities
โ”‚   โ”œโ”€โ”€ locales/                # 27 locale directories (see Section D)
โ”‚   โ””โ”€โ”€ utils/
โ”‚       โ”œโ”€โ”€ configHydration.ts  # Config defaults, migration, nested merge, and repair boundary
โ”‚       โ”œโ”€โ”€ configMigration.ts  # Config schema migration engine (see Section Cโ€ฒ)
โ”‚       โ”œโ”€โ”€ config.ts           # Config key-value transform utilities
โ”‚       โ”œโ”€โ”€ tracker.ts          # BT tracker fetching with proxy support
โ”‚       โ”œโ”€โ”€ geoip.ts            # GeoIP peer lookup (country code โ†’ flag)
โ”‚       โ”œโ”€โ”€ fileCategory.ts     # File type classification by extension
โ”‚       โ”œโ”€โ”€ autoArchive.ts      # Auto-archive completed tasks
โ”‚       โ”œโ”€โ”€ format.ts           # Number/date/speed formatting (bytesToSize, localeDateTimeFormat)
โ”‚       โ”œโ”€โ”€ task.ts             # Task status helpers (checkTaskIsBT, getTaskDisplayName)
โ”‚       โ”œโ”€โ”€ peer.ts             # Peer ID parsing and client identification
โ”‚       โ””โ”€โ”€ proxy.ts            # Proxy policy, URL building/validation, engine option assembly
โ”œโ”€โ”€ stores/                     # Pinia stores (app.ts, preference.ts, history.ts, task/)
โ”œโ”€โ”€ views/                      # Page-level route views
โ””โ”€โ”€ main.ts                     # App entry, auto-update check

src-tauri/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ lib.rs                  # Tauri builder, plugin registration, invoke_handler
โ”‚   โ”œโ”€โ”€ main.rs                 # Tauri entry point
โ”‚   โ”œโ”€โ”€ aria2/                  # Native Rust aria2 JSON-RPC client
โ”‚   โ”‚   โ”œโ”€โ”€ mod.rs              # Module re-exports
โ”‚   โ”‚   โ”œโ”€โ”€ client.rs           # WebSocket JSON-RPC client (connect, call, subscribe)
โ”‚   โ”‚   โ””โ”€โ”€ types.rs            # Aria2 response types (Aria2Task, Aria2File, Aria2BtInfo, etc.)
โ”‚   โ”œโ”€โ”€ commands/
โ”‚   โ”‚   โ”œโ”€โ”€ mod.rs              # Command module re-exports
โ”‚   โ”‚   โ”œโ”€โ”€ aria2.rs            # aria2 JSON-RPC forwarding (tell_active, global_stat, etc.)
โ”‚   โ”‚   โ”œโ”€โ”€ config.rs           # Config CRUD, session, factory reset commands
โ”‚   โ”‚   โ”œโ”€โ”€ engine.rs           # Engine start/stop/restart commands
โ”‚   โ”‚   โ”œโ”€โ”€ fs.rs               # File system ops, diagnostics, platform code
โ”‚   โ”‚   โ”œโ”€โ”€ geoip.rs            # GeoIP database loading and peer IP lookup
โ”‚   โ”‚   โ”œโ”€โ”€ history.rs          # History DB read/write commands
โ”‚   โ”‚   โ”œโ”€โ”€ http_api.rs         # Local extension HTTP API auth and status commands
โ”‚   โ”‚   โ”œโ”€โ”€ net.rs              # Network utility commands
โ”‚   โ”‚   โ”œโ”€โ”€ notification.rs     # Native notification permission and test commands
โ”‚   โ”‚   โ”œโ”€โ”€ power.rs            # System power action commands
โ”‚   โ”‚   โ”œโ”€โ”€ protocol.rs         # Default protocol handler detection and registration
โ”‚   โ”‚   โ”œโ”€โ”€ proxy.rs            # System proxy detection (PAC, WPAD, env)
โ”‚   โ”‚   โ”œโ”€โ”€ runtime_config.rs   # RuntimeConfig refresh command
โ”‚   โ”‚   โ”œโ”€โ”€ tracker.rs          # Tracker probing and protocol classification
โ”‚   โ”‚   โ”œโ”€โ”€ ui.rs               # Tray, menu, dock, progress bar commands
โ”‚   โ”‚   โ”œโ”€โ”€ updater.rs          # check_for_update, download_update, apply_update, cancel_update
โ”‚   โ”‚   โ””โ”€โ”€ upnp.rs             # UPnP port mapping commands
โ”‚   โ”œโ”€โ”€ engine/
โ”‚   โ”‚   โ”œโ”€โ”€ mod.rs              # Module re-exports
โ”‚   โ”‚   โ”œโ”€โ”€ lifecycle.rs        # aria2 sidecar start/stop/restart
โ”‚   โ”‚   โ”œโ”€โ”€ args.rs             # aria2 command-line argument builder
โ”‚   โ”‚   โ”œโ”€โ”€ cleanup.rs          # Engine cleanup utilities
โ”‚   โ”‚   โ””โ”€โ”€ state.rs            # Engine state management
โ”‚   โ”œโ”€โ”€ services/
โ”‚   โ”‚   โ”œโ”€โ”€ mod.rs              # Runtime services orchestration (on_engine_ready)
โ”‚   โ”‚   โ”œโ”€โ”€ config.rs           # RuntimeConfig cache (refreshed per engine cycle)
โ”‚   โ”‚   โ”œโ”€โ”€ deep_link.rs        # Deep-link and startup URL dispatch service
โ”‚   โ”‚   โ”œโ”€โ”€ external_input.rs   # External extension/API input queue service
โ”‚   โ”‚   โ”œโ”€โ”€ frontend_action.rs  # Frontend action event bridge
โ”‚   โ”‚   โ”œโ”€โ”€ http_api.rs         # Local HTTP API server for browser extensions
โ”‚   โ”‚   โ”œโ”€โ”€ monitor.rs          # Task lifecycle monitor, history DB persistence, event emission
โ”‚   โ”‚   โ”œโ”€โ”€ notification.rs     # Native notification dispatch service
โ”‚   โ”‚   โ”œโ”€โ”€ notification_i18n.rs # Localised notification strings
โ”‚   โ”‚   โ”œโ”€โ”€ port_guard.rs       # Runtime port conflict detection and recovery
โ”‚   โ”‚   โ”œโ”€โ”€ power.rs            # Sleep prevention and power guard service
โ”‚   โ”‚   โ”œโ”€โ”€ stat.rs             # Global stat polling, Dock badge, Dock progress bar (custom NSProgressIndicator)
โ”‚   โ”‚   โ””โ”€โ”€ speed.rs            # Speed limit scheduler (time-of-day limits)
โ”‚   โ”œโ”€โ”€ db_guard.rs             # Database health check, corruption detection, and auto-rebuild
โ”‚   โ”œโ”€โ”€ gpu_guard.rs            # GPU compatibility detection and WebView renderer fallback
โ”‚   โ”œโ”€โ”€ history.rs              # HistoryDbState: Rust-side SQLite history record persistence
โ”‚   โ”œโ”€โ”€ error.rs                # AppError enum (Store, Engine, Io, NotFound, Updater, Upnp)
โ”‚   โ”œโ”€โ”€ menu.rs                 # Native menu builder (macOS only, cfg-gated)
โ”‚   โ”œโ”€โ”€ tray.rs                 # System tray setup + native event handling (lightweight mode safe)
โ”‚   โ””โ”€โ”€ upnp.rs                 # UPnP/IGD port mapping with renewal loop
โ”œโ”€โ”€ migrations/
โ”‚   โ”œโ”€โ”€ 001_download_history.sql  # Initial history table schema
โ”‚   โ”œโ”€โ”€ 002_add_added_at.sql      # Added added_at column + task_birth table
โ”‚   โ””โ”€โ”€ 003_http_auth_credentials.sql # HTTP extension API auth credentials
โ”œโ”€โ”€ nsis/
โ”‚   โ”œโ”€โ”€ hooks.nsh              # Windows installer hooks (compat shim + icon refresh)
โ”‚   โ”œโ”€โ”€ header.bmp             # Installer header image (150ร—57, 24-bit BMP)
โ”‚   โ””โ”€โ”€ sidebar.bmp            # Installer sidebar image (164ร—314, 24-bit BMP)
โ”œโ”€โ”€ Cargo.toml                  # VERSION SOURCE OF TRUTH
โ””โ”€โ”€ tauri.conf.json             # Tauri config (no version field โ€” reads from Cargo.toml)

.github/
โ”œโ”€โ”€ ISSUE_TEMPLATE/             # Bug report (YAML form) + feature request templates
โ”œโ”€โ”€ PULL_REQUEST_TEMPLATE.md    # PR template with TypeScript + Rust checklist
โ””โ”€โ”€ workflows/
    โ”œโ”€โ”€ ci.yml                  # Lint + type check + test (frontend & backend parallel jobs)
    โ””โ”€โ”€ release.yml             # Build + sign + upload for 6 platforms + updater JSON
```

---

## B. Version Management

**`src-tauri/Cargo.toml` is the single source of truth.** The `version` field in `package.json` must stay in sync.

### How to Bump

Always use the provided script:

```bash
./scripts/bump-version.sh 1.4.0
```

This atomically updates both `Cargo.toml` and `package.json`.

### Why Two Files?

- `Cargo.toml` โ€” Tauri reads this at build time; the About panel reads it via `getVersion()` at runtime.
- `package.json` โ€” pnpm/action-setup and npm tooling reference this; CI workflows use the `packageManager` field.
- `tauri.conf.json` โ€” intentionally omits `version` so Tauri falls back to `Cargo.toml`.

> **Never manually edit version strings.** Always use `bump-version.sh`.

---

## C. Adding a New Config Key

Follow this exact checklist:

1. **`src/shared/types.ts`** โ€” Add the field to the `AppConfig` interface with proper typing
2. **`src/shared/aria2Options.json`** โ€” ONLY if the key maps to an aria2 engine option: add it to `engineOptions` (and to `nonHotReloadable` if aria2 cannot change it at runtime). Both the frontend and the Rust backend read this file. App-only preference keys need no list entry โ€” the whole config object is persisted as-is
3. **`src/shared/constants.ts`** โ€” Add the default value to `DEFAULT_APP_CONFIG`
4. **`src/shared/utils/configHydration.ts`** โ€” Check whether the key needs validation, repair, or selective nested merge. Top-level keys usually need no code here; nested object keys and enum-like values usually do.
5. **UI binding** โ€” Add the field to the relevant preference composable and component save flow
6. **All 27 locale files** โ€” Add i18n label keys. **Must use batch Python script** (see Section D)
7. **Migration decision** โ€” Add a `configMigration.ts` migration only when changing stored shape, semantics, or existing user values. Do not add a migration just to materialize a new default; hydration handles that.

---

## Cโ€ฒ. Config Hydration & Schema Migration

`src/shared/utils/configHydration.ts` is the single frontend entry point for turning persisted `config.json` preferences into a complete runtime `AppConfig`. It clones `DEFAULT_APP_CONFIG`, runs `configMigration.ts`, selectively hydrates known nested objects, repairs invalid enum/port values, preserves secret-generation semantics, and tells the store whether repaired data should be persisted.

`src/shared/utils/configMigration.ts` implements versioned schema migration. It is called from `hydrateAppConfig()`, not directly from the preference store.

### How It Works

- `configVersion` (integer) is stored in `config.json` alongside user preferences
- `hydrateAppConfig(saved)` runs on `loadPreference()`, `reloadPreferenceFromDisk()`, `savePreference()`, `updateAndSave()`, and in-memory `updatePreference()`
- `CONFIG_VERSION` constant defines the current schema version
- `migrations[]` array holds ordered migration functions (index 0 = v0โ†’v1, etc.)
- Migrations run only when `stored version < CONFIG_VERSION`
- Hydration handles missing defaults and safe repairs without bumping `CONFIG_VERSION`
- The store persists only when migration or repair changed the loaded config

### Adding a New Migration

1. Append a function to the `migrations` array in `configMigration.ts`
2. Increment `CONFIG_VERSION` to match the new array length
3. Update `DEFAULT_APP_CONFIG.configVersion` in `constants.ts` to match
4. Add tests in `configMigration.test.ts`

### Rules

- `hydrateAppConfig()` owns default materialization, selective nested merge, enum validation, port validation, and secret preservation
- Arrays are user-owned by default. Do not deep-merge arrays such as `trackerSource`, `customTrackerUrls`, `historyDirectories`, `favoriteDirectories`, or `fileCategories`
- `rpcSecret` and `extensionApiSecret` must preserve the existing meaning: `undefined`/`null` means generate later; empty string means intentionally cleared
- Migrations **mutate** the config object in place
- Migrations **must be idempotent** โ€” safe to re-run on already-migrated data
- Migrations **must not delete** user data without logging

---

## Cโ€ณ. Database Schema Migration

`tauri_plugin_sql` manages versioned SQL migrations for `sqlite:history.db`. Migrations run automatically on app launch when the stored version is behind the latest.

> **This is separate from Config Schema Migration (Section Cโ€ฒ).** Config migrations handle `config.json` (JSON key-value preferences) in the frontend. DB migrations handle `history.db` (SQLite relational tables) in the backend. They manage different data stores in different runtimes โ€” merging them is not practical.

### How It Works

- SQL migration files live in `src-tauri/migrations/` with `NNN_description.sql` naming
- Each migration is registered as a `tauri_plugin_sql::Migration` struct in the `.add_migrations()` call in `lib.rs`
- The plugin tracks executed versions in an internal `_sqlx_migrations` table
- Old users receive new migrations transparently on upgrade โ€” no manual action needed

### Adding a New Migration

1. Create `src-tauri/migrations/NNN_description.sql` with the SQL statements
2. Append a `Migration` struct to the `vec![]` in `lib.rs`:
   ```rust
   tauri_plugin_sql::Migration {
       version: N,
       description: "short description",
       sql: include_str!("../migrations/NNN_description.sql"),
       kind: tauri_plugin_sql::MigrationKind::Up,
   },
   ```
3. Update `REGISTERED_VERSIONS` in `src-tauri/src/db_guard.rs`
4. Update `CURRENT_DB_SCHEMA_VERSION` in `src/shared/constants.ts`
5. If the migration adds/renames columns used by the frontend, update `HistoryRecord` in `src/shared/types.ts`
6. Update relevant SQL queries in `src/stores/history.ts`
7. Add a regression test that fresh installs persist the current DB schema version and do not show a false DB upgrade toast on second launch
8. Run `cargo check` to verify the Rust compiles

### Rules

- Migrations **must be additive** โ€” never DROP columns that old code may still reference
- Use `ALTER TABLE ... ADD COLUMN` with defaults for backward compatibility
- Use `COALESCE` in queries to handle NULL values from old rows gracefully
- Test with both a fresh DB AND an existing DB to verify both paths work
- Never leave `DEFAULT_APP_CONFIG.dbSchemaVersion` behind the latest registered migration; first saved config on a fresh install must be stamped with the current DB schema version

### Toast Differentiation

Both migration systems show upgrade toasts on the UI, but with distinct messages:

| System      | i18n Key                | Example (en-US)                       | Toast Type        |
| ----------- | ----------------------- | ------------------------------------- | ----------------- |
| Config (Cโ€ฒ) | `app.migration-success` | "User settings schema upgraded to v2" | `success` (green) |
| DB (Cโ€ณ)     | `app.db-upgraded`       | "Database schema upgraded to v2"      | `info` (blue)     |

### Windows Installer Hooks (not a migration system)

`src-tauri/nsis/hooks.nsh` contains one-off compatibility shims for the `currentUser` โ†’ `both` install mode transition (v3.6.1 โ†’ v3.6.2). These are NSIS-level registry fixups that run during installation, not at app launch. They are **not** a versioned migration system โ€” once all users have upgraded past v3.6.2, the shims become safe no-ops.

The hooks file defines three injection points:

| Hook                           | Timing                                     | Purpose                                                                                                                                                    |
| ------------------------------ | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `MUI_CUSTOMFUNCTION_GUIINIT`   | Before any installer pages                 | Bridges old `MANUPRODUCTKEY` registry path (`Software\motrix\โ€ฆ`) to new (`Software\AnInsomniacy\โ€ฆ`) so `PageLeaveReinstall` can locate the old uninstaller |
| `!macro NSIS_HOOK_PREINSTALL`  | Inside `Section Install`, before file copy | Redirects `$INSTDIR`/`$OUTDIR` to old install location, deletes stale HKCU uninstall entry, cleans orphaned registry keys and Program Files residuals      |
| `!macro NSIS_HOOK_POSTINSTALL` | After file copy                            | Refreshes Windows icon cache via `ie4uinit.exe`                                                                                                            |

> [!CAUTION]
> **Do NOT change `bundle.publisher`, `bundle.identifier`, or `productName` after the first public release.** These values derive the NSIS `MANUFACTURER` variable and `MANUPRODUCTKEY` registry path (`Software\{MANUFACTURER}\{PRODUCTNAME}`). Changing them breaks the Windows upgrade path for all existing users and requires a new NSIS compatibility shim in `hooks.nsh`. The v3.6.2 transition required four separate fixups (issue #159) โ€” avoid repeating this.

---

## D. i18n / Locale Operations

### Rules

1. **NEVER edit locale files manually one by one.** Always use a Python batch script.
2. Strings containing `'` must be escaped as `\'` in JS source files.
3. English (`en-US`) keys serve as the fallback โ€” always verify this locale first.

### 27 Locale Directories

```
ar bg ca de el en-US es fa fr hi hu id it ja ko nb nl pl pt-BR ro ru th tr uk vi zh-CN zh-TW
```

### Script Template

```python
#!/usr/bin/env python3
"""Batch-update locale files with native translations."""
import os, re

LOCALES_DIR = "src/shared/locales"

TRANSLATIONS = {
    "ar":    ("Arabic text",),
    "bg":    ("Bulgarian text",),
    # ... all 27 locales with native translations ...
    "en-US": ("English text",),
    "zh-CN": ("Chinese Simplified text",),
    "zh-TW": ("Chinese Traditional text",),
}

def update_locale(locale_dir, values):
    filepath = os.path.join(LOCALES_DIR, locale_dir, "preferences.js")
    with open(filepath, "r", encoding="utf-8") as f:
        content = f.read()
    # Use regex or string replacement to insert/update keys
    # Escape single quotes in values: value.replace("'", "\\'")
    # Write back
    with open(filepath, "w", encoding="utf-8") as f:
        f.write(content)

for locale, vals in sorted(TRANSLATIONS.items()):
    update_locale(locale, vals)
```

> **Critical:** After running, verify with `npx vite build` โ€” locale parse errors will surface here.

---

## E. Release & Update Channels

### Trigger

The release workflow (`.github/workflows/release.yml`) is triggered by `on: release: types: [published]`.

### Tag Naming

| Channel | Tag Pattern     | JSON Generated | Example         |
| ------- | --------------- | -------------- | --------------- |
| Stable  | `v1.4.0`        | `latest.json`  | `v1.3.1`        |
| Beta    | `v1.4.0-beta.N` | `beta.json`    | `v1.4.0-beta.1` |
| RC      | `v1.4.0-rc.N`   | `beta.json`    | `v1.4.0-rc.1`   |

### Updater JSON Hosting

Both `latest.json` and `beta.json` are uploaded to a **permanent `updater` Release tag**:

```
https://github.com/AnInsomniacy/motrix-next/releases/download/updater/latest.json
https://github.com/AnInsomniacy/motrix-next/releases/download/updater/beta.json
```

The CI creates this Release automatically if it doesn't exist, and uses `--clobber` to overwrite on each release.

### Runtime Channel Switching

The Tauri JS `check()` API does **not** support runtime endpoint override. Channel switching is implemented via Rust commands:

- `check_for_update(channel, proxy)` โ†’ dynamically builds updater with correct endpoint
- `download_update(channel, proxy)` โ†’ downloads update binary, emits progress events
- `apply_update(channel)` โ†’ stops engine, installs downloaded update
- `cancel_update()` โ†’ cancels in-progress download

The user's channel preference is stored as `updateChannel` in the preference store.

### How to Publish a Release

All code changes must be finalized before starting. Execute these three steps in strict order:

1. **Bump the version:**

   ```bash
   # Stable
   ./scripts/bump-version.sh 1.4.0
   # Beta
   ./scripts/bump-version.sh 1.4.0-beta.1
   ```

   **Do not modify code after this step.** This updates `Cargo.toml` + `package.json`.

2. **Release:**

   ```bash
   ./scripts/release.sh
   ```

   This formats code, commits all changes, creates an annotated tag `v{VERSION}`, and pushes to origin.
   The script outputs a color-coded channel indicator (yellow = pre-release, green = stable).

3. **Publish the GitHub Release:**

   Generate an English release title and release notes from the commits included in this release, following the Release Notes Conventions below.

   Use the exact version and channel specified by the user, and enforce the Tag Naming rules above when bumping and publishing. Do not infer or invent the next version. If the version or channel is missing or ambiguous, ask before bumping or publishing. Before creating the GitHub Release, show the user the exact version, whether it will be marked as a pre-release, the generated release title, and the generated release notes. If the GitHub CLI is available and authenticated, publish the release directly with `gh release create` after showing those details. Mark user-specified beta, alpha, or RC releases as pre-releases. This is preferred because the release workflow only starts after the GitHub Release is published.

   If `gh` is unavailable, unauthenticated, or the user explicitly wants to publish manually, output the title and body in **two separate markdown code blocks** so the user can paste them into the GitHub Release page.

### Updater Principles

- **Channel detection** โ€” CI checks the tag name: tags containing `-beta`, `-alpha`, or `-rc` โ†’ `beta.json`; everything else โ†’ `latest.json`
- **Single fixed host** โ€” Both JSON files live in a permanent `updater` Release tag (auto-created by CI on first publish). Each publish overwrites the previous JSON via `--clobber`
- **Tag = immutable pointer** โ€” A git tag points to a fixed commit. If a build fails, you must delete both the tag and the Release, then re-publish to pick up the fixed code
- **CI trigger** โ€” Only `on: release: [published]` triggers builds. Pushing a tag alone does **not** trigger the workflow

### Recovering from a Failed Release

```bash
# 1. Fix the code, commit and push
git add -A && git commit -m "fix: resolve build issue" && git push

# 2. Delete the remote tag
git push origin --delete v2.1.1

# 3. Delete the local tag
git tag -d v2.1.1

# 4. Delete the failed Release on GitHub (Releases โ†’ click โ†’ Delete this release)
# 5. Re-run bump-version.sh with the same version to re-create the tag
./scripts/bump-version.sh 2.1.1
git push && git push --tags
# 6. Re-create the Release in the GitHub UI selecting the tag
```

### Release Notes Conventions

**Title format:** `v{VERSION} โ€” {Short Description}`

Examples: `v2.0.0 โ€” Stability & Quality Release`, `v2.0.1 โ€” Bug Fixes`, `v2.1.0 โ€” Proxy Support`

**Body template:**

```markdown
> [!CAUTION]
> **Breaking change notice** (only if applicable)

## What's Changed

One-paragraph summary of the release scope and significance.

### โœจ New Features

- **Feature name** โ€” short description
- **Feature name** โ€” short description

### ๐Ÿ›  Improvements

- Description of improvement
- Description of improvement

### ๐Ÿ› Bug Fixes

- Fixed specific issue

### ๐Ÿ“ฆ Downloads

| Platform | Architecture          | File               |
| -------- | --------------------- | ------------------ |
| macOS    | Apple Silicon ยท Intel | `.dmg`             |
| Windows  | x64 ยท ARM64           | `-setup.exe`       |
| Linux    | x64 ยท ARM64           | `.AppImage` `.deb` |
```

**Guidelines:**

- Use `> [!CAUTION]` GitHub Alert only for breaking changes or manual action required
- Omit empty sections โ€” e.g. no Bug Fixes section if there are none
- Patch releases: keep concise, only list what changed
- Major releases: include a summary paragraph explaining the scope

---

## F. CI/CD Structure

### `ci.yml` (Pull Requests + Push to Main)

Two parallel jobs:

| Job        | Steps                                                                                                                        |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `frontend` | `pnpm install` โ†’ `pnpm lint` โ†’ `pnpm format:check` โ†’ `vue-tsc --noEmit` โ†’ `vitest run` โ†’ `vite build`                        |
| `backend`  | `cargo fmt --check` โ†’ `cargo clippy --all-targets -- -D warnings` โ†’ `cargo check --all-targets` โ†’ `cargo test --all-targets` |

### `release.yml` (Release Published)

1. **Build job** โ€” Matrix: `macos-latest` (aarch64), `macos-15-intel` (x86_64), `windows-latest` (ร—2: x64 + aarch64 cross-compile), `ubuntu-22.04` (GLIBC 2.35 compat), `ubuntu-24.04-arm`
2. **merge-updater-json job** โ€” Detects channel from tag name โ†’ generates `latest.json` or `beta.json` with 6 platform keys โ†’ uploads to `updater` tag

---

## G. Code Conventions

### TypeScript / Vue

- **Strict mode** enabled in `tsconfig.json`
- **`<script setup lang="ts">`** for all components
- **Path aliases**: `@/` โ†’ `src/`, `@shared/` โ†’ `src/shared/`
- **Imports**: named imports from `naive-ui`, destructured Tauri APIs
- **State management**: Pinia stores with Composition API style (`setup` function)
- **Formatting**: Prettier with project config (`.prettierrc`)

### Rust

- **Error handling**: All commands return `Result<T, AppError>`, never raw `String` errors
- **`AppError` enum** in `error.rs` with variants: `Store`, `Engine`, `Io`, `NotFound`, `Updater`, `Upnp`
- **Async commands**: Use `#[tauri::command]` with `async` for I/O operations
- **Plugin usage**: Tauri plugin traits (e.g., `UpdaterExt`, `StoreExt`) imported in command modules

### CSS

- **Custom properties** for all design tokens (colors, timing, easing)
- **No utility frameworks** โ€” vanilla CSS with component-scoped styles
- **Motion**: Material Design 3 asymmetric timing and emphasized easing curves

### Color System

Motrix Next uses a dynamic Material Design 3 color system generated by `@material/material-color-utilities`. `src/shared/utils/colorScheme.ts` is the single source of truth: a preset or custom seed produces the complete light and dark palettes. Primary and tertiary provide theme accents; info, success, warning, and error are harmonized semantic colors. Each role includes color, matching foreground, container, container foreground, hover, and pressed values. Neutral surfaces use the ordered `surface` and `surface-container-*` roles, while text and borders use `on-surface*` and `outline*`.

`src/composables/useColorScheme.ts` is the only bridge to consumers. It maps the generated tokens to CSS variables, Naive UI overrides, and reactive Canvas consumers. Task status colors are aliases of the same roles: active uses primary, waiting uses info, paused uses outline, error uses error, and complete or sharing uses success. `src/styles/tokens.css` contains first-paint fallbacks only; runtime values replace them after startup. Components must consume semantic tokens instead of fixed colors. Fixed colors are limited to platform-defined controls, brand artwork, and color-picker swatches.

---

## H. Verification Commands

Run these before committing changes:

```bash
# Frontend
pnpm format                # Auto-format all source files with Prettier
pnpm lint                  # ESLint check
pnpm format:check          # Verify formatting (CI runs this)
pnpm test                  # Vitest unit tests
pnpm check:repo            # Locale parity + i18n literal-key usage (CI runs this)
npx vue-tsc --noEmit       # TypeScript type checking

# Backend
cargo check --all-targets  # Fast compilation check
cargo test --all-targets   # Rust unit tests

# Version (when bumping)
./scripts/bump-version.sh <version>
```

> **Every commit MUST pass `pnpm format:check`.** If you edit any `.ts`, `.vue`, `.css`, or `.json` file, run `pnpm format` before committing. The husky pre-commit hook runs lint-staged automatically, but it only formats staged files โ€” so always verify with `pnpm format:check` if unsure.

> **Note:** `npx vite build` is slow and should only be run when validating production output or debugging locale/bundling issues โ€” not on every change.

All fast checks must pass with zero errors before any PR or release.

---

## I. Testing Constraints

> **DO NOT use browser tools (Playwright, browser subagent, etc.) to test this app.** Tauri renders in a native webview โ€” `localhost:1420` in a browser lacks IPC, tray, and sidecar access. Use CLI checks (`vue-tsc`, `pnpm test`, `cargo test --all-targets`) or ask the user to verify UI via `pnpm tauri dev`.