Bir paket oluşturma

Bir paket bazı kodlarla rehberlik eden ve package.json dosyasına Yarn paketiniz hakkında bilgi sağlayan bir dizindir.

Çoğu paket bir tür sürüm kontrol sistemi kullanır. En yaygın olanlardan biri git ama Yarn hangisini kullanmayı seçtiğinizi umursamaz. Bu rehber için, bizim örneklerimiz git kullanılacak.

Not: Eğer bu rehberle devam etmek isterseniz, öncelikle yüklediğinizden git ve Yarn emin olun.

İlk paketinizi oluşturma

İlk paketinizi oluşturmak için sisteminizde terminalinizi/konsolunuzu açın ve aşağıdaki komutları takip edin:

git init my-new-project
cd my-new-project
yarn init

Bu, yeni bir git deposu oluşturacak, bunların içine koyun, sonra aşağıdaki sorularla yeni bir yarn projesi oluşturmak için etkileşimli bir form açın:

name (my-new-project):
version (1.0.0):
description:
entry point (index.js):
git repository:
author:
license (MIT):

Bunların her birisi için cevap yazabilir, sadece giriş yapıp/geri dönerek varsayılanı kullanabilir ya da boş bırakabilirsiniz.

İpucu Eğer varsayılanları her şey için kullanmak isterseniz şunları da çalıştırabilirsiniz yarn init --yes ve bu bütün soruları arlayacaktır.

package.json

Şimdi şuna benzer bir package.json ‘a sahip olmalısınız:

{
  "name": "my-new-project",
  "version": "1.0.0",
  "description": "My New Project description.",
  "main": "index.js",
  "repository": {
    "url": "https://example.com/your-username/my-new-project",
    "type": "git"
  },
  "author": "Your Name <you@example.com>",
  "license": "MIT"
}

package.json içinde gördüğünüz alanların anlamları aşağıdaki gibidir:

  • İsim paketinizin kimliğidir. Eğer genel/küresel bir kayıt olarak yayınlamak istiyorsanız paketinizin isminin eşsiz olduğundan emin olun.
  • Versiyon paketinizin semver-uyumlu halidir. İstediğiniz kadar paket yayınlayabilirsiniz ama yayınladıklarınız paketin yeni versiyonu olmalıdır.
  • Tanım tercihi bir alandır ama diğer Yarn kullanıcılarının yaptığı aramalar için ve paketinizin anlaşılması için tavsiye edilen bir alandır.
  • ana Node.js gibi programlar tarafından kullanılan kodunuzun giriş noktasını tanımlamak için kullanılır. Eğer belirtilmezse varsayılan olarak index.js olacaktır.
  • Depo de tercihi bir alandır ama paket kullanıcılarınızın katkıda bulunmak için kaynak kodunu bulmalarına yardım eder.
  • Yazar paketi oluşturan ve geliştirendir. Şu şekildedir: "İsminiz<you@example.com> (http://sizin-websiteniz.com)"
  • Lisans paketinizin yayınlayan yasal şartlarını ve paketinizdeki kodların izin verilen kullanımlarını içerir.

yarn init ‘i çalıştırdığınızda, yaptığı şey yenibir dosya oluşturmaktır. Arka planda hiçbir şey gerçekleşmez. Bu dosyayı istediğiniz kadar düzenlemekten çekinmeyin.

Ek alanlar

Eklemek isteyebileceğiniz bazı ek package.json alanlarını inceleyelim.


{
  "isim": "benim yeni proje",
  "...": "...",
  "keywords": ["cool", "useful", "stuff"],
  "ana sayfa": "https://my-new-project-website.com",
  "böcek": "https://github.com/you/my-new-project/issues",
  "katkıda bulunanlar": [
    "Arkadaşınız <their-email@example.com> (http://their-website.com)",
    "Başka Bir Arkadaşım <another-email@example.com> (https://another-website.org)"
  ],
  "files": ["index.js", "lib / *. js", "bin / *. js"],
  "çöp Kutusu": {
    "yeni-proje-cli": "bin / yeni-proje-cli.js"
  }
}
  • Anahtar Kelimeler diğer geliştiricilerin paketinizi ya da alakalı paketleri bulabillecekleri terimlerin listesidir.
  • Ana Sayfa kullanıcıları paketteki tanıtımı, belgelemeyi ve ek kaynaklar için olan bağlantıları içeren bir web sitesine yönlendiren bir url’dir/internet adresidir.
  • Hatalar paket kullanıcılarınızın paketinizde bir sorun keşfetmeleri halinde yönlendirilecekleri Url’dir.
  • Katkıda Bulunanlar paketinize katkı yapan kişilerin listesidir. Eğer projenize dahil olan başkaları da varsa onları burada belirtebilirsiniz.
  • dosyalar yayınlandığında ve yüklendiğinde paketinizde bulunması gereken dosyaların bir listesidir. Eğer belirtilmemişse Yarn her dosyayı içerecektir.
  • bin yüklendiği zaman paket oluşturulurken Yarn için cli komutlarının (ikililerin) haritalandırılmasıdır.

Tüm package.json alanlarının tam listesi ve yukarıdaki alanların her biri hakkında daha fazla ayrıntı için lütfen package.json dökümantasyon ‘a bakınız.

Lisans ve açık kaynak

Yarn paketleri genellikle açık kaynak olarak önerilir, bununla birlikte kaynakları basitçe yayınlamak onları doğal olarak açık kaynaklı yapmaz bunu not etmeniz önemlidir.

Kodun açık kaynak olabilmesi için açık kaynaklı bir lisansa sahip olması gerekir. İçlerinden seçim yapabileceğiniz birçok açık kaynak lisansı vardır, ortak olanlardan birkaçı burada:

Eğer daha çok seçenek istiyorsanız, Daha Büyük Bir Liste kısmından edinebilirsiniz.

Paketiniz için bir açık kaynak lisansı seçtiğinizde, paketinizin köküne lisans metni ve güncelleme package.json lisans alanı ile birlikte bir LİSANS dosyası eklediğinizden emin olun.

Not: Eğer projenizin lisanslanmasını istemiyorsanız açık kaynak projesi olarak, lisansın ne olduğu konusunda açık olmalısın veya lisanssız olması konusunda.

Kod paylaşımı

Muhtemelen paketinizin kullanıcılarına kaynak kodunuza erişebilme ve sorunları bildirmenin bir yolunu bulmalarını isteyeceksiniz. Kodunuzu saklaması için birkaç popüler internet sitesi var:

Bu site, kullanıcıların kodunuzu görüntülemesine, sorunları bildirmesine ve geri katkıda bulunmasına izin verecek. Kodunuzu bir yere yazdıktan sonra aşağıdaki alanları package.json‘a eklemelisiniz:

{
  "homepage": "https://github.com/username/my-new-project",
  "bugs": "https://github.com/username/my-new-project/issues",
  "repository": {
    "url": "https://github.com/username/my-new-project",
    "type": "git"
  }
}

Dökümantasyon

Paketinizi yayınlamadan önce en uygun şekilde belgelerinizi yazmalısınız. En azından, projenizin kök dizinine paketinizi ve genel API belgelerini tanıtan bir README.md dosyası yazmalısınız.

İyi dökümantasyon kullanıcılara sizin projenizle başlamaları ve devam ettirmeleri için ihtiyaç duyacakları tüm bilgileri tanımlanır. Projeniz hakkında hiçbir şey bilmeyen birinin sorularını düşünün. Her şeyi doğru ve gerektiği kadar detaylı olarak tanımlayın, aynı zamanda kısa tutmaya çalışın ve okunması kolay olsun. Yüksek kalitede dökümantasyona sahip projelerin başarısı daha fazladır.

Paketleri küçük tutmak

Yarn paketlerini oluştururken onları küçük ve basit tutmanız önerilir. Eğer bunu yapmak mantıklı geliyorsa büyük paketleri birçok küçük pakete ayırın. Yarn yüzlerce hatta binlerce paketi verimli bir şekilde kurabilme kapasitesine sahip olduğu için bunu yapmanız teşvik edilmektedir.

Birçok küçük paket mükemmel bir paket yönetim modelidir. Genellikle bu daha küçük indirme boyutlarına sebep olur çünkü büyük bağımlılıkları paketlemiyor ve yalnızca bunun küçük bir parçasını kullanıyorsunuz.

Ayrıca paketinizin içeriğini de dikkate almalısınız. Testlerinizi veya paketinizi kullanmak için gerekli olmayan diğer dosyaları (oluşturulan komut dosyaları, resimler vb.) yanlışlıkla dağıtmadığınızdan emin olun.

Ayrıca bağlantılı olduğunuz paketlere dikkat edin, iyi bir sebebiniz olmadıkça küçük bağımlılıkları tercih edin. Yanlışlıkla büyük bir şeye bağlantılı olmadığınızdan emin olun.