vim-markdown-runner a Notes Based Workflow

(Dan Bridges) (16. ledna 2020)

Nedávno jsem napsal jednoduchý plugin vim, vim-markdown-runner , který doplnil mé poznámky o poznámky založené na pracovní postup projektu. V tomto příspěvku se chci věnovat několika dalším podrobnostem tohoto pracovního postupu a ukázat, jak překvapivě silná je jeho jednoduchost.

vim-markdown-runner v akci

Celková struktura

Všechny své soubory poznámek ukládám do jednoho kořenový adresář v Dropboxu. To mi umožňuje snadno prohlížet a upravovat poznámky z mobilního zařízení. Tato struktura kořenového adresáře zrcadlí můj domovský adresář, což mi umožňuje přidružit cesty k souborům projektu s jejich souborem poznámek. Například pokud mám projekt v ~/projects/side-projects/my-project přidružený soubor poznámky je umístěn na ~/Dropbox/notes/projects/side-projects/my-project.md.

Potom vytvořím symbolický odkaz .notefile v původní složce projektu, který ukazuje na úplnou cestu založenou na Dropboxu. Důvod pro vytvoření symbolického odkazu je dvojí: (i) umožnit rychlé prohlížení souboru z adresáře projektu a (ii) tak, aby při úpravách souboru vim zůstal ve složce projektu, takže věci jako ctrlp search stále fungují podle očekávání (namísto náhodného prohledání složky poznámek).

Přidal jsem několik funkcí a příkaz :Notes do svého .vimrc vytvořit nebo otevřít přidružený soubor poznámky pro můj aktuální pracovní adresář.

Notes() provádí těžké zvedání. Pokud je .notefile již přítomen, jednoduše jej otevře. Pokud neexistuje .notefile, spustí se NotesInitNew(), který zkontroluje, zda existuje přidružený soubor Dropbox. Pokud soubor v Dropboxu ještě neexistuje, vytvoří správnou adresářovou strukturu, vytvoří nový soubor markdownu, který je již naplněn názvem založeným na konečném názvu adresáře. Nakonec se vytvoří .notefile symbolický odkaz, který se poté otevře.

Uvnitř souboru poznámky

Uvnitř typického souboru poznámky budu mít obvyklé seznamy úkolů, náhodné poznámky ze schůzky a další rutinní položky, ale skutečná síla pochází od vim-markdown-runnera, který mi umožňuje mít interaktivní hřiště, skripty specifické pro projekt a základního klienta API s podrobnostmi o trasách projektů, nahrazovat Postmana nebo Paw .

Hřiště

Během vývoje často řeším problémy nebo ověřuji malou část kódu, což mi velmi usnadňuje jednoduché hřiště.

## Playground```go
fmt.Println(os.Getwd())
``````python
import pandas as pd
print(pd.read\_csv("data.csv"))
```

S vim-markdown-runnerem mohu umístit kurzor do některého z těchto bloků kódu a spustit je. Správný jazyk / prostředí bude automaticky detekováno a v případě Go budou provedeny další kroky k přidání main() a spuštění goimports .

Skripty

Často budu mít skripty specifické pro projekt, které se opravdu neoplatí vkládat do jejich vlastních souborů. Mohu je spustit také s vim-markdown-runner:

## Scripts```
get\_name() {
echo "Dan"
}echo "You are $(get\_name)"
```

Pokud v bloku kódu není zadán žádný jazyk, vim-markdown-runner jej spustí s cokoli $SHELL je nastaveno na.

Klient API

V rámci projektů webového vývoje mám v souboru poznámek sekci Koncové body jako jednoduchý náhrada za Postmana a podobně. Jedná se pouze o httpie příkazy, ale umožňuje mi snadno katalogizovat a znovu spustit běžné trasy:

## Endpoints```
http localhost:3000/api/todos
``````
http POST localhost:3000/api/todos title=Stuff
```...etc

Jak vidíte, existuje řada výkonných případů použití, které vim-markdown-runner zpracovává. Je také velmi konfigurovatelný, takže byste jej měli být schopni přizpůsobit svým vlastním potřebám.

Napsat komentář

Vaše e-mailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *