Lista zadań w Vimie

Po co to komu?

Do zarządzania zadaniami w życiu prywatnym stosuję aplikację TickTick, następcę znakomitego Wunderlist, kupionego przez Microsoft w 2015 i po 5 latach zaoranego na rzecz Microsoft To Do. TickTicka używam w wersji darmowej i, jak dotąd, ani niewielkie ograniczenia, ani brak kilku funkcji (np. kalendarza), nie przekonały mnie do inwestycji w wersję płatną. Po prostu darmowa wersja tego narzędzia pokrywa moje potrzeby.

W pracy jednak unikam tego rodzaju programów, by minimalizować shadow IT (skala problemu i tak jest duża). W szczególności nie wykorzystuję narzędzi chmurowych, przez które mogłyby wyciec newralgiczne dane, a niewątpliwie do takich zaliczałaby się aplikacja do planowania zadań. Pomyślałem, że najprostszą alternatywą byłby zwykły plik tekstowy w formacie Markdown, którym zarządzałbym w Vimie. Oczywiście, Vim ma pluginy do list zadań, ale stwierdziłem, że prosty plik w zupełności mi wystarczy, gdyż od bardziej skomplikowanych funkcji, jak określanie zależności między zadaniami czy przypomnienia, mam w pracy inne narzędzia, np. bugtracker i firmowy kalendarz. Ja potrzebowałem tylko zapisać kilka bieżących zadań, czasem dopisać do tego jakieś notatki.

Plik z zadaniami

Przygotowałem zatem prosty plik z legendą i logo. Logo ASCII art jest bardzo ważne. Dzięki temu, gdy ktoś będzie Wam zaglądał przez ramię, skupi się na logo, nie na treści, jest to zatem element opsecowy.

Konfiguracja Vima

Jak widać, format pliku jest oczywisty i u większości z Was lista zadań będzie już wyglądała jako-tako. Jeżeli nie używacie Neovima, będzie to oczywiście wymagało dodania do .vimrc co najmniej:

set nocompatible
syntax on

Pójdźmy jednak krok dalej i dodajmy dodatkową konfigurację dla plików Markdown:

function! ExtendMarkdownToDo()
endfunction
autocmd FileType markdown call ExtendMarkdownToDo()

W funkcji ExtendMarkdownToDo włączmy zawijanie wierszy na wyrazach, o ile nie mamy już tej opcji włączonej w naszej konfiguracji:

set linebreak

Dodajmy zmianę statusu zadania kombinacjami t<Spacja>, tx, tc i t- oraz dodawanie nowego zadania przed i po bieżącym za pomocą, odpowiednio — tO i to. Dorzućmy też skoki do poprzedniego i następnego projektu za pomocą Ctrl-k i Ctrl-j oraz skoki do najważniejszych sekcji:

nnoremap <silent> t<Space> :s/\[.\]/[ ]/<CR>
nnoremap <silent> tx :s/\[.\]/[x]/<CR>
nnoremap <silent> tc :s/\[.\]/[c]/<CR>
nnoremap <silent> t. :s/\[.\]/[.]/<CR>
nnoremap <silent> t- :s/\[.\]/[-]/<CR>
nnoremap <silent> to o<Esc>cc  - [ ] 
nnoremap <silent> tO O<Esc>cc  - [ ] 
nnoremap <silent> tT /^Today$<CR>:nohlsearch<CR>zt
nnoremap <silent> tD /^Done$<CR>:nohlsearch<CR>zt
nnoremap <silent> tB /^Backlog$<CR>:nohlsearch<CR>zt
nnoremap <silent> tS /^Scratchpad$<CR>:nohlsearch<CR>zt
nnoremap <silent> <C-j> /^*<CR>:nohlsearch<CR>
nnoremap <silent> <C-k> ?^*<CR>:nohlsearch<CR>

Możemy jeszcze wymyślić wiele innych skrótów, ale nie chcemy iść w stronę pisania od nowa pluginu, który można pobrać gotowy z Sieci. Zresztą ja w swojej głowie więcej klawiszologii nie zmieszczę.

Mamy już zatem składnię Markdown uzupełnioną o prosty schemat dokumentu (koniecznie z logotypem!) i kilka skrótów klawiaturowych, które ułatwią zmianę statusu zadania. Statusy każdy może zdefiniować sobie według własnego widzimisię — jest to bardzo proste.

Na koniec przydałaby się jeszcze jakaś wisienka na torcie, która wniosłaby walor bajerancko-edukacyjny do całego przedsięwzięcia. Użyjmy zatem opcji conceal mechanizmu kolorowania składni, umożliwiającej ukrywanie i podmienianie znaków. Dzięki temu zastąpimy prymitywne [x] unicodowym ptaszkiem:

syntax match taskStatus '\[ \]' conceal cchar= 
syntax match taskStatus '\[x\]' conceal cchar=✔
syntax match taskStatus '\[c\]' conceal cchar=✘
syntax match taskStatus '\[\.\]' conceal cchar=⧖
syntax match taskStatus '\[-\]' conceal cchar=»

Dorzucimy kolor i włączymy mechanizm ukrywania:

set conceallevel=2
set concealcursor=nv
highlight conceal ctermfg=cyan ctermbg=NONE guifg=cyan guibg=NONE

Dla opcji conceallevel możliwe są wartości:

0

tekst pokazywany bez zmian (domyślnie);

1

tekst podmieniany, a gdy wartość docelowa nie została podana, przyjmowany jest znak z listchars (domyślnie spacja);

2

tekst podmieniany, a gdy wartość docelowa nie została podana — ukrywany;

3

tekst ukrywany.

Wybrałem opcję 2, bo wówczas dokument rozjeżdża się przy znakach, dla których zapomniałbym podać cchar.

Opcję concealcursor ustawiłem tak, by tylko przy edycji pokazywany był oryginalny tekst.

Końcowy efekt

Efekt końcowy w zupełności mnie zadowala. Trochę kolorów i unicodowe ikonki wieńczą dzieło.

Cała konfiguracja przedstawia się zaś następująco:

""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" Lista zadań w Markdown
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

set nocompatible
syntax on

function! ExtendMarkdownToDo()
set linebreak
set conceallevel=2
set concealcursor=nv
highlight conceal ctermfg=cyan ctermbg=NONE guifg=cyan guibg=NONE
syntax match taskStatus '\[ \]' conceal cchar= 
syntax match taskStatus '\[x\]' conceal cchar=✔
syntax match taskStatus '\[c\]' conceal cchar=✘
syntax match taskStatus '\[\.\]' conceal cchar=⧖
syntax match taskStatus '\[-\]' conceal cchar=»
nnoremap <silent> t<Space> :s/\[.\]/[ ]/<CR>
nnoremap <silent> tx :s/\[.\]/[x]/<CR>
nnoremap <silent> tc :s/\[.\]/[c]/<CR>
nnoremap <silent> t. :s/\[.\]/[.]/<CR>
nnoremap <silent> t- :s/\[.\]/[-]/<CR>
nnoremap <silent> to o<Esc>cc  - [ ] 
nnoremap <silent> tO O<Esc>cc  - [ ] 
nnoremap <silent> tT /^Today$<CR>:nohlsearch<CR>zt
nnoremap <silent> tD /^Done$<CR>:nohlsearch<CR>zt
nnoremap <silent> tB /^Backlog$<CR>:nohlsearch<CR>zt
nnoremap <silent> tS /^Scratchpad$<CR>:nohlsearch<CR>zt
nnoremap <silent> <C-j> /^*<CR>:nohlsearch<CR>
nnoremap <silent> <C-k> ?^*<CR>:nohlsearch<CR>
endfunction

autocmd FileType markdown call ExtendMarkdownToDo()

Podsumowanie

Mamy zatem w około trzydziestu linijkach obsłużoną listę zadań, której format jest na tyle prosty, że:

• można ją edytować w dowolnym edytorze;
• można ją śledzić w repozytorium np. Git;
• dzięki legendzie jest właściwie samodokumentująca.

Z kolei konfiguracja naszego Vima pozwala w miarę wygodnie przeglądać, dodawać i odhaczać zadania.