DeepWorkPlan Vim

DeepWorkPlan Vim — термінальний редактор для Deep Work Plan: конфігурація Neovim для людей і для програмувальних агентів, які працюють у терміналі. Ваші плани, документація та індекс усіх команд — на відстані одного натискання клавіші.

Це окремий продукт, який пропонується як необовʼязковий аддон vim Deep Work Plan v7 (v7.0.0). Deep Work Plan працює з будь-яким редактором або без нього, а редактор не вимагає Deep Work Plan: ви додаєте його на машину окремо, і він працює як редактор незалежно від того, чи є план. Ця сторінка описує реліз v0.5.0.

Навіщо термінальний редактор для Deep Work Plan

Deep Work Plan — це тека з Markdown у .dwp/plans/: мета, атомарні завдання, validation gates та журнал, що постійно ведеться. Люди переглядають його, агенти виконують, і ті й інші часто роблять це з терміналу. Редактор, створений для такої роботи, тримає поруч три речі: сам план, документацію навколо нього та клавіші, що переміщують вас між ними.

DeepWorkPlan Vim — саме такий редактор. Це дбайливо підготовлена конфігурація Neovim — мовні сервери, автодоповнення, лінтинг, форматування, нечіткий пошук, дерево файлів і дібрані кольорові теми з відкладеним завантаженням — плюс кілька інтерфейсів, що роблять її редактором для Deep Work Plan.

Огляд: індекс команд, який не може застаріти

Натисніть SPC h h (Пробіл — це лідер-клавіша) або виконайте :DwpCommands, і редактор виведе кожну свою привʼязку з однорядковим описом. Список створюється з актуальних розкладок клавіш, тож привʼязка, визначена будь-де, зʼявляється в індексі без реєстрації, а сам індекс не може застаріти.

Ось і весь огляд: запустіть nvim, потім натисніть Пробіл, h, h.

Що ви отримуєте

Пʼять можливостей, кожна — на відстані одного натискання клавіші.

Плани, не виходячи з редактора

SPC P, :DwpPlans або клацання по сегменту рядка стану відкриває бічну панель планів. Вона охоплює кожну теку .dwp/plans/ у поточному каталозі та в каталозі конфігурації Neovim і групує плани, починаючи з тих, що потребують найбільше уваги. У редакторі мітки такі: Working, Needs attention, Ready, Not started і Done. Для кожного плану показано індикатор прогресу.

Натисніть Enter на плані, щоб відкрити режим читання: мету одним реченням, стан і прогрес, список завдань із позначеним поточним завданням і зрозумілі переходи до файлів самого плану. Рядок стану показує поточний активний план, а стартовий екран перелічує перші три. Ці інтерфейси пояснюють плани й ніколи нічого не записують у .dwp/.

Щоб читати Markdown-файли плану на місці, SPC m p показує поточний буфер у браузері, а SPC m r відтворює його всередині буфера. Обидва працюють лише в буферах Markdown.

Встановлення

Встановлення — це три команди: завантажте скрипт, звірте його з SHA-256 файлу, який роздає цей сайт, а потім запустіть. Інсталятор фіксує власний реліз, тож встановлює саме v0.5.0 — реліз, який описує ця сторінка, якщо ви не оберете іншу версію.

curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
echo "4890c140528d6b8d19b6bbc4102051e0b9dce2e26f43a693bdeab2e1cd8e196b  install.sh" | shasum -a 256 -c && \
bash install.sh

По порядку інсталятор:

1. Перевіряє вашу ОС і менеджер пакетів та встановлює git, curl і інтерпретатор Lua, якщо чогось бракує (з --skip-packages — нічого).
2. Визначає версію: власний реліз або той, який запитано через --version.
3. З --nvim X.Y.Z встановлює цей реліз Neovim у ~/.local/opt і перевіряє його за SHA-256, який публікує Neovim.
4. Питає, перш ніж торкатися наявної конфігурації Neovim. Без терміналу зупиняється й нічого не змінює, якщо тільки --yes не вказує йому відсунути цю конфігурацію вбік.
5. Клонує репозиторій у ~/.config/nvim або оновлює його, якщо він уже там.
6. Запускає власний lua install.lua репозиторію.
7. Встановлює плагіни у фоновому режимі й перевіряє їх, тож виходити й відкривати заново не потрібно. З --strict невдале чи неповне встановлення плагінів є помилкою.

Скрипт, що роздається тут, є побайтово ідентичною копією install.sh на тезі v0.5.0. Його контрольна сума роздається поруч, за адресою https://deepworkplan.com/vim/install.sh.sha256, тож завантаження можна перевірити командою shasum -a 256 -c install.sh.sha256 (у Linux — sha256sum -c install.sh.sha256). Для перевірки з другого джерела порівняйте її з рядком install.sh у SHA256SUMS релізу на GitHub. Виконайте bash install.sh --help, щоб побачити всі параметри.

Вибір версії

За замовчуванням інсталятор встановлює власний реліз, v0.5.0. Щоб обрати інший, задайте DWP_VIM_VERSION або передайте --version: обидва способи роблять одне й те саме, тож використовуйте той, що краще читається; прапорець має пріоритет над змінною середовища. Кожен приймає:

Після завантаження та перевірки контрольної суми, описаних вище:

# exact version
DWP_VIM_VERSION=0.5.0 bash install.sh
bash install.sh --version 0.5.0

# minimum floor: the newest stable release at or above 0.4.2
DWP_VIM_VERSION='>=0.4.2' bash install.sh

# latest stable release
bash install.sh --version latest

Беріть межу в лапки, щоб оболонка не прочитала > як перенаправлення. Версії розвʼязуються лише в теги стабільних релізів. Для гілки чи коміту задайте натомість DWP_VIM_REF (DWP_VIM_REF=main відстежує main); якщо версія і ref суперечать одна одному, це помилка.

Контейнери та CI

В образі чи завданні CI, де немає терміналу й часто немає root, завантажте та перевірте скрипт, а потім запустіть його за один крок із прапорцями, які роблять результат відтворюваним:

curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
curl -fsSL -o install.sh.sha256 https://deepworkplan.com/vim/install.sh.sha256 && \
sha256sum -c install.sh.sha256 && \
bash install.sh --version 0.5.0 --nvim 0.12.5 --skip-packages --strict

• --version 0.5.0 фіксує реліз редактора.
• --nvim 0.12.5 встановлює цей реліз Neovim у ~/.local/opt/nvim-v0.12.5, звʼязує його як ~/.local/bin/nvim і перевіряє за SHA-256, який публікує Neovim (Linux і macOS).
• --skip-packages не встановлює жодного системного пакета: образ уже має містити git, curl і Lua.
• --strict завершується з ненульовим кодом, якщо встановлення плагінів у фоновому режимі не вдалося або залишило плагіни відсутніми.

Кожен прапорець має відповідник у вигляді змінної середовища (DWP_VIM_VERSION, DWP_VIM_NVIM, DWP_VIM_SKIP_PACKAGES=1, DWP_VIM_STRICT=1). Додавайте --yes, лише якщо образ уже може містити конфігурацію Neovim, яку слід відсунути вбік.

Вимоги та платформи

• Neovim 0.12 або новіший. Встановіть його самостійно або дозвольте інсталятору додати перевірений реліз за допомогою --nvim X.Y.Z (Linux і macOS).
• Lua: lua, lua5.4 або luajit. Якщо його немає, інсталятор додасть.
• На macOS, Linux і WSL працює інсталятор. Для Windows у README репозиторію описано ручний шлях: встановіть Neovim через winget, клонуйте тег v0.5.0 у %LOCALAPPDATA%\nvim і запустіть lua install.lua з Git Bash.
• Ліцензія GPL-3.0: вільно використовувати, вивчати й змінювати.

Оновлення, фіксація версії та видалення

Щоб оновити, запустіть інсталятор новішого релізу або виконайте bash install.sh --version latest. Повторний запуск переводить наявний клон DeepWorkPlan Vim на обраний реліз, зберігає ваші гілки й ніколи не скидає локальні зміни: якщо локальні зміни чи коміти було б утрачено, він зупиняється й нічого не змінює.

Щоб зафіксувати реліз, використовуйте --version (див. Вибір версії); для гілки чи коміту задайте DWP_VIM_REF. Віддавайте перевагу релізу: релізи до v0.4.0 не містять жестів, оглядача планів, переглядача Markdown і цього інсталятора.

# pin a specific release, here the previous one
curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
curl -fsSL -o install.sh.sha256 https://deepworkplan.com/vim/install.sh.sha256 && \
shasum -a 256 -c install.sh.sha256 && \
bash install.sh --version 0.4.2

Щоб видалити, виконайте lua delete.lua у каталозі конфігурації. Він видаляє конфігурацію, плагіни, дані Mason, кеш і стан, а також копію шрифту, зроблену інсталятором, і не чіпає виконуваний файл Neovim та ваші системні пакети.

cd ~/.config/nvim && lua delete.lua

Запитання

Чи перезапише він мою конфігурацію Neovim?

Ні, не без вашого схвалення. Коли він знаходить конфігурацію, що не належить DeepWorkPlan Vim, інтерактивний запуск питає, перш ніж перемістити її до ~/.config/previous-deepworkplan-vim. Без терміналу він зупиняється й нічого не змінює, якщо тільки ви не передасте --yes, щоб відсунути її вбік без участі людини. Якщо цей шлях резервної копії вже існує, він завжди зупиняється й нічого не змінює.

Чи працює він у Windows?

Інсталятор не працює в Windows. Скористайтеся ручним шляхом із README репозиторію або запустіть інсталятор всередині WSL.

Чи потрібен мені Deep Work Plan, щоб ним користуватися?

Ні. Це передусім редактор. Він не встановлює навичку Deep Work Plan і не вимагає її; оглядачу планів просто нічого показувати, доки не зʼявиться тека .dwp/plans/.

Як ним користується аддон vim у v7?

Deep Work Plan v7 пропонує редактор як необовʼязковий аддон vim під час онбордингу. Аддон виявляє наявне встановлення лише для читання, через файл addon/surface.json редактора, і пропонує зафіксоване встановлення з перевіркою контрольної суми лише за вашої згоди. Він ніколи не перезаписує наявну конфігурацію Neovim без явного схвалення і ніколи не є обовʼязковим.

Як ним користуються програмувальні агенти?

Його створено для людей і для програмувальних агентів, що живуть у терміналі. Його привʼязки клавіш зафіксовано контрактними тестами, тому мʼязова памʼять і очікування агента переживають оновлення.

Яку версію я отримаю?

Інсталятор встановлює реліз, до якого належить, — сьогодні це v0.5.0, — якщо ви не оберете інший через --version або DWP_VIM_VERSION: точну версію, межу >= або latest. DWP_VIM_REF приймає гілку чи коміт; DWP_VIM_REF=main відстежує main. Ця сторінка описує реліз v0.5.0, який містить усі перелічені тут можливості.

Під якою ліцензією він і звідки походить?

GPL-3.0. Він походить від mu-vim Andrés M Prieto, а вказівка авторства залишається в репозиторії.

Вихідний код і ліцензія

Вихідний код міститься в репозиторії DeepWorkPlan Vim. Він відкритий і поширюється за ліцензією GPL-3.0, походить від mu-vim.

Повʼязані записи набору

• Devcontainer — відтворюване середовище розробки (перший аддон)
• Dailybot — звітування про життєвий цикл плану, видиме команді (другий аддон)
• AI Diff Reviewer — локальний перегляд під час фінальних перевірок плану (пʼятий аддон)
• Herdr — делегування завдання рівноправному агенту в панелі Herdr (v7)
• Agentkit — одна команда для кожного термінального програмувального агента та делегування в headless-режимі (v7)