paket.json

Penting

Dua bidang yang paling penting di ` package.json </ 0> Anda adalah nama </ 0> dan versi </ 0> , tanpa mereka paket Anda tidak akan dapat diinstal. Bidang nama </ 0> dan versi </ 0> digunakan bersamaan untuk membuat id unik.</p>

nama </ 0> </h3>
{
   "name": "my-awesome-package"}
`</pre> 

Ini adalah nama paket anda. Ini akan digunakan di URL, sebagai argumen pada baris perintah, dan sebagai nama direktori di dalam ` node_modules </ 0> .</p>

yarn menambahkan [nama]
`</pre> 

    node_modules / [nama]
    

    https://registry.npmjs.org/ [name] / - / [name] - [version] .tgz
    

**Aturan**

* Harus kurang dari atau sama dengan 214 karakter (termasuk ` @ scope / </ 0> untuk paket scoped).</li>
  • Tidak boleh dimulai dengan titik ( . </ 0> ) atau garis bawah ( _ </ 0> ).</li>
  • Tidak boleh memiliki huruf besar dalam nama.
  • Harus hanya menggunakan karakter URL-safe.
  • </ul>

    Tips

    • Jangan gunakan nama yang sama dengan modul inti Node.js
    • Jangan menaruh js </ 0> atau simpul </ 0> pada namanya.</li>
    • Simpan nama pendek dan deskriptif. Anda ingin orang mengerti apa itu dari namanya, tapi juga akan digunakan dalam panggilan require () </ 0> .</li>
    • Pastikan tidak ada sesuatu di registry </ 0> dengan nama yang sama.</li> </ul>

      versi </ 0> </h3>
      {
         "version": "1.0.0"}
      `</pre> 
          Versi paket Anda saat ini.
          
          ## Info 
          
          ### ` deskripsi </ 0> </h3>
      
      
      {
         "description": "Deskripsi singkat saya tentang paket mengagumkan saya"}
      `</pre> 
          
          Deskripsinya hanyalah sebuah string yang membantu orang memahami tujuan dari paket. Ini bisa digunakan saat mencari paket di package manager juga.
          
          ### ` kata kunci </ 0> </h3>
      
      
      {
         "keywords": ["short", "relevant", "keywords", "for", "searching"]}
      `</pre> 
          
          Kata kunci adalah rangkaian string yang berguna saat mencari paket di manajer paket.
          
          ### ` lisensi </ 0> </h3>
      
      
      {
        "license": "MIT",
        "license": "(MIT or GPL-3.0)",
        "license": "SEE LICENSE IN LICENSE_FILENAME.txt",
        "license": "UNLICENSED"
      }
      `</pre> 
          
          Semua paket harus menentukan lisensi sehingga pengguna tahu bagaimana mereka diizinkan untuk menggunakannya dan batasan yang Anda gunakan di dalamnya.
          
          Anda dianjurkan untuk menggunakan lisensi Open Source (  OSI-disetujui </ 0> ) kecuali Anda memiliki alasan khusus untuk tidak melakukannya. Jika Anda membuat paket Anda sebagai bagian dari pekerjaan Anda kemungkinan besar Anda harus memeriksa perusahaan Anda sebelum memutuskan lisensi.</p> 
          
          **Harus menjadi salah satu dari berikut ini:**
          
          * Sebuah valid  identifier lisensi SPDX </ 0> jika Anda menggunakan lisensi standar.</li> 
              
              * Ekspresi ekspresi ekspresi valid  SPDX yang valid < / 0> jika Anda menggunakan beberapa lisensi standar.</li> 
                  
                  * A ` LIHAT LICENSE  </ 0> string yang menunjuk ke ` di tingkat atas paket Anda jika Anda menggunakan lisensi non-standar.
                  * Sebuah ` tanpa izin </ 0> string jika Anda tidak ingin memberikan orang lain hak untuk menggunakan paket pribadi atau tidak diterbitkan di bawah istilah.</li>
      </ul>
      
      

      Tautan

      Berbagai link ke dokumentasi, tempat untuk mengajukan masalah dan di mana kode paket Anda benar-benar hidup.

      beranda </ 0> </h3>
      {
         "homepage": "https://your-package.org"}
      `</pre> 
                      Beranda adalah URL ke halaman arahan atau dokumentasi untuk paket Anda.
                      
                      ### ` bug </ 0> </h3>
      
      
      {
         "bug": "https://github.com/user/repo/issues"}
      `</pre> 
                      
                      URL pelacak isu proyek Anda. Ini juga bisa seperti alamat email juga. Ini memberi pengguna cara untuk mencari tahu di mana mengirim masalah dengan paket Anda.
                      
                      ### ` repositori </ 0> </h3>
      
      
      {
         "repositori": {"type": "git", "url": "https://github.com/user/repo.git"},
         "repository": "github: user / repo",
         "repository" : "gitlab: user / repo",
         "repository": "bitbucket: user / repo",
         "repository": "gist: a1b2c3d4e5f"}
      `</pre> 
                      
                      Repositori adalah lokasi dimana kode aktual untuk paket Anda tinggal.
                      
                      ## Pemelihara 
                      
                      Pemelihara proyek Anda.
                      
                      ### ` penulis </ 0> </h3>
      
      
      {
        "author": {
          "name": "Your Name",
          "email": "you@example.com",
          "url": "http://your-website.com"
        },
        "author": "Your Name <you@example.com> (http://your-website.com)"
      }
      `</pre> 
                      
                      Informasi penulis paket Seorang penulis adalah satu orang.
                      
                      ### ` kontributor </ 0> </h3>
      
      
      {
         "kontributor": [
           {"nama": "Teman Anda", "email": "friend@example.com", "url": "http://friends-website.com"}
           {"name": " Teman Lain "," email ":" other@example.com "," url ":" http://other-website.com "}
         ],
         " kontributor ": [
           " Teman Anda <friend@example.com> (http: // friends-website.com) ",
           " Teman Lain <other@example.com> (http://other-website.com) "
         ]}
      `</pre> 
                      
                      Mereka yang telah berkontribusi pada paket Anda. Kontributor adalah kumpulan orang.
                      
                      ## File 
                      
                      Anda dapat menentukan file yang akan disertakan dalam proyek Anda, beserta titik masuk utama proyek Anda.
                      
                      ### ` file </ 0> </h3>
      
      
      {
        "files": ["filename.js", "directory/", "glob/*.{js,json}"]
      }
      `</pre> 
                      
                      Ini adalah file yang disertakan dalam proyek Anda. Anda dapat menentukan file tunggal, keseluruhan direktori atau menggunakan wildcard untuk menyertakan file yang memenuhi kriteria tertentu.
                      
                      ### ` utama </ 0> </h3>
      
      
      {
         "main": "filename.js"}
      `</pre> 
                      
                      Ini adalah titik masuk utama untuk fungsionalitas proyek Anda.
                      
                      ### ` bin </ 0> </h3>
      
      
      {
        "bin": "bin.js",
        "bin": {
          "command-name": "bin/command-name.js",
          "other-command": "bin/other-command"
        }
      }
      `</pre> 
                      
                      File executable disertakan dengan proyek Anda yang akan diinstal.
                      
                      ### ` man </ 0> </h3>
      
      
      {
         "man": "./man/doc.1",
         "man": ["./man/doc.1", "./man/doc.2"]}
      `</pre> 
                      
                      Jika Anda memiliki halaman manual yang terkait dengan proyek Anda, tambahkan di sini.
                      
                      ### ` direktori </ 0> </h3>
      
      
      {
         "directories": {
           "lib": "path / to / lib /",
           "bin": "path / to / bin /",
           "man": "path / to / man /",
           "doc": " path / to / doc / ",
           " example ":" path / to / example / "
         }}
      `</pre> 
                      
                      Saat menginstal paket Anda, Anda dapat menentukan lokasi yang tepat untuk memasukkan file biner, halaman manual, dokumentasi, contoh, dll.
                      
                      ## Tugas 
                      
                      Paket Anda bisa termasuk skrip runnable atau konfigurasi lainnya.
                      
                      ### ` skrip </ 0> </h3>
      
      
      {
         "skrip": {
           "build-project": "node build-project.js"
         }}
      `</pre> 
                      
                      Script adalah cara yang bagus untuk mengotomatisasi tugas yang terkait dengan paket Anda, seperti proses pembuatan atau pengembangan sederhana. Dengan menggunakan bidang ` "skrip" </ 0> , Anda dapat menentukan berbagai skrip yang akan dijalankan seperti yarn