Skip to content

AGENTS.md

Latest commit

 

History

History
54 lines (47 loc) · 3.06 KB

AGENTS.md

File metadata and controls

54 lines (47 loc) · 3.06 KB
Raw

Data Tools Agent Guide

Scope: src/apps/data-tools. This is a separately versioned, offline local tool. Read README.md for its user-facing contract.

Boundaries

  • Launch with no arguments. Own directory selection, discovery, durable task recovery and completion; never depend on a Desktop request or restart Desktop.

  • Keep preferences under the tool's Tauri app-config identity. Migration run journals/backups remain under the destination data directory for recovery. Do not write Desktop onboarding/reminder state.

  • Consume config-contracts, shared storage services and legacy-migration-adapters. Do not depend on Core, product assembly, Agent execution, Web UI, updater, plugin lifecycle or a main-application sibling executable.

  • Use typed Rust commands for filesystem/process operations. Cancellation is advisory and is honored only at engine-declared safe boundaries.

  • Reject unsupported data formats and unsafe directory overlaps. Preserve source data, old plans/reports, snapshots, journals, backups and owner conflict policies.

  • The UI uses public @openbitfun/design-tokens and @openbitfun/theme-openbitfun exports bundled in ui/generated/design-system.css. Regenerate through pnpm run data-tools:theme:generate. Direct Cargo builds are offline; Desktop dev/build must never generate or build Data Tools assets.

  • ui/theme.js selects system scheme/contrast before paint. Workflow translations are app-owned; do not import Web UI catalogs. No mocks or browser automation for visual verification.

  • Tool version lives in Cargo.toml and tauri.conf.json. Packaging/signing uses the independent Data Tools workflow and data-tools-v tags (legacy tags remain supported).

  • Session repair is parallel to import, not an import domain. It must work without a legacy source. Reuse services-core/session-recovery with native commands; never require Python in the shipped GUI. Keep repair tasks/backups under the tool app-config identity outside product data and preserve the existing migration task paths. Tool preferences use the data-tools identity without importing the old tool's configuration. Accept the old release tag prefix while commands, executables and release assets use data-tools.

  • Migration, reset and repair share one operation guard and cancellation/close lifecycle. Exercise mutations only on fixtures or explicitly supplied copies.

Focused verification

cargo test -p openbitfun-data-tools -p openbitfun-legacy-migration-adapters -p openbitfun-legacy-migration --lib
cargo test -p openbitfun-services-core --no-default-features --features session-recovery --lib session_recovery
cargo test -p openbitfun-legacy-migration --test migration_engine_contracts
node --test scripts/data-tools-tauri-build.test.mjs
node --check src/apps/data-tools/ui/app.js
node --test scripts/data-tools-report.test.mjs
pnpm run theme:color-audit:all

Run pnpm run check:core-boundaries for dependency ownership changes and pnpm run check:github-config for release workflow changes. Platform packaging and native visual checks are separate from these contract checks.