avatar
·3 dk okuma
package.json Dosyası

package.json Dosyası

Node.js projelerinde package.json dosyası, projenizin yapı taşlarından biridir. Bu dosya, projenizin bağımlılıklarını yönetmek, meta verileri saklamak ve npm (Node Package Manager) ile etkileşimde bulunmak için kullanılır. Bu makalede, package.json dosyasının ne olduğunu, neden önemli olduğunu ve nasıl oluşturulacağını detaylı bir şekilde ele alacağız.

package.json Nedir?

package.json, npm'in konfigürasyon dosyasıdır. Bu dosya, JSON (JavaScript Object Notation) formatında olup, genellikle Node.js paketinizin kök dizininde yer alır. Bu dosya, projenizle ilgili çeşitli meta verileri içerir ve aşağıdaki bilgileri sağlar:

  • Paket Adı: Projenizin adı.

  • Sürüm Numarası: Projenizin versiyonu.

  • Açıklama: Projenizin kısa açıklaması.

  • Anahtar Kelimeler: Projenizi tanımlayan kelimeler.

  • Ana Dosya (Main File): Projenizin giriş noktası.

Neden package.json'a İhtiyacımız Var?

package.json dosyası, bir projenin nasıl çalıştırılacağı ve onunla nasıl etkileşimde bulunulacağı konusunda merkezi bir yer sağlar. Bu dosya, npm CLI (Komut Satırı Arayüzü) tarafından kullanılır ve aşağıdaki sebeplerden dolayı önemlidir:

  • Bağımlılık Yönetimi: Projenizin hangi modüllere bağımlı olduğunu belirtir ve bu bağımlılıkların otomatik olarak kurulmasını sağlar.

  • Scriptler: Proje için çeşitli komut dosyaları tanımlamanıza olanak tanır (örneğin, test, build komutları).

  • Sürüm Yönetimi: Projenizin sürüm numarasını belirleyerek, sürüm yükseltmeleri ve güncellemelerini yönetmenizi sağlar.

package.json Dosyasının Oluşturulması

Manuel Oluşturma

Bir package.json dosyasını manuel olarak oluşturmak için aşağıdaki adımları izleyebilirsiniz:

  1. Yeni Bir Klasör Oluşturma:

    mkdir my-custom-package
    cd my-custom-package
  2. app.js Dosyası Oluşturma (CMD):

    echo. > app.js
  3. app.js Dosyasına Basit Bir sayHello Fonksiyonu Ekleyin:

    function sayHello(name) {
        console.log(`Merhaba ${name}, BilGen Yazılım Akademi'ye hoş geldiniz!`);
    }
    
    module.exports = sayHello;
  4. package.json Dosyasını Oluşturma:

    touch package.json
  5. package.json Dosyasının İçeriğini Ekleyin:

    {
        "name": "bilgen-yazilim-akademi",
        "version": "1.0.0",
        "description": "BilGen Yazılım Akademi selamlama paketi",
        "main": "app.js",
        "keywords": ["bilgen", "yazilim", "akademi", "selamlama"]
    }

npm CLI Kullanarak Oluşturma

package.json dosyasını manuel olarak oluşturmak yerine, npm CLI kullanarak daha hızlı ve kolay bir şekilde oluşturabilirsiniz. Bunun için aşağıdaki adımları takip edebilirsiniz:

  1. Proje Klasörüne Geçin:

    cd my-custom-package
  2. npm init Komutunu Çalıştırın:

    npm init
  3. npm init -y Komutunu Kullanarak Varsayılan Değerlerle package.json Dosyasını Oluşturma:

    npm init -y

    Bu komut, tüm soruları atlayarak varsayılan değerlerle bir package.json dosyası oluşturur.

package.json Dosyasının İçeriği

package.json dosyasındaki temel alanları ve bunların anlamlarını aşağıda detaylı bir şekilde inceleyelim:

  • name: Paketin adı. Bu alan zorunludur ve küçük harflerle, tek kelime olmalı, tire veya alt çizgi içerebilir.

    "name": "bilgen-yazilim-akademi"
  • version: Paketin sürümü. Bu alan da zorunludur ve semantik versiyonlama kurallarına uygun olmalıdır (örn. 1.0.0).

    "version": "1.0.0"
  • description: Paketin kısa açıklaması. Bu alan, npm kaydında paketinizi ararken kullanılır.

    "description": "BilGen Yazılım Akademi selamlama paketi"
  • keywords: Paketinizi tanımlayan anahtar kelimeler. Bu alan, paketinizi arayan kullanıcılar için faydalıdır.

    "keywords": ["bilgen", "yazilim", "akademi", "selamlama"]
  • main: Projenizin giriş noktası. Genellikle ana JavaScript dosyanızın adıdır.

    "main": "app.js"

Sonuç

package.json dosyası, Node.js projelerinizde kritik bir rol oynar. Bu dosya, projenizin meta verilerini saklar, bağımlılıklarını yönetir ve npm CLI ile etkileşimde bulunmanıza olanak tanır. Bu rehberde, package.json dosyasının ne olduğunu, neden önemli olduğunu ve nasıl oluşturulacağını detaylı bir şekilde ele aldık. Bundan sonraki adım, npm registry'den bir paketin nasıl yükleneceğini öğrenmektir. Bu bilgileri kullanarak, Node.js projelerinizde package.json dosyasını etkili bir şekilde kullanabilirsiniz.