8 KiB
8 KiB
jmove — TODO
Правила
- KISS — simplest solution that works; no speculative abstractions.
- DRY — no duplicated logic; extract into a function/module instead.
- SOLID — single responsibility per module (
cli/core/parser/cache), open for extension (new languages) via the parser trait, no deps on implementation details. - Max 250 lines per file — split when exceeded.
- Max 4 files per folder (module) — split the module when exceeded.
- Каждый коммит проходит
cargo fmt --checkиcargo clippy -- -D warnings. - Запрещён mёртвый код: unused code удаляется или реализуется;
#[allow(dead_code)]не использовать.
MVP (Phase 1)
- CLI skeleton (clap) — команды: mv, check, --dry-run, --json
- Сканер файлов проекта (уважать .gitignore через
ignoreкрейт) - Парсер импортов для TypeScript/JS через tree-sitter
- Разрешение путей: extension guessing (.ts/.tsx/.js/...), index.* (в MVP — без этого инструмент игрушка)
- Построение графа зависимостей (файл → что импортирует)
- Инвертированный граф (файл → кто его импортирует)
- Вычисление нового относительного пути после mv
- Rewrite импортов в файлах (трогаем только specifier-строку, никогда не реформатим statement)
- Атомарный apply (сначала rewrite, потом mv) + rollback при ошибке
- Dry-run режим с diff выводом
- Команда check (битые импорты, exit code 2) — self-test инструмента
- Тесты: unit (parser, core) + e2e (CLI на фикстурах)
AI / Agent support
- --json флаг на всех командах (status ok|dry_run|error)
- --dry-run + --json (preview без записи на диск)
- Стабильные error codes (TARGET_EXISTS, SOURCE_NOT_FOUND, ...) + hint поле
- Exit codes: 0 ok / 1 error / 2 broken imports
- docs/SKILL.md — машиночитаемая документация для AI агентов
- docs/EXAMPLES.md — примеры для людей и агентов
Phase 1.5 — Java (наша ниша, аналогов в CLI нет)
- tree-sitter Java грамматика: package + import extraction
- Детект source root (src/main/java, src/) и соответствие package ⇄ директория
- mv = три синхронных правки: package, все import в проекту, физический перенос
- e2e фикстуры tests/java/
Phase 1.6 — fix (auto-fix мелких ошибок; тот же safety-движок, что mv)
Мотивация: jmove уже умеет index → план правок → dry-run diff → atomic apply →
--json. Превращаем «mv» в обобщённый «найти правки → применить безопасно».
Слоган: mv + fix, один движок правок, два генератора планов.
Решение: паттерны (вариант 2) — ДА; ML (вариант 1) — НЕТ (детерминизм = продукт:
dry-run/rollback/error-codes не переживают недетерминированный движок).
AI оставляем СНАРУЖИ: при неоднозначности jmove отдаёт candidates в --json,
агент (LLM) выбирает и повторяет команду — в рамках нашего agent-first UX.
- Edit engine: расширить
rewrite_bytesс замены span доEdit{span,new}(пустой span = вставка; замена на "" + поглощение\n= удаление строки); apply/rollback/diff/json трогаются минимально (они уже generic над правками) Fixtrait рядом сLanguage:fixes(source, ctx) -> Vec<FixCandidate>{rule, severity, auto_fixable, edits};jmove fix [--rule ...] [--dry-run] [--json]- Java v1: unused-imports (skip wildcard/ambiguous), import-order (Checkstyle-подобные группы), missing-import (Type без импорта, ровно 1 кандидат в FQN-индексе → фикс; иначе candidates для агента), class-name-mismatch
- TS v1: unused-imports, import-order; add-import требует индекс экспортов (символ→файл)
- Форматирование: свой cargo-fmt НЕ строим (вечный long-tail). Только «import formatting»
(порядок/группировка — у нас уже есть spans). Опционально
--format-after <cmd>(prettier / google-java-format), не зависимость - Интероп PMD/Checkstyle/eslint (фаза 2.5):
jmove fix --report checkstyle.xmlмаппит violation(file,line,rule) на паттерны; на выход SARIF для CI/IDE. Маркетинг: «auto-fix for what Checkstyle only reports»
Guava real-world smoke test (google/guava @ main, JDK21, mvnw) — ПРОВЕРЕНО
- mv Primitives primitives→util: 5 правок (4 imports + package),
mvn -pl guava compile= BUILD SUCCESS,jmove checkчисто - mv VisibleForTesting annotations→annotations.testing (63 файла): jmove переписал все 62
явных импорта корректно, НО javac упал: сам перенесённый файл ссылался на соседний
GwtCompatibleБЕЗ импорта (тот же пакет) → после mv ссылка битая. jmove в v1 осознанно НЕ добавляет импорты. Это главный driver для fix/missing-import из Phase 1.6 выше - (после fix) повторить обе перемещения как
mv+ авто-fixи добить compile до SUCCESS - Индексация в monorepo с дублями пакетов (guava vs android/guava в одном --root):
FQN-коллизии → class_index оставляет первый по сортировке, импорт резолвится не туда.
Нужен выбор/фильтр source root (например
--source-rootили авто-определение по mv-цели)
Phase 2
- Кэш индекса на диске (bincode/rkyv) → .jmove/index
- Инкрементальная переиндексация (только изменённые файлы)
- Поддержка tsconfig paths / алиасов (@/...)
- Параллельная индексация через rayon
- --git интеграция (git mv для stage/истории)
- Перенос директорий целиком (mv папки)
- Предупреждения о не-import ссылках: package.json exports, jest mocks, tsconfig includes, markdown links
- prettier интеграция после rewrite (по желанию)
Phase 3
- Поддержка Python (from/import, относительные точки)
- Поддержка Go (per-file, НЕ whole-package как refac)
- Команда split (авто-разбивка файла на несколько)
- Windows-пути (camino/normalize) — CI matrix
Идеи на потом
- LSP интеграция (jmove сам как LSP server)
- Watch mode
- VS Code расширение как обёртка над CLI
Конкуренты (см. docs/PLAN.md)
- refac / ai_refac (jav-ed): TS/Py/Rust/Go/Dart, но без dry-run, лимит 30 файлов в TS, Go = весь пакет, Java нет. Наш edge: dry-run+атомарность, Java, split, скорость (без LSP), UX.