Npm Public Publish — Kütüphanelerini Yayınla

Emre Vatansever
SDTR
Published in
3 min readOct 22, 2020

Merhabalar,

Nedir bu Npm paketi ? Neden Npm paketi oluşturmalı ve kullanmalıyım?

Npm (Node Packaged Modules) javascript dili için geliştirilmiş olan ve Node.js’in standart olarak kabul ettiği bir paket yönetim sistemidir.

İşlerimizi kolaylaştırması ve uygulamanın daha çabuk tamamlanması adına çeşitli geliştiriciler tarafından hazırlanan bir çok paketi npm üzerinde bulabiliriz.

Her projemizde sıklıkla kullandığımız yardımcı sınıflarımızı yayınlayarak kolay yoldan bir başka projemize dahil ederek süreçlerimizi kolaylaştırabiliriz.

Peki Kütüphanemizi Npm (Node Packaged Modules) üzerinde yayınlamalıyız?

Öncelikli olarak yayınlamak istediğimiz modül için belli başlı bilgileri tutan bir package.json dosyası bulunması gerekiyor.

Bu dosyayı oluşturmak için terminal üzerinden yayınlamak istediğimiz klasör yoluna giderek npm init -y — scope=@npm-username komutunu çalıştırmalısınız. Burada npm init sonrasında yer alan -y komutu --yes’in kısaltması olarak kullanılmaktadır. Burada ki -y komutu hızlı olarak package.json dosyasının oluşturulması için eklendi. Burda ki — scope=@npm-username kısmı ise; https://www.npmjs.com/ üzerinde oturum açan ve paketi yayınlayacağımız kullanıcı bilgisi.

Not: ** Bu komutu çalıştırmadan önce bilgisayarımızda nodejs kurulu olması gerekiyor. Nodejs kurulumunu link üzerinden adımları takip ederek tamamlayabilirsiniz.

Eğer kurulumu daha önceden tamamladıysanız. npm init -y — scope=@npm-username komutundan sonra bulunduğunuz path(klasör yolu) altında package.json dosyasının oluşturulduğunu göreceksiniz.

default oluşan package.json dosyası içerisinde belirli bilgiler yer almakta Bunların açıklaması olarak ise aşağıdaki iki resimi inceleyebilirsiniz.

Npm üzerinde yayınlanacak paketi oluşturduk, gerekli ayarlamaları yaptık şimdi ise bu paketi yayınlayalım.

ilk olarak terminal üzerinde oturum açalım

Öncesinde https://www.npmjs.com üzerinde bir kullanıcı oluşturma kısmını tamamladıktan sonra;

npm login komutu ile Kullanıcı adı ve şifresi ile terminal üzerinde oturum açıyoruz. Oturum açma işlemi tamamlandığında konsol üzerinde aşağıda ki çıktı ile karşılaşıcaksınız.

Logged in as npm-username on https://registry.npmjs.org/.

Oturum açma işlemi tamamlandıktan Paketi https://www.npmjs.com üzerinde paylaşmak için basit bir adım kalıyor bunun için ise;

npm publish — access public komutu yeterli olacaktır. Bura da oluşturduğumuz npm paketini public olarak https://www.npmjs.com üzerinde yayınlamak istediğimizi belirtiyoruz.

Yukarıda ki komutu çalıştırdıktan 1–2 dk sonra yayınladığınız paketi https://www.npmjs.com/package/@npm-username/paket-adı url’i ile yada https://www.npmjs.com üzerinde packages bölümünden ulaşabilirsiniz.

Yayınlanan Paketi başka bir projede kullanmak

Terminal üzerinden yüklemek istediğiniz proje yoluna giderek npm üzerinde yayınladığınız pakete erişebilirsiniz.

npm install <modul-name>

Oluşturduğunuz pakete açıklama kısmı eklemek için;

Bir çok eklenti içerisinde gördüğümüz kullanım ile alakalı açıklamaların ve diğer bilgilerin yer aldığı kısımları ayarlamak için ise; Proje dizininde Readme.md dosyasını eklememiz yeterli olacaktır.

Readme.md

README dosyası bilgisayar yazılımının bir dizinindeki veya arşivindeki diğer dosyalar hakkında bilgi içeren, düz metin dosyası şeklinde bir belge olarak tanımlanabilir.

Readme çıktısı

Konuyla ilgili önerileriniz ve sorularınız varsa yorumlarınızı bekliyorum. Okuduğunuz için teşekkür ederim..

--

--