DeepWorkPlan Vim
DeepWorkPlan Vim adalah editor terminal untuk Deep Work Plan: konfigurasi Neovim untuk manusia, dan untuk agen pemrograman, yang bekerja di terminal. Rencana Anda, dokumentasi Anda, dan indeks semua perintah hanya sejauh satu tombol.
Ini adalah produk terpisah, yang ditawarkan sebagai addon vim opsional dari Deep Work Plan v7 (pack v7.9.0). Deep Work Plan bekerja dengan editor apa pun atau tanpa editor, dan editor ini tidak mensyaratkan Deep Work Plan: Anda menambahkannya ke sebuah mesin secara mandiri, dan ia berfungsi sebagai editor ada atau tidaknya rencana. Halaman ini menjelaskan rilis v1.0.1, rilis pemeliharaan dari rilis stabil pertama, v1.0.0: sejak v1.0.0, pemasang beserta flag-nya (dengan variabel DWP_VIM_* yang sesuai), permukaan addon (addon/surface.json, antarmuka 1), perintah editor :DwpPlans, :DwpLanes, :DwpCommands, dan :DwpConfig, kunci dwpvim.json, serta keybinding yang dipatok oleh kontrak pemetaan hanya berubah secara tidak kompatibel pada versi mayor baru.
Mengapa editor terminal untuk Deep Work Plan
Deep Work Plan adalah folder Markdown di bawah .dwp/plans/: sebuah tujuan, tugas atomik, gerbang verifikasi, dan log yang terus berjalan. Manusia meninjaunya, agen menjalankannya, dan keduanya sering melakukannya dari terminal. Editor yang dibuat untuk pekerjaan itu menjaga tiga hal tetap dekat: rencana itu sendiri, dokumentasi di sekitarnya, dan tombol yang memindahkan Anda di antara keduanya.
DeepWorkPlan Vim adalah editor itu. Tujuannya adalah mini VS Code di terminal: menjelajahi berkas, melihat berkas mana yang berubah, meninjau diff lalu menyetujui atau membuang perubahan, ramah dan ringan, mengutamakan agen, dengan status rencana selalu terlihat. Ia adalah konfigurasi Neovim pilihan — server bahasa, pelengkapan otomatis, pemformatan, pencarian kabur, pohon berkas, dan tema warna pilihan, dimuat secara malas — ditambah beberapa permukaan yang menjadikannya editor untuk Deep Work Plan.
- Rencana
- Tugas
- Gerbang verifikasi
- Selesai
Tur: indeks perintah yang tidak bisa ketinggalan zaman
Tekan SPC h h (Spasi adalah tombol leader), atau jalankan :DwpCommands, dan editor mencantumkan setiap pemetaan yang dimilikinya dengan deskripsi satu baris. Daftar ini dihasilkan dari pemetaan tombol yang aktif, sehingga pemetaan yang didefinisikan di mana pun muncul di indeks tanpa perlu didaftarkan, dan indeks tidak bisa ketinggalan zaman.
Itulah seluruh tur: jalankan nvim, lalu tekan Spasi, h, h.
- SPC h h Buka indeks perintah ini
- SPC P Penjelajah rencana
- SPC m p Pratinjau Markdown di peramban
- SPC m r Render Markdown di buffer
- <C-a> Pilih seluruh berkas
- SPC y Salin ke papan klip sistem
- SPC t f Cari berkas
- SPC t t Pencarian langsung di proyek
- SPC x Jalankan atau pratinjau berkas saat ini
- SPC n Pohon berkas
- SPC t h Pilih tema warna
- dan semua pemetaan lainnya, selalu terbaru
Yang Anda dapatkan
Lima fitur, masing-masing hanya sejauh satu tombol.
| Fitur | Tombol | Fungsinya |
|---|---|---|
| Indeks perintah yang dihasilkan | SPC h h |
Setiap pemetaan dalam konfigurasi, dihasilkan dari pemetaan tombol yang aktif. |
| Gestur ala VS Code | <C-a>, SPC y |
Pilih seluruh berkas dengan satu tombol, lalu salin ke papan klip sistem. y biasa juga menyalin ke sana, karena papan klipnya berlaku di seluruh sistem; jika tidak ada alat papan klip (di dalam kontainer atau sesi SSH), salinan dikirim melalui OSC 52. |
| Penjelajah rencana Deep Work Plan | SPC P |
Bilah samping untuk rencana di repositori Anda, dikelompokkan menurut status dengan bilah progres; klik sebuah rencana untuk membuka pembacanya. |
| Penampil Markdown | SPC m p, SPC m r |
Pratinjau Markdown di peramban, atau render di buffer. |
| Pemasang terverifikasi | — | Pemasang mandiri untuk macOS, Linux, dan WSL, dengan jalur manual yang terdokumentasi untuk Windows. |
Rencana tanpa meninggalkan editor
SPC P, :DwpPlans, atau satu klik pada segmen baris status membuka bilah samping rencana. Ia mencakup setiap folder .dwp/plans/ di direktori saat ini dan direktori konfigurasi Neovim Anda, dan mengelompokkan rencana mulai dari yang paling butuh perhatian. Di editor, labelnya adalah Working, Needs attention, Ready, Not started, dan Done. Setiap rencana menampilkan bilah progres.
Klik sebuah rencana, atau tekan Enter padanya, untuk membuka pembaca: tujuan dalam satu kalimat, status dan progres, daftar tugas dengan tugas saat ini ditandai, dan lompatan berbahasa sederhana ke berkas milik rencana itu sendiri. Baris status menampilkan rencana aktif secara langsung, dan layar awal mencantumkan tiga teratas. Permukaan-permukaan ini menjelaskan rencana; mereka tidak pernah menulis ke .dwp/.
Bilah samping ini merespons mouse dan keyboard. Panah kecil di samping sebuah rencana menampilkan atau menyembunyikan tugas dan berkasnya, dan klik pada sebuah tugas atau berkas membukanya. j, k, tombol panah, Ctrl-n, dan Ctrl-p berpindah dari rencana ke rencana, melewati baris kosong dan hiasan. Setiap bagian menampilkan jumlahnya, warna status menandai ikon dan bilah progres, rencana yang aktif memiliki judul tebal sedangkan rencana yang sudah selesai berjudul redup, dan grup Done yang berisi lebih dari enam rencana terbuka dalam keadaan tertutup. Jendelanya hanya-baca dan tenang: tombol penyuntingan tidak melakukan apa pun alih-alih menampilkan galat.
Rencana dan pohon berkas bergantian: membuka satu bilah samping menutup yang lain, sehingga Anda melihat satu hal pada satu waktu. Pembaca ditutup bersama bilah samping rencana. Apakah membuka satu bilah samping menutup yang lain diatur oleh kunci sidebars.exclusive di dwpvim.json.
Rencana orkestrator — lead yang mengoordinasikan lane di repositori lain — juga mendapat tampilan lane hanya-baca: :DwpLanes, atau L di bilah samping rencana. Tampilan ini membaca tabel lane rencana dan menampilkan status langsung setiap lane dari herdr-peers lanes; bila tidak ada Herdr yang dapat dijangkau, ia menyatakannya dan hanya menampilkan tabel. Lihat Menjalankan banyak agent.
Untuk membaca berkas Markdown sebuah rencana di tempat, SPC m p mempratinjau buffer saat ini di peramban dan SPC m r merendernya di dalam buffer. Keduanya hanya berfungsi di buffer Markdown.
Dasbor
Layar awal adalah milik DeepWorkPlan Vim sendiri. Ia menampilkan logo Deep Work Plan yang diukir dengan karakter braille dengan VIM mungil terselip di bawah huruf P-nya, kredit “powered by Dailybot” di bawahnya, dan sebuah pemandangan terukir di sisi kanan: mercusuar Deep Work Plan dan sebuah kapal yang berlayar di lautnya. Cahayanya berdenyut perlahan selama dasbor tampil; setel vim.g.dwp_greeter_pulse = false untuk mematikannya.
Pemandangan tersedia dalam enam ukuran tinggi, dipilih menurut jumlah baris yang tersisa di jendela. Pada jendela yang lebih sempit, logo teks ditumpuk di atas pemandangan atau tampil sendiri. Jendela lebar menampilkan pintasan dan “Your plans” berdampingan, sedangkan jendela sempit menumpuknya. Tekan Enter untuk mengaktifkan baris di bawah kursor; SPC P membuka bilah samping rencana.
Mengonfigurasi bilah samping
Sebuah berkas dwpvim.json menentukan di sisi mana kedua bilah samping berada dan seberapa lebar keduanya. Berkas di direktori editor (~/.config/nvim) berlaku untuk semua proyek, dan .dwpvim.json di direktori tempat Anda memulai Neovim menimpanya untuk proyek tersebut. Pengaturan dibaca saat startup, jadi mulai ulang Neovim setelah menyunting berkas.
{
"tree": { "side": "left", "width": 40 },
"plans": { "side": "left", "width": 48 },
"sidebars": { "exclusive": true }
}
| Kunci | Nilai | Bawaan | Fungsinya |
|---|---|---|---|
tree.side |
"left" atau "right" |
"left" |
Sisi pohon berkas (SPC n) |
tree.width |
bilangan bulat, 20 sampai 120 | 40 |
Lebar maksimum pohon; ia tetap menyusut sesuai isinya |
plans.side |
"left" atau "right" |
"left" |
Sisi bilah samping rencana (SPC P) |
plans.width |
bilangan bulat, 20 sampai 120 | 48 |
Lebar maksimum bilah samping rencana |
sidebars.exclusive |
true atau false |
true |
Satu bilah samping pada satu waktu; false membiarkan keduanya tetap terbuka |
Berkas yang tidak ada tidak masalah. Berkas yang bukan JSON valid, kunci yang tidak dikenal, atau nilai yang tidak valid diabaikan dan dilaporkan, tidak pernah fatal. Jalankan :DwpConfig untuk melihat setiap nilai yang berlaku, berkas asalnya, dan masalah yang ditemukan.
Editor yang lebih ringan
Versi 0.6.0 menghapus apa yang tidak dipakai siapa pun, sehingga ada lebih sedikit plugin untuk dipatok dan lebih sedikit paket untuk dipasang serta diperbarui saat pertama kali dijalankan:
- Sebelas server bahasa Mason dihentikan: efm, diagnosticls, tailwindcss, grammarly, bashls, serta server untuk astro, svelte, Vue 2, Angular, SQL, dan skrip Vim.
- nvim-lint dihapus, karena tidak pernah ada linter yang dikonfigurasi.
- Entri pemformat prettier dihapus, karena tidak ada yang memasang prettier.
:Formattetap memakai biome, black, shfmt, dan stylua. - marksman tetap ada untuk mengikuti tautan, melengkapi tautan dan judul, serta kerangka dokumen, dengan diagnostiknya dibungkam. Markdown sengaja tetap tanpa pemformat.
Hanya server yang tercantum dalam konfigurasi yang diaktifkan, bahkan ketika Mason masih menyimpan server lain dari penyiapan sebelumnya. Setiap plugin, server, dan alat, beserta alasan keberadaannya, tercantum di PLUGINS.md.
Instalasi
Instalasi terdiri dari tiga perintah: unduh skrip, periksa terhadap SHA-256 berkas yang disajikan situs ini, lalu jalankan. Pemasang mematok rilisnya sendiri, sehingga ia memasang tepat v1.0.1, rilis yang dijelaskan halaman ini, kecuali Anda memilih versi lain.
curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
echo "24a550239108a71434e993675389c27c64d88c4c07af8efc9be98d23897fb716 install.sh" | shasum -a 256 -c && \
bash install.sh Periksa sebelum menjalankan
Ingin membacanya dulu? Unduh skrip, periksa sidik jarinya, baca, lalu jalankan.
- Unduh skrip
curl -fsSL https://deepworkplan.com/vim/install.sh -o install.sh - Tampilkan SHA-256 dan bandingkan dengan nilai di bawah
sha256sum install.sh - Baca skrip
less install.sh - Jalankan skrip
bash install.sh
- SHA-256 skrip yang disajikan sekarang
24a550239108a71434e993675389c27c64d88c4c07af8efc9be98d23897fb716- 46504 byte · 1109 baris
Di macOS, gunakan shasum -a 256 install.sh untuk langkah kedua.
Untuk memilih versi, berikan --version atau setel DWP_VIM_VERSION: versi persis, batas minimum '>=', atau latest. DWP_VIM_REF menerima cabang atau commit. Rilis lama mungkin tidak memuat semua fitur yang dijelaskan di halaman ini.
Di Windows, perintah-perintah ini tidak berlaku; README repositori mendokumentasikan jalur manual. Jalur instalasi Windows
Secara berurutan, pemasang:
- Memeriksa OS dan manajer paket Anda, lalu memasang git, curl, dan interpreter Lua jika ada yang belum ada (tidak satu pun dengan
--skip-packages). - Menentukan versi: rilisnya sendiri, atau rilis yang diminta oleh
--version. - Dengan
--nvim X.Y.Z, memasang rilis Neovim tersebut ke~/.local/opt, diverifikasi terhadap SHA-256 yang diterbitkan Neovim. - Bertanya sebelum menyentuh konfigurasi Neovim yang sudah ada. Tanpa terminal, ia berhenti dan tidak mengubah apa pun, kecuali
--yesmemintanya memindahkan konfigurasi itu ke samping. - Meng-clone repositori ke
~/.config/nvim, atau memperbaruinya jika sudah ada di sana. - Menjalankan
lua install.luamilik repositori itu sendiri. - Memasang plugin secara headless lalu memeriksanya, sehingga tidak ada langkah keluar lalu membuka ulang. Dengan
--strict, pemasangan plugin yang gagal atau tidak lengkap dianggap sebagai galat.
Skrip yang disajikan di sini adalah salinan identik byte demi byte dari install.sh pada tag v1.0.1. Checksum-nya disajikan di sebelahnya, di https://deepworkplan.com/vim/install.sh.sha256, sehingga Anda dapat memverifikasi unduhan dengan shasum -a 256 -c install.sh.sha256 (di Linux, sha256sum -c install.sh.sha256). Untuk pemeriksaan dari sumber kedua, bandingkan dengan baris install.sh di SHA256SUMS pada rilis GitHub. Jalankan bash install.sh --help untuk menampilkan semua opsi.
Memilih versi
Secara bawaan, pemasang memasang rilisnya sendiri, v1.0.1. Untuk memilih versi lain, setel DWP_VIM_VERSION atau berikan --version: keduanya melakukan hal yang sama, jadi gunakan yang lebih mudah dibaca, dan flag lebih diutamakan daripada variabel lingkungan. Masing-masing menerima:
| Bentuk | Contoh | Yang dipasang |
|---|---|---|
| Versi persis | 1.0.0 atau v1.0.0 |
Rilis tersebut |
| Batas minimum | '>=0.4.2' |
Rilis stabil terbaru yang sama dengan atau di atas batas tersebut |
| Terbaru | latest |
Rilis stabil terbaru |
Setelah unduhan dan pemeriksaan checksum di atas:
# exact version
DWP_VIM_VERSION=1.0.0 bash install.sh
bash install.sh --version 1.0.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
Beri tanda kutip pada batas minimum agar shell tidak membaca > sebagai pengalihan. Versi hanya di-resolve ke tag rilis stabil. Untuk cabang atau commit, setel DWP_VIM_REF sebagai gantinya (DWP_VIM_REF=main mengikuti main); versi dan ref yang saling bertentangan dianggap sebagai galat.
Kontainer dan CI
Di dalam image atau job CI, tempat tidak ada terminal dan sering kali tidak ada akses root, unduh dan verifikasi skrip, lalu jalankan dalam satu langkah dengan flag yang membuat hasilnya dapat direproduksi:
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 1.0.0 --nvim 0.12.5 --skip-packages --strict
--version 1.0.0mematok rilis editor.--nvim 0.12.5memasang rilis Neovim tersebut ke~/.local/opt/nvim-v0.12.5, ditautkan sebagai~/.local/bin/nvimdan diverifikasi terhadap SHA-256 yang diterbitkan Neovim (Linux dan macOS).--skip-packagestidak memasang paket sistem apa pun: image harus sudah menyediakan git, curl, dan Lua.--strictkeluar dengan kode bukan nol jika pemasangan plugin secara headless gagal atau menyisakan plugin yang belum terpasang. Opsi ini juga memeriksa bahwa setiap plugin, dan pckr, berada di commit yang dipatok rilis dipckr/lockfile.lua.
Setiap flag memiliki padanan variabel lingkungan (DWP_VIM_VERSION, DWP_VIM_NVIM, DWP_VIM_SKIP_PACKAGES=1, DWP_VIM_STRICT=1). Tambahkan --yes hanya jika image mungkin sudah berisi konfigurasi Neovim yang perlu dipindahkan ke samping.
Persyaratan dan platform
- Neovim 0.12 atau lebih baru. Pasang sendiri, atau biarkan pemasang menambahkan rilis terverifikasi dengan
--nvim X.Y.Z(Linux dan macOS). - Lua:
lua,lua5.4, atauluajit. Pemasang menambahkannya jika belum ada. - macOS, Linux, dan WSL menjalankan pemasang. Windows memiliki jalur manual yang terdokumentasi di README repositori: pasang Neovim dengan winget, clone tag
v1.0.1ke%LOCALAPPDATA%\nvim, dan jalankanlua install.luadari Git Bash. - Berlisensi GPL-3.0: bebas digunakan, dipelajari, dan dimodifikasi.
Memperbarui, mengunci versi, dan mencopot
Untuk memperbarui, jalankan pemasang dari rilis yang lebih baru, atau jalankan bash install.sh --version latest. Menjalankannya ulang memindahkan checkout DeepWorkPlan Vim yang sudah ada ke rilis yang dipilih, mempertahankan cabang Anda, dan tidak pernah me-reset perubahan lokal: jika perubahan atau commit lokal akan hilang, ia berhenti dan tidak mengubah apa pun.
Untuk mengunci sebuah rilis, gunakan --version (lihat Memilih versi); untuk cabang atau commit, setel DWP_VIM_REF. Utamakan rilis: rilis sebelum v0.4.0 tidak memuat gestur, penjelajah rencana, penampil Markdown, maupun pemasang ini.
# 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.5.1
Untuk mencopot, jalankan lua delete.lua dari direktori konfigurasi. Perintah ini menghapus konfigurasi, plugin, data Mason, cache dan status, serta salinan font yang dibuat pemasang, dan membiarkan biner Neovim serta paket sistem Anda.
cd ~/.config/nvim && lua delete.lua
Pertanyaan
Apakah ini akan menimpa konfigurasi Neovim saya?
Tidak, bukan tanpa persetujuan Anda. Saat menemukan konfigurasi yang bukan DeepWorkPlan Vim, eksekusi interaktif bertanya dulu sebelum memindahkannya ke ~/.config/previous-deepworkplan-vim. Tanpa terminal, ia berhenti dan tidak mengubah apa pun, kecuali Anda memberikan --yes untuk memindahkannya ke samping tanpa pengawasan. Jika jalur cadangan itu sudah ada, ia selalu berhenti dan tidak mengubah apa pun.
Apakah berfungsi di Windows?
Pemasang tidak berjalan di Windows. Gunakan jalur manual di README repositori, atau jalankan pemasang di dalam WSL.
Apakah saya butuh Deep Work Plan untuk menggunakannya?
Tidak. Ia adalah editor lebih dulu. Ia tidak memasang atau mensyaratkan skill Deep Work Plan; penjelajah rencana hanya tidak punya apa pun untuk dicantumkan sampai folder .dwp/plans/ ada.
Bagaimana addon vim v7 menggunakannya?
Deep Work Plan v7 menawarkan editor ini sebagai addon vim opsional selama onboarding. Addon tersebut mendeteksi instalasi yang sudah ada secara hanya-baca, melalui addon/surface.json milik editor, dan menawarkan instalasi yang dipatok serta terverifikasi checksum hanya dengan persetujuan Anda. Ia tidak pernah menimpa konfigurasi Neovim yang sudah ada tanpa persetujuan eksplisit, dan tidak pernah diwajibkan.
Bagaimana agen pemrograman menggunakannya?
Ia dibuat untuk manusia dan untuk agen pemrograman yang hidup di terminal. Pemetaan tombolnya dikunci oleh pengujian kontrak, sehingga ingatan otot, dan ekspektasi agen, bertahan melewati pembaruan.
Versi mana yang saya dapatkan?
Pemasang memasang rilis tempat ia berasal — v1.0.1 saat ini — kecuali Anda memilih versi lain dengan --version atau DWP_VIM_VERSION: versi persis, batas >=, atau latest. DWP_VIM_REF menerima cabang atau commit; DWP_VIM_REF=main mengikuti main. Halaman ini menjelaskan rilis v1.0.1, yang memuat setiap fitur yang tercantum di sini.
Di bawah lisensi apa dan dari mana asalnya?
GPL-3.0. Ia diturunkan dari mu-vim karya Andrés M Prieto, dan kreditnya tetap ada di repositori.
Kode sumber dan lisensi
Kode sumbernya ada di repositori DeepWorkPlan Vim. Repositori ini publik dan berlisensi GPL-3.0, diturunkan dari mu-vim.
Entri kit terkait
- Devcontainer — lingkungan pengembangan yang dapat direproduksi (addon pertama)
- Dailybot — pelaporan siklus hidup rencana yang terlihat oleh tim (addon kedua)
- AI Diff Reviewer — tinjauan lokal selama Final Review rencana (addon kelima)
- Herdr — mendelegasikan tugas ke agen rekan di panel Herdr (v7)
- Agentkit — satu perintah untuk setiap agen pemrograman terminal, dan delegasi headless (v7)