Je software open source maken

-

In de verschillende projecten die ik voor klanten heb gedaan heb ik al meerdere keren een zelfde soort plugin geschreven. Ik wilde een makkelijkere manier om deze plugin vaker te kunnen gebruiken. Er zijn een aantal manieren om dit te realiseren:

  1. Je slaat de code ergens op je computer op
  2. Je zet de code zo dat al je collega’s het kunnen gebruiken (private npm registry)
  3.  Je zet de code op een publieke omgeving, github en npm registry

Als fronteer maak ik veel gebruik van verschillende open source modules die op internet te vinden zijn. Denk bijvoorbeeld aan jQuery of AngularJS. Hoe tof is het dan om eens iets terug te kunnen geven aan de community. De vraag is alleen wat ga je doen? Release je een eigen module of verbeter je een stuk bestaande software? Om iets kleins terug te kunnen doen heb ik gekozen voor de derde optie.

Maak je plugin open source

Het maken van een plugin is eigenlijk makkelijker als gedacht. Om te beginnen heb je natuurlijk een npm project nodig (je hebt dus een package.json) en een licentie. De package.json is bij de meeste frontenders wel bekend maar een licentie niet altijd. Bij software voor klanten hoef je niet na te denken over een licentie maar bij Open Source software is het wel goed om hier even bij stil te staan. Er zijn simpele tools beschikbaar om je hierbij te helpen zoals choosealicense.com. Nadat je een licentie hebt gekozen kan je deze in je project zetten d.m.v. een LICENSE bestand in de root van je project en in je package.json een verwijzing hiernaar.

Als je een licentie hebt en een node project ben je eigenlijk klaar om te gaan. Het publiceren van een npm module is redelijk eenvoudig.

  1. Open een terminal in de root van je project.
  2. Typ[bash]$ npm publish[/bash]
  3. Je bent klaar, ga naar https://www.npmjs.com/package/JE_PACKAGE_NAAM om te checken of het is gelukt.

Indien het de eerste keer is dat je een project gaat releasen ben je nu waarschijnlijk tegen een probleem aangelopen. Het publish commando heeft een fout gegeven dat je niet ingelogd bent nog. Hij helpt je hier bij door te precies te vertellen wat je moet doen. Typ in je terminal

[bash]$ npm-adduser[/bash]

en doorloop de stappen om je pc te koppelen. Probeer daarna de stappen die hierboven beschreven zijn nogmaals en je zal zien dat het nu wel lukt.

Wil je meer informatie over de plugin kijk dan bij het NPM Package of op Github.

Bron afbeelding: Joshua Earle / Unsplash