NPM Scriptleri nelerdir ?

Node.js projelerinin paket yöneticisi olan npm, node.js projeleri geliştirirken bir çok işi hallederek bize faydası olan bir araç.

NPM sadece paketleri indirmek ve yönetmekle kalmıyor aynı zamanda css küçültmek. typescript derlemek ve projeyi build etmek gibi bir çok işi hallediyor.
Bu yazıda hem özel hem de kullanıcı tanımlı olabilen scriptleri inceledim.

Özel npm scriptleri

Daha önce node.js içeren bir proje yazdıysanız (react, express vs) ne olduğu bilmeseniz de farkına varmışsınızdır ki projenin tam olarak hazır olması için bazı npm scriptleri çalıştırıyoruz.

Bazı önemli npm scriptleri :

  • npm init : Yeni bir npm projesi oluşturmak için kullanılır. Daha açık bir şekilde package.json dosyası oluşturarak bulunduğu klasörün bir node.js projesi olduğunu belirtir. -y komutunu da ( flag da denebilir ) ekleyerek hiçbir soru cevaplamayarak otomatik olarak bir package.json oluşturabilirsiniz.
  • npm install : aynı zamanda npm i olarak da geçer. Önceden oluşturulmuş bir node.js projesinde gerekli kütüphaneler yoksa ( node_modules ) package.json yardımıyla gerekli kütüphaneleri yükler
    özellikle github vs. kaynaklardan bulunan projeleri çalıştırmak için ilk şarttır.
  • npm install <paket_adı> : npm install ile bir npm paketi belirtirseniz o paketi mevcut projenize ekler.
    örnek kullanım => npm i express
  • npm remove <paket_adı> : npm i ile kurulmuş bir paketi projeden kaldırır.
    örnek kullanım => npm remove express

Kullanıcı tanımlı scriptler

npm’in kendi tanımlı olan scriptleri hariç kendi scriptlerinizi de npm run <script_adı> ile çalıştırabilirsiniz. Kullanıcı tanımlı cümlesi sizi yanıltmasın aslında bu yöntem ile genelde frameworklerin bizim için hazırladığı scriptleri de çalıştırabiliriz.

Örnek vermek gerekirse bir vite ile bir web projesi geliştirirken konsola npm run dev yazarak vite’in geliştirme sunucusunu çalıştırabiliyoruz.

not : özel ayrılmış kelimeler

Npm’in kendi özel scriptleri olduğu gibi kendi ayrılmış kelimeleri de var. Aslında benzer anlamda olsalar da ayrılmış kelimelerin script yapısını biz değiştirebiliyoruz.

Özel kelimeleri kullanırken npm run dev demek yerine run kelimesi olmadan direkt komutu veriyoruz.

  • npm start : Bu komut uygulamayı çalıştırmak için kullanılır. Normalde tanımlı değildir sizin package.json’da tanımlamanız lazım.
    Node.js projelerinde tavsiye edilen ana dosyayı npm start ile çalıştıracak şekilde eklemek
    package.json start scripti örneği : “start” : “node app.js”
  • npm test : Bu komut da genellikle uygulamayı test etmek için kullanılır. package.json’da tanımlamanız gerekir.

script ekleme

Örnek bir script eklemek için bir npm projesi oluşturalım. bunun için npm init -y yazmanız yeterli.
Ardından package.json dosyasını açalım ve aşağıdaki şekilde test scriptini değiştirelim

{
  "name": "npm-scripts",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo test scriptinden merhaba"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Şimdi aynı konumda konsola npm test yazdığınızda konsolda “test scriptinden merhaba” yazısını görmeniz gerekli.

npm scripti

test özel bir kelime olduğu için npm test yazdık. şimdi bir tane biz tanımlayalım

bir tane index.js dosyası oluşturup içine bir log yazın.

console.log

istediğiniz bir isimde npm scripti ekleyin. Ben index isminde ekledim. Bu komuta node index.js yazın, bu şekilde index.js dosyasını node.js’in çalıştırmasını sağlayacak.

npm package.json görseli

npm run index ( veya sizin komutun adı ) yapın ve dosyayı çalıştırın.

npm run script

Dokümantasyon

Daha fazla bilgi için resmi npm dokümantasyonu’na bakabilirsiniz.

Yorum bırakın

E-posta adresiniz yayınlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir

Scroll to Top