hati-hati jangan gunakan package.json untuk nama folder jika Anda ingin mengkloning proyek ini ke mesin Anda - itu akan merusak yarn ( An unexpected error occurred: "EISDIR: illegal operation on a directory, read". ).
Versi asli dokumen ini disalin dari benangpkg.
Lihat juga dokumentasi npm, std-pkg, clean-publish, package-json-validator, cosmiconfig, rc (sebagai pendekatan lawan cosmiconfig).
nameversiondescriptionkeywordslicensehomepagebugsrepositoryauthorcontributorsfilesmainbinmandirectoriesscriptsscripts khusus npmconfigdependenciesdevDependenciespeerDependenciesoptionalDependenciesbundledDependenciesenginesoscpulibcprivatepublishConfigflatresolutionsworkspacesboltunpkgtypesflow:mainbrowserslistmodulebrowseresnextes2015esmmodule-browsermodules.rootjsnext:mainreact-nativesideEffectssource , umd:mainsource@std/esmjspmignoreformatregistryshimmapbrowserify.transformproxyhomepagebabeleslintConfigjeststylelintsize-limitpwmetricsavanycpreferGlobalstylelessstandard Dua bidang terpenting di package.json Anda adalah name dan version , tanpanya paket Anda tidak akan dapat diinstal. Bidang name dan version digunakan bersama untuk membuat id unik.
name{
"name" : " my-awesome-package "
} Ini adalah nama paket Anda. Itu digunakan dalam URL, sebagai argumen pada baris perintah, dan sebagai nama direktori di dalam node_modules .
yarn add [name] node_modules/[name]
https://registry.npmjs.org/[name]/-/[name]-[version].tgz
Aturan
@scope/ untuk paket tercakup).. ) atau garis bawah ( _ ).Kiat
js atau node pada namanya.require() .version{
"version" : " 1.0.0 "
}Versi paket Anda saat ini.
description{
"description" : " My short description of my awesome package "
}Deskripsi hanyalah sebuah string yang membantu orang memahami tujuan paket. Ini juga dapat digunakan ketika mencari paket di manajer paket.
keywords{
"keywords" : [ " short " , " relevant " , " keywords " , " for " , " searching " ]
}Kata kunci adalah serangkaian string yang berguna saat mencari paket di manajer paket.
license{
"license" : " MIT " ,
"license" : " (MIT or GPL-3.0) " ,
"license" : " SEE LICENSE IN LICENSE_FILENAME.txt " ,
"license" : " UNLICENSED "
}Semua paket harus menentukan lisensi sehingga pengguna mengetahui bagaimana mereka diizinkan untuk menggunakannya dan batasan apa pun yang Anda terapkan pada paket tersebut.
Anda dianjurkan untuk menggunakan lisensi Open Source (disetujui OSI) kecuali Anda mempunyai alasan khusus untuk tidak melakukannya. Jika Anda membuat paket sebagai bagian dari pekerjaan Anda, sebaiknya tanyakan kepada perusahaan Anda sebelum memutuskan lisensi.
Harus berupa salah satu dari berikut ini:
SEE LICENSE IN <filename> yang menunjuk ke <filename> di tingkat atas paket Anda jika Anda menggunakan lisensi non-standar.UNLICENSED jika Anda tidak ingin memberikan hak kepada orang lain untuk menggunakan paket pribadi atau yang tidak dipublikasikan berdasarkan persyaratan apa pun. Berbagai tautan ke dokumentasi, tempat untuk mengajukan masalah, dan tempat sebenarnya kode paket Anda berada.
homepage{
"homepage" : " https://your-package.org "
}Beranda adalah URL ke halaman arahan atau dokumentasi paket Anda.
Juga digunakan oleh Create React App
bugs{
"bugs" : " https://github.com/user/repo/issues "
}URL ke pelacak masalah proyek Anda. Ini juga bisa berupa alamat email. Ini memberi pengguna cara untuk mengetahui ke mana harus mengirim masalah dengan paket Anda.
repository{
"repository" : { "type" : " git " , "url" : " https://github.com/user/repo.git " },
"repository" : " github:user/repo " ,
"repository" : " gitlab:user/repo " ,
"repository" : " bitbucket:user/repo " ,
"repository" : " gist:a1b2c3d4e5f "
}Repositori adalah lokasi di mana kode sebenarnya untuk paket Anda berada.
Pengelola proyek Anda.
author{
"author" : { "name" : " Your Name " , "email" : " [email protected] " , "url" : " http://your-website.com " },
"author" : " Your Name <[email protected]> (http://your-website.com) "
}Informasi penulis paket. Seorang penulis adalah satu orang.
contributors{
"contributors" : [
{ "name" : " Your Friend " , "email" : " [email protected] " , "url" : " http://friends-website.com " }
{ "name" : " Other Friend " , "email" : " [email protected] " , "url" : " http://other-website.com " }
],
"contributors" : [
" Your Friend <[email protected]> (http://friends-website.com) " ,
" Other Friend <[email protected]> (http://other-website.com) "
]
}Mereka yang telah berkontribusi pada paket Anda. Kontributor adalah sekelompok orang.
Anda dapat menentukan file yang akan disertakan dalam proyek Anda, beserta titik masuk utama untuk proyek Anda.
files{
"files" : [
" filename.js " ,
" directory/ " ,
" glob/*.{js,json} "
]
}Ini adalah file yang disertakan dalam proyek Anda. Anda dapat menentukan file tunggal, seluruh direktori, atau menggunakan wildcard untuk menyertakan file yang memenuhi kriteria tertentu.
main{
"main" : " filename.js "
}Ini adalah titik masuk utama untuk fungsionalitas proyek Anda.
bin{
"bin" : " bin.js " ,
"bin" : {
"command-name" : " bin/command-name.js " ,
"other-command" : " bin/other-command "
}
}File yang dapat dieksekusi disertakan dengan proyek Anda yang akan diinstal.
man{
"man" : " ./man/doc.1 " ,
"man" : [ " ./man/doc.1 " , " ./man/doc.2 " ]
}Jika Anda memiliki halaman manual yang terkait dengan proyek Anda, tambahkan di sini.
directories{
"directories" : {
"lib" : " path/to/lib/ " ,
"bin" : " path/to/bin/ " ,
"man" : " path/to/man/ " ,
"doc" : " path/to/doc/ " ,
"example" : " path/to/example/ "
}
}Saat menginstal paket Anda, Anda dapat menentukan lokasi yang tepat untuk meletakkan file biner, halaman manual, dokumentasi, contoh, dll.
Paket Anda dapat menyertakan skrip yang dapat dijalankan atau konfigurasi lainnya.
scripts{
"scripts" : {
"build-project" : " node build-project.js "
}
} Skrip adalah cara terbaik untuk mengotomatiskan tugas-tugas yang terkait dengan paket Anda, seperti proses pembangunan sederhana atau alat pengembangan. Dengan menggunakan kolom "scripts" , Anda dapat menentukan berbagai skrip yang akan dijalankan sebagai yarn run <script> . Misalnya, skrip build-project di atas dapat dipanggil dengan yarn run build-project dan akan menjalankan node build-project.js .
Nama skrip tertentu bersifat istimewa. Jika ditentukan, skrip preinstall dipanggil oleh benang sebelum paket Anda diinstal. Untuk alasan kompatibilitas, skrip bernama install , postinstall , dan prepublish semuanya akan dipanggil setelah paket Anda selesai diinstal.
Nilai skrip start defaultnya adalah node server.js .
"scripts": {"start": "node server.js"}. Jika ada file server.js di root paket Anda, maka npm akan menetapkan perintah start secara default ke node server.js.
"scripts":{"preinstall": "node-gyp rebuild"}. Jika ada file binding.gyp di root paket Anda, npm akan mengatur perintah pra-instal secara default untuk dikompilasi menggunakan node-gyp.-- dokumen npm
scripts khusus npm npm mendukung properti scripts dari file package.json , untuk skrip berikut:
prepublish : Jalankan SEBELUM paket dikemas dan diterbitkan, serta pada instalasi npm lokal tanpa argumen apa pun. (Lihat di bawah)prepare : Jalankan SEBELUM paket dikemas dan diterbitkan, dan pada instalasi npm lokal tanpa argumen apa pun (Lihat di bawah). Ini dijalankan SETELAH pra-penerbitan, tetapi SEBELUM pra-penerbitan Saja.prepublishOnly : Jalankan SEBELUM paket disiapkan dan dikemas, HANYA di npmpublish. (Lihat di bawah.)prepack : dijalankan SEBELUM tarball dikemas (pada npm pack, npmpublish, dan saat menginstal dependensi git)postpack : Jalankan SETELAH tarball dibuat dan dipindahkan ke tujuan akhirnya.publish , postpublish : Jalankan SETELAH paket diterbitkan.preinstall : Jalankan SEBELUM paket diinstalinstall , postinstall : Jalankan SETELAH paket diinstal.preuninstall , uninstall : Jalankan SEBELUM paket di-uninstall.postuninstall : Jalankan SETELAH paket di-uninstall.preversion : Jalankan SEBELUM menabrak versi paket.version : Jalankan SETELAH menabrak versi paket, tetapi SEBELUM melakukan.postversion : Jalankan SETELAH menabrak versi paket, dan SETELAH komit.pretest , test , posttest : Dijalankan dengan perintah npm test.prestop , stop , poststop : Dijalankan dengan perintah npm stop.prestart , start , poststart : Dijalankan dengan perintah npm start.prerestart , restart , postrestart : Dijalankan dengan perintah npm restart. Catatan: npm restart akan menjalankan skrip stop dan start jika tidak ada skrip restart yang disediakan.preshrinkwrap , shrinkwrap , postshrinkwrap : Dijalankan dengan perintah npm shrinkwrap.Sumber: dokumen npm.
config{
"config" : {
"port" : " 8080 "
}
}Opsi konfigurasi atau parameter yang digunakan dalam skrip Anda.
Paket Anda kemungkinan besar akan bergantung pada paket lain. Anda dapat menentukan dependensi tersebut di file package.json Anda.
dependencies{
"dependencies" : {
"package-1" : " ^3.1.4 "
}
}Ini adalah dependensi yang diperlukan dalam pengembangan dan produksi paket Anda.
Anda dapat menentukan versi persisnya, versi minimum (misal,
>=) atau rentang versi (misal>= ... <).
devDependencies{
"devDependencies" : {
"package-2" : " ^0.4.2 "
}
}Ini adalah paket yang hanya diperlukan ketika mengembangkan paket Anda tetapi tidak akan diinstal dalam produksi.
peerDependencies{
"peerDependencies" : {
"package-3" : " ^2.7.18 "
}
}Ketergantungan rekan memungkinkan Anda menyatakan kompatibilitas paket Anda dengan versi paket lain.
optionalDependencies{
"optionalDependencies" : {
"package-5" : " ^1.6.1 "
}
}Dependensi opsional dapat digunakan dengan paket Anda, tetapi tidak diperlukan. Jika paket opsional tidak ditemukan, instalasi masih dilanjutkan.
bundledDependencies{
"bundledDependencies" : [
" package-4 "
]
}Dependensi yang dibundel adalah serangkaian nama paket yang akan digabungkan saat menerbitkan paket Anda.
Anda dapat memberikan informasi tingkat sistem yang terkait dengan paket Anda, seperti kompatibilitas sistem operasi, dll.
engines{
"engines" : {
"node" : " >=4.4.7 <7.0.0 " ,
"zlib" : " ^1.2.8 " ,
"yarn" : " ^0.14.0 "
}
} Mesin menentukan versi klien yang harus digunakan dengan paket Anda. Ini memeriksa process.versions serta versi benang saat ini.
os{
"os" : [ " darwin " , " linux " ],
"os" : [ " !win32 " ]
} Ini menentukan kompatibilitas sistem operasi untuk paket Anda. Ia memeriksa process.platform .
cpu{
"cpu" : [ " x64 " , " ia32 " ],
"cpu" : [ " !arm " , " !mips " ]
} Gunakan ini untuk menentukan paket Anda hanya akan berjalan pada arsitektur CPU tertentu. Ini memeriksa process.arch .
libc{
"libc" : [ " glibc " ],
"libc" : [ " musl " ]
} Gunakan ini untuk menentukan paket Anda hanya berjalan pada jenis libc tertentu. Ini memeriksa hasil dari detect-libc .
private{
"private" : true
} Jika Anda tidak ingin paket Anda dipublikasikan di manajer paket, setel ini ke true .
publishConfig{
"publishConfig" : {
...
}
}Nilai konfigurasi ini akan digunakan saat menerbitkan paket Anda. Anda dapat menandai paket Anda, misalnya.
flat{
"flat" : true
} Jika paket Anda hanya mengizinkan satu versi ketergantungan tertentu, dan Anda ingin menerapkan perilaku yang sama seperti yarn install --flat pada baris perintah, setel ini ke true .
Perhatikan bahwa jika package.json Anda berisi "flat": true dan paket lain bergantung pada paket Anda (misalnya, Anda sedang membangun perpustakaan, bukan aplikasi), paket lain tersebut juga memerlukan "flat": true di package.json atau menjadi diinstal dengan yarn install --flat pada baris perintah.
resolutions{
"resolutions" : {
"transitive-package-1" : " 0.0.29 " ,
"transitive-package-2" : " file:./local-forks/transitive-package-2 " ,
"dependencies-package-1/transitive-package-3" : " ^2.1.1 "
}
}Memungkinkan Anda mengganti versi ketergantungan bersarang tertentu. Lihat Resolusi Versi Selektif RFC untuk spesifikasi lengkap.
Perhatikan bahwa menginstal dependensi melalui [ yarn install --flat ] akan secara otomatis menambahkan blok resolutions ke file package.json Anda.
workspaces Jika --use-workspaces benar maka packages akan diganti dengan nilai dari package.json/workspaces .
Sumber: --use-workspaces.
boltLihat Konfigurasi
{
"bolt" : {
"workspaces" : [
" utils/* " ,
" apps/* "
]
}
}unpkg Jika Anda menghilangkan jalur file (yaitu menggunakan URL "kosong"), unpkg akan menyajikan file yang ditentukan oleh bidang unpkg di package.json , atau kembali ke main (sumber).
types Jika paket Anda memiliki file .js utama, Anda juga perlu menunjukkan file deklarasi utama di file package.json Anda. Atur properti types agar mengarah ke file deklarasi yang dibundel. Misalnya:
{
"main" : " ./lib/main.js " ,
"types" : " ./lib/main.d.ts "
} Perhatikan bahwa bidang typings identik dengan types , dan dapat digunakan juga.
Perhatikan juga bahwa jika file deklarasi utama Anda diberi nama index.d.ts dan berada di root paket (di sebelah index.js ), Anda tidak perlu menandai types , meskipun disarankan untuk melakukannya.
Sumber: dokumentasi TypeScript
Catatan: di Flow mereka menggunakan pendekatan yang berbeda
flow:mainTidak didukung secara resmi. Usulan ada di sini.
browserslist? Perpustakaan untuk berbagi browser target antara berbagai alat front-end. Ini digunakan di:
package.json atau file browserslist yang didukung di 2.0) Semua alat yang mengandalkan Browserslist akan menemukan konfigurasinya secara otomatis, ketika Anda menambahkan yang berikut ke package.json :
{
"browserslist" : [
" > 1% " ,
" last 2 versions "
]
}Sumber: daftar browser.
Lihat juga: Membuat Dukungan Aplikasi React.
Lihat "Menyiapkan paket npm multi-platform" untuk pengenalan.
module pkg.module akan menunjuk ke modul yang memiliki sintaks modul ES2015 tetapi sebaliknya hanya fitur sintaksis yang didukung oleh lingkungan target. Deskripsi lengkap ada di sini.
Didukung oleh: rollup, webpack
browser Bidang browser disediakan oleh pembuat modul sebagai petunjuk untuk bundler javascript atau alat komponen saat mengemas modul untuk penggunaan sisi klien. Usulan ada di sini.
Didukung oleh: rollup, webpack, browserify
Dukungan yang diminta: babel-plugin-module-resolver
esnextProposal lengkap ada di sini. Penjelasan singkat:
esnext : kode sumber yang menggunakan fitur tahap 4 (atau lebih lama), tidak ditranspilasi, dalam modul ES.main : menunjuk ke modul CommonJS (atau modul UMD) dengan JavaScript semodern yang saat ini dapat ditangani oleh Node.js.module harus dapat ditangani melalui esnext .browser dapat ditangani melalui versi esnext yang diperluas {
"main" : " main.js " ,
"esnext" : {
"main" : " main-esnext.js " ,
"browser" : " browser-specific-main-esnext.js "
}
}Lihat juga: Mengirimkan kode sumber yang belum ditranspilasi melalui npm
es2015Kode ES6 yang tidak ditranspilasi. Sumber: Format Paket Sudut (APF) v5.0
esmProposal ada di sini: proposal yang disesuaikan: modul ES "esm": flag package.json yang sebenarnya
Lihat juga:
module-browserLihat masalah ini
Juga disebut sebagai moduleBrowser , jsnext:browser .
modules.rootDisebutkan dalam Dalam Pertahanan .js.
Ada juga modules.resolver .
jsnext:mainTIDAK DIGUNAKAN lagi
jsnext:main telah digantikan oleh pkg.module , yang menunjukkan lokasi file dengan deklarasi impor/ekspor. Proposal asli ada di sini.
Didukung oleh: rollup.
react-native Bekerja mirip dengan browser , tetapi untuk modul spesifik react-native. Sumber.
sideEffectsMenunjukkan bahwa modul paket tidak memiliki efek samping (pada evaluasi) dan hanya mengekspos ekspor. Hal ini memungkinkan alat seperti webpack mengoptimalkan ekspor ulang.
Lihat juga: contoh sideEffects , proposal untuk menandai fungsi sebagai murni, eslint-plugin-tree-shaking.
source , umd:mainLihat Menentukan build di package.json.
sourceLihat paket-paket/paket#1652.
@std/esm Pengembang memiliki pendapat yang kuat tentang segala hal. Untuk mengakomodasi, @std/esm mengizinkan pembukaan fitur tambahan dengan kolom "@std/esm" atau "@std":{"esm":{}} di package.json Anda.
Sumber: @std/esm Tidak dapat dibuka
jspm Anda dapat menulis semua properti paket di dasar package.json, atau jika Anda tidak ingin mengubah properti yang ada yang ingin Anda gunakan khusus untuk npm , Anda dapat menulis konfigurasi khusus jspm di dalam properti jspm dari package.json, dan jspm akan menggunakan opsi ini pada opsi konfigurasi tingkat root.
Misalnya:
{
"name" : " my-package " ,
"jspm" : {
"main" : " jspm-main "
}
}Lihat spesifikasi lengkap.
ignoreJika ada file atau folder tertentu yang diabaikan, file atau folder tersebut dapat dicantumkan dalam array.
format Pilihannya adalah esm , amd , cjs dan global .
Saat memuat modul dari
npm, format modul diperlakukan sebagaicjssecara default dan tidak ada deteksi otomatis yang dijalankan. Untuk memuat modul dengan format lain, Anda perlu mengganti properti ini secara manual.
Format modul
esm(Modul ECMAScript) saat ini tidak digunakan di package.json.
registryjspm memahami ketergantungan dalam konteks registri.
Saat memuat paket dari npm, jspm akan menyetel registri default ke npm , dan memperlakukan dependensinya sesuai dengan itu.
Saat memuat paket dari GitHub, properti dependensi diabaikan tanpa adanya properti registri, karena jspm tidak memiliki cara untuk mengetahui apa arti dependensi untuk repo GitHub yang ada.
Mengatur properti registri juga menentukan bagaimana jspm menafsirkan paket. Misalnya, paket GitHub dengan registry: "npm" akan, bersama dengan mendapatkan dependensinya dari npm, akan ditafsirkan sebagai CommonJS dan fitur dukungan seperti direktori dan JSON memerlukannya, persis seperti jika paket tersebut telah diinstal dari titik akhir npm untuk memulai.
Sebuah paket di GitHub dengan properti registrinya disetel ke registry: "jspm" dependensinya akan diperlakukan sebagai dependensi gaya jspm.
shim Paket yang ditulis sebagai global memerlukan konfigurasi shim agar berfungsi dengan baik di lingkungan modular. Untuk memindahkan file some/global.js ke dalam paket, kita dapat menulis:
{
"shim" : {
"some/global" : {
"deps" : [ " jquery " ],
"exports" : " globalExportName "
}
}
} deps dan exports bersifat opsional.
exports terdeteksi secara otomatis oleh pemuat SystemJS seperti global apa pun yang ditulis oleh skrip. Dalam kebanyakan kasus, deteksi ini akan berhasil dengan benar.
Bentuk pintasan "some/global": ["jquery"] juga didukung jika tidak ada exports .
mapKonfigurasi peta akan menulis ulang kebutuhan internal untuk menunjuk ke modul lokal atau eksternal yang berbeda.
Pertimbangkan sebuah paket yang menyertakan ketergantungannya sendiri, dep terletak di third_party/dep . Itu bisa memiliki pernyataan require secara internal seperti:
require ( 'dep' ) ;Untuk menggunakan versi lokal, kita dapat menulis:
{
"map" : {
"dep" : " ./third_party/dep "
}
}Hal ini juga berguna untuk mereferensikan sebuah paket dengan namanya sendiri di dalam submodul:
{
"map" : {
"thispackage" : " . "
}
} Kami kemudian dapat memiliki persyaratan internal untuk import 'thispackage/module' dengan benar.
Konfigurasi peta juga dapat mereferensikan submodul ketergantungan.
Kita juga dapat mengecualikan seluruh modul dengan memetakannya ke modul yang kosong:
{
"map" : {
"jquery" : " @empty "
}
}Nilai yang dikembalikan akan menjadi objek Modul tanpa ekspor.
browserify.transformDokumentasi ada di sini
proxyOrang-orang sering kali menyajikan aplikasi React front-end dari host dan port yang sama dengan implementasi backend mereka.
Sumber: Proxy Permintaan API dalam Pengembangan
homepageSumber: Membangun Jalur Relatif
babelLihat masalah ini.
eslintConfigjest{
"jest" : {
"verbose" : true
}
}
Sumber: dokumen lelucon
stylelintLihat: Pemuat konfigurasi baru
size-limit Jika Anda menggunakan perpustakaan ini, Anda dapat menentukan konfigurasinya di package.json :
{
"size-limit" : [
{
"limit" : " 9 KB " ,
"path" : " index.js "
}
]
}Sumber: batas ukuran
pwmetrics Anda dapat menentukan opsi di package.json :
{
"pwmetrics" : {
"url" : " http://example.com/ " ,
"expectations" : {
"ttfcp" : {
"warn" : " >=1500 " ,
"error" : " >=2000 "
}
}
}
}Semua opsi yang tersedia ada di sini
Sumber: pwmetrics
avaContoh:
"ava" : {
"require" : [ " @std/esm " ]
}Sumber: ava
nycContoh:
"nyc" : {
"extension" : [ " .js " , " .mjs " ],
"require" : [ " @std/esm " ]
}Sumber: nyc
preferGlobalTIDAK DIGUNAKAN lagi
Opsi ini digunakan untuk memicu peringatan npm, tetapi tidak lagi memperingatkan. Itu murni untuk tujuan informasi. Sekarang disarankan agar Anda menginstal biner apa pun sebagai dependensi dev lokal jika memungkinkan.
style Atribut style di package.json berguna untuk mengimpor paket CSS. Usulan ada di sini.
Didukung oleh: parselify, npm-less, rework-npm, npm-css.
Lihat juga: spesifikasi istf.
less Sama seperti style tetapi lebih murah.
Didukung oleh: tanpa npm.
Bidang berikut dicadangkan untuk perluasan di masa mendatang: build , default , email , external , files , imports , maintainer , paths , platform , require , summary , test , using , downloads , uid .
Bidang berikut dicadangkan untuk digunakan oleh pendaftar paket sesuai kebijaksanaan mereka: id , type .
Semua properti yang dimulai dengan _ atau $ juga dicadangkan untuk pendaftar paket untuk menggunakan kebijaksanaan mereka.
Sumber: wiki CommonJS
standard JS standar adalah panduan gaya javaScript, linter, dan formatter, Anda dapat menambahkan beberapa properti ke package.json, seperti parser , ignore , globals , plugins .
Contoh:
"standard" : {
"parser" : " babel-eslint " ,
"ignore" : [
" **/out/ " ,
" /lib/select2/ " ,
" /lib/ckeditor/ " ,
" tmp.js "
]
}Lihat juga: JS Standar
