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 (v7.0.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 v0.5.0.

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. Ia adalah konfigurasi Neovim pilihan — server bahasa, pelengkapan otomatis, linting, pemformatan, pencarian kabur, pohon berkas, dan tema warna pilihan, dimuat secara malas — ditambah beberapa permukaan yang menjadikannya editor untuk Deep Work Plan.

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.

Yang Anda dapatkan

Lima fitur, masing-masing hanya sejauh satu tombol.

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.

Tekan Enter pada sebuah rencana 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/.

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.

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 v0.5.0, rilis yang dijelaskan halaman ini, kecuali Anda memilih versi lain.

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

Secara berurutan, pemasang:

1. Memeriksa OS dan manajer paket Anda, lalu memasang git, curl, dan interpreter Lua jika ada yang belum ada (tidak satu pun dengan --skip-packages).
2. Menentukan versi: rilisnya sendiri, atau rilis yang diminta oleh --version.
3. Dengan --nvim X.Y.Z, memasang rilis Neovim tersebut ke ~/.local/opt, diverifikasi terhadap SHA-256 yang diterbitkan Neovim.
4. Bertanya sebelum menyentuh konfigurasi Neovim yang sudah ada. Tanpa terminal, ia berhenti dan tidak mengubah apa pun, kecuali --yes memintanya memindahkan konfigurasi itu ke samping.
5. Meng-clone repositori ke ~/.config/nvim, atau memperbaruinya jika sudah ada di sana.
6. Menjalankan lua install.lua milik repositori itu sendiri.
7. 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 v0.5.0. 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, v0.5.0. 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:

Setelah unduhan dan pemeriksaan checksum di atas:

# 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

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 0.5.0 --nvim 0.12.5 --skip-packages --strict

• --version 0.5.0 mematok rilis editor.
• --nvim 0.12.5 memasang rilis Neovim tersebut ke ~/.local/opt/nvim-v0.12.5, ditautkan sebagai ~/.local/bin/nvim dan diverifikasi terhadap SHA-256 yang diterbitkan Neovim (Linux dan macOS).
• --skip-packages tidak memasang paket sistem apa pun: image harus sudah menyediakan git, curl, dan Lua.
• --strict keluar dengan kode bukan nol jika pemasangan plugin secara headless gagal atau menyisakan plugin yang belum terpasang.

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, atau luajit. 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 v0.5.0 ke %LOCALAPPDATA%\nvim, dan jalankan lua install.lua dari 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.4.2

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 — v0.5.0 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 v0.5.0, 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)