vim-markdown-runner ja Notes-pohjainen työnkulku

(Dan Bridges) (16. tammikuuta 2020)

Kirjoitin äskettäin yksinkertaisen vim-laajennuksen vim-markdown-runner täydentämään merkintähuomautuksiani projektin työnkulku. Tässä viestissä haluan käsitellä muutamia yksityiskohtia tästä työnkulusta ja näyttää, kuinka yksinkertainen on yllättävän voimakas.

vim-markdown-runner toiminnassa

Kokonaisrakenne

Tallennan kaikki muistiinpanotiedostoni yhteen juurihakemisto Dropboxissa. Näin saan helposti tarkastella ja muokata muistiinpanoja mobiililaitteesta. Tämä juurihakemistorakenne peilaa kotihakemistoni, jonka avulla voin liittää projektitiedostopolut heidän muistiinpanotiedostoonsa. Esimerkiksi, jos minulla on projekti ~/projects/side-projects/my-project, liitetty muistiinpanotiedosto sijaitsee osoitteessa ~/Dropbox/notes/projects/side-projects/my-project.md.

Sitten luon symlink .notefile alkuperäisessä projektikansiossa, joka osoittaa Dropbox-pohjaiseen polkuun. Symbolilinkin luomisen syy on kaksi: (i) jotta tiedosto voidaan katsella nopeasti projektihakemistosta ja (ii) jotta tiedostoa muokattaessa vim jää projektikansioon, joten esimerkiksi ctrlp-haku toimii edelleen odotetusti (sen sijaan, että etsin vahingossa muistiinpanokansiota).

Lisäsin muutamia toimintoja ja :Notes -komennon .vimrc luoda tai avata liittyvä muistiinpanotiedosto nykyiseen työkirjahakemistooni.

Notes() tekee raskaan nostamisen. Jos .notefile on jo läsnä, se yksinkertaisesti avaa sen. Jos .notefile ei ole, se suorittaa NotesInitNew(), joka tarkistaa, onko siihen liittyvä Dropbox-tiedosto olemassa. Jos tiedostoa ei ole Dropboxissa, mutta se luo oikean hakemistorakenteen ja luo sitten uuden merkintätiedoston, joka on jo täytetty otsikolla lopullisen hakemiston nimen perusteella. Lopuksi luodaan symboli .notefile ja avataan sitten.

Muistiinpanotiedoston sisällä

Tyypillisen muistiinpanotiedoston sisällä minulla on tavalliset luettelot todoksista, satunnaisista kokousmuistioista ja muista rutiinikohteista, mutta todellinen voima tulee vim-markdown-runnerista, jonka avulla minulla on interaktiivisia leikkikenttiä, projektikohtaisia ​​komentosarjoja ja perus-API-asiakasohjelma, joka yksityiskohtaisesti kertoo projektireitit, korvaa Postmanin tai Pawin .

Leikkikentät

Kehityksen aikana vianetsin tai vahvistan usein pienen koodinpätkän. Yksinkertainen leikkipaikka helpottaa tätä huomattavasti.

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

Vim-markdown-runner -sovelluksella voin sijoittaa kursorini jompaankumpaan näistä koodilohkoista ja suorittaa ne. Oikea kieli / ympäristö havaitaan automaattisesti, ja Go-toiminnossa suoritetaan joitain lisätoimia main() lisäämistä ja goimports suorittamista varten .

Komentosarjat

Minulla on usein projektikohtaisia ​​komentosarjoja, joita ei kannata laittaa omiin tiedostoihinsa. Voin suorittaa myös ne, joissa on vim-markdown-runner:

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

Jos koodilohkossa ei ole määritetty kieltä, vim-markdown-runner suorittaa sen mitä tahansa $SHELL -asetukseksi on valittu.

API-asiakas

Verkkokehitysprojekteissa on muistiinpanotiedostossani Endpoints-osio yksinkertaisena korvaava Postman ja vastaavat. Nämä ovat vain httpie -komentoja, mutta sen avulla voin helposti luetteloida ja suorittaa uudelleen yleiset reitit:

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

Kuten näette, on olemassa useita tehokkaita käyttötapauksia, joita vim-markdown-runner käsittelee. Se on myös hyvin konfiguroitavissa, joten sinun pitäisi pystyä säätämään se omiin tarpeisiisi.

Vastaa

Sähköpostiosoitettasi ei julkaista. Pakolliset kentät on merkitty *