簡介
本文檔有所有package.json中必要的配置。它必須是真正的json,而不是js對象。
本文檔中描述的很多行為都受npm-config(7)的影響。
默認值
npm會根據包內容設置一些默認值。
"scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}
如果包的根目錄有wscript文件,npm會默認將preinstall命令用node-waf進行編譯。
"scripts":{"preinstall": "node-gyp rebuild"}
如果包的根目錄有binding.gyp文件,npm會默認將preinstall命令用node-gyp進行編譯。
"contributors": [...]
如果包的根目錄有AUTHORS文件,npm會默認逐行按Name <email> (url)格式處理,郵箱和url是可選的。#號和空格開頭的行會被忽略。
name
在package.json中最重要的就是name和version字段。他們都是必須的,如果沒有就無法install。name和version一起組成的標識在假設中是唯一的。改變包應該同時改變version。
name是這個東西的名字。注意:
1.不要把node或者js放在名字中。因為你寫了package.json它就被假定成為了js,不過你可以用”engine”字段指定一個引擎(見后文)。
2.這個名字會作為在URL的一部分、命令行的參數或者文件夾的名字。任何non-url-safe的字符都是不能用的。
3.這個名字可能會作為參數被傳入require(),所以它應該比較短,但也要意義清晰。
4.在你愛上你的名字之前,你可能要去npm registry查看一下這個名字是否已經被使用了。http://registry.npmjs.org/
version
在package.json中最重要的就是name和version字段。他們都是必須的,如果沒有就無法install。name和version一起組成的標識在假設中是唯一的。改變包應該同時改變version。
version必須能被node-semver解析,它被包在npm的依賴中。(要自己用可以執行npm install semver)
可用的“數字”或者“范圍”見semver(7).
description
放簡介,字符串。方便 主站蜘蛛池模板: 承德县| 阳江市| 庆城县| 肥西县| 云霄县| 固始县| 大悟县| 呼玛县| 泸水县| 兴仁县| 万年县| 汉沽区| 华阴市| 益阳市| 米易县| 佳木斯市| 河池市| 长垣县| 永胜县| 绥滨县| 山西省| 镇坪县| 繁峙县| 黎平县| 蕉岭县| 梨树县| 渝北区| 隆子县| 南昌县| 托里县| 涟源市| 怀集县| 永春县| 芦溪县| 金山区| 蛟河市| 饶阳县| 任丘市| 方山县| 永济市| 靖江市|