package.json作用

來源:互聯網
上載者:User

標籤:pen   文本   modules   .json   最新   ...   1.2   conf   image   

這個文檔的內容是你必須要知道的,它必須是JSON文字格式設定。每個項目的根目錄下面,一般都有一個package.json檔案,定義了這個項目所需要的各種模組,以及項目的配置資訊(比如名稱、版本、許可證等中繼資料)。npm install命令根據這個設定檔,自動下載所需的模組,也就是設定項目所需的運行和開發環境。

name和version 屬性

    這個屬性是必須的,定義項目的名稱和項目的版本號碼(遵守“大版本.次要版本.小版本”的格式)。如果沒有name屬性和version屬性,那這個包將不能進行安裝。name和version保證了包的唯一性。

    注意:

  1.   name 長度不超過240位元組;
  2.   name不能以圓點和底線開頭;
  3.   name只能是小寫;

   小技巧:

  1.  不能是已經有的包名稱 (查看npm註冊表,是否存在這個名稱) ;
  2.  在name中不能帶有js或node;
  3.  盡量簡短;  
dependencies 屬性

   dependencies屬性指定了項目運行所依賴的模組,devDependencies指定項目開發所需要的模組。它們都指向一個對象。該對象的各個成員,分別由模組名和對應的版本要求組成,表示依賴的模組及其版本範圍。

        對應的版本可以加上各種限定,主要有以下幾種:

  • 1. 指定版本:比如1.2.2,遵循“大版本.次要版本.小版本”的格式規定,安裝時只安裝指定版本。
    2. 大於(>),大於等於(>=),小於(<),小於等於(<=):必須是大於(大於等於,小於,小於等於)某個版本,也可以同時使用(>=version1 <=version2)。
    3. 星號(*):任何版本。
    4. git版本(git...):可以使用git URL來進行版本依賴。5. 波浪號(tilde)+指定版本:比如~1.2.2,表示安裝1.2.x的最新版本(不低於1.2.2),但是不安裝1.3.x,也就是說安裝時不改變大版本號碼和次要版本號碼。6. 插入號(caret)+指定版本:比如?1.2.2,表示安裝1.x.x的最新版本(不低於1.2.2),但是不安裝2.x.x,也就是說安裝時不改變大版本號碼。需要注意的是,如果大版本號碼為0,則插入號的行為與波浪號相同,這是因為此時處於開發階段,即使是次要版本號碼變動,也可能帶來程式的不相容。7. latest:安裝最新版本。
   例子:

     

package.json檔案可以手工編寫,也可以使用npm init命令自動產生。

$ npm init

這個命令採用互動方式,要求使用者回答一些問題,然後在目前的目錄產生一個基本的package.json檔案。所有問題之中,只有項目名稱(name)和項目版本(version)是必填的,其他都是選填的。

有了package.json檔案,直接使用npm install命令,就會在目前的目錄中安裝所需要的模組。

$ npm install

如果一個模組不在package.json檔案之中,可以單獨安裝這個模組,並使用相應的參數,將其寫入package.json檔案之中。

$ npm install express --save$ npm install express --save-dev

上面代碼錶示單獨安裝express模組,--save參數表示將該模組寫入dependencies屬性,--save-dev表示將該模組寫入devDependencies屬性。

description 屬性

description屬性是對項目進行描述,協助使用者發現你的項目。

license 屬性

license屬性是表述你項目發布遵循什麼樣的規則,使用者擁有那些許可權。

{ "license" : "BSD-3-Clause" }

author 屬性

author 屬性指明了項目的發行者。

ahthor:“張三”
contributions 屬性

 contributions 屬性指明了項目的貢獻者。

"contributors":[{"name":"李四","email":"[email protected]"}],
scripts屬性

scripts指定了運行指令碼命令的npm命令列縮寫,比如start指定了運行npm run start時,所要執行的命令。

下面的設定指定了npm run preinstallnpm run postinstallnpm run startnpm run test時,所要執行的命令。

"scripts": {    "preinstall": "echo here it comes!",    "postinstall": "echo there it goes!",    "start": "node index.js",    "test": "tap test/*.js"}
peerDependencies屬性

 

有時,你的項目和所依賴的模組,都會同時依賴另一個模組,但是所依賴的版本不一樣。比如,你的項目依賴A模組和B模組的1.0版,而A模組本身又依賴B模組的2.0版。

大多數情況下,這不構成問題,B模組的兩個版本可以並存,同時運行。但是,有一種情況,會出現問題,就是這種依賴關係將暴露給使用者。

最典型的情境就是外掛程式,比如A模組是B模組的外掛程式。使用者安裝的B模組是1.0版本,但是A外掛程式只能和2.0版本的B模組一起使用。這時,使用者要是將1.0版本的B的執行個體傳給A,就會出現問題。因此,需要一種機制,在模板安裝的時候提醒使用者,如果A和B一起安裝,那麼B必須是2.0模組。

peerDependencies欄位,就是用來供外掛程式指定其所需要的主工具的版本。

{  "name": "chai-as-promised",  "peerDependencies": {    "chai": "1.x"  }}

上面代碼指定,安裝chai-as-promised模組時,主程式chai必須一起安裝,而且chai的版本必須是1.x。如果你的項目指定的依賴是chai的2.0版本,就會報錯。

注意,從npm 3.0版開始,peerDependencies不再會預設安裝了。

bin屬性

bin項用來指定各個內部命令對應的可執行檔的位置。

"bin": {  "someTool": "./bin/someTool.js"}

上面代碼指定,someTool 命令對應的可執行檔為 bin 子目錄下的 someTool.js。Npm會尋找這個檔案,在node_modules/.bin/目錄下建立符號連結。在上面的例子中,someTool.js會建立符號連結npm_modules/.bin/someTool。由於node_modules/.bin/目錄會在運行時加入系統的PATH變數,因此在運行npm時,就可以不帶路徑,直接通過命令來調用這些指令碼。

main屬性

main欄位指定了載入的入口檔案,require(‘moduleName‘)就會載入這個檔案。這個欄位的預設值是模組根目錄下面的index.js

config 屬性

config屬性用於添加命令列的環境變數。

下面是一個package.json檔案。

{  "name" : "foo",  "config" : { "port" : "8080" },  "scripts" : { "start" : "node server.js" }}

然後,在server.js指令碼就可以引用config欄位的值。

http  .createServer(...)  .listen(process.env.npm_package_config_port)

使用者執行npm run start命令時,這個指令碼就可以得到值。

$ npm run start

使用者可以改變這個值。

$ npm config set foo:port 80
engines 屬性

engines欄位指明了該模組啟動並執行平台,比如 Node 的某個版本或者瀏覽器。

"engines": {"node": "0.10.x"},
repository 屬性

repository屬性指明了你的倉庫位置,協助使用者去迭代你的項目。

例如:

"repository" :{"type" : "git" ,"url" : "https://github.com/npm/npm.git"}

 

package.json作用

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.