komma igång

Att starta ett nytt projekt eller paket innebär ofta en hel del standardarbete och upprepade moment. Jag brukar börja med ett enkelt npm init -y oavsett om jag tänker publicera projektet på npm. npm-verktyget har bra konventioner kring semantisk versionshantering. Det finns väldigt många alternativ där ute för generatorer, och jag är ganska förtjust i module-init i de flesta fall, även om jag ofta ändrar en hel del i det den genererar.

Du kanske vill börja minimalt och ge dig själv chansen att ompröva varje val. Även om du vill hålla det slimmat och inte använda en projektgenerator finns det några standardfiler du förmodligen vill ha i varje nytt repo.

README.md

Kanske den viktigaste filen i ditt projekt – en bra README gör mycket för hur väl projektet tas emot. Jag gillar att utveckla Usage-avsnittet tidigt. Det hjälper mig att definiera vad jag faktiskt vill bygga. När du har dokumentation för hur paketet används är du redo att kasta dig in i index.js.

generator-standard-readme

Projektet Standard Readme ger ett bra skelett som säkerställer att du på ett logiskt sätt får med användbara detaljer. Frågorna är lite ordrika, och jag önskar att den utnyttjade en befintlig package.json eller ~/.npmrc för att hoppa över standardval, men det är ändå ett bra verktyg som det är.

alias standard-readme='npx -p generator-standard-readme -p yo yo standard-readme'

.gitignore

Du har redan kört git init, eller hur? Allvarligt talat, använd versionshantering överallt!

goops

joe av karan

CONTRIBUTING.md och code-of-conduct.md

Att hjälpa användarna av ditt projekt att bli bidragsgivare bör vara ett mål, och de här filerna sätter ramarna för hur du vill att projektet ska drivas.

contribs

conduct

LICENSE

Om du börjar på GitHub är du förmodligen van vid att den här filen bara finns där. Men jag är ofta flera commits in och redo att pusha innan jag inser att jag behöver hämta en licensfil från ett annat lokalt projekt.

lice

mer p2p, tack

Här är en uppföljande genomgång från förra länktipset som visar hur man bygger en decentraliserad, peer-to-peer-fotoapp med Beaker och Dat. Dessutom har Beaker några guider i sin dokumentation som är värda att kolla in.

intressanta projekt

ginnx

Om du inte dockeriserar allt verkar det här vara ett utmärkt sätt att hantera en ganska tjatig rutin.

async-collection

Jag använder flera av dessa paket i nästan varje modul jag skapar. Det är en bra, smalare lösning jämfört med async.

exa

Jag är inte redo att helt ersätta ls, men jag har uppdaterat mina standardalias för att dra nytta av de förbättrade färgerna och formateringen från den här binären.

alias l='exa -la'
alias ll='exa -l'

Express Gateway

Ännu ett projekt som gör om en enkel manifestfil till en robust tjänst – ser fram emot att utforska den mer på djupet snart.