package.json是什么?_對package.json的理解和學習


package.json是什么?

npm安裝package.json時  直接轉到當前項目目錄下用命令npm install 或npm install --save-dev安裝即可,自動將package.json中的模塊安裝到node-modules文件夾下。

package.json就是管理你本地安裝的npm包,用於定義了這個項目所需要的各種模塊,以及項目的配置信息(比如名稱、版本、許可證等元數據)。一個package.json文件可以做如下事情: 

展示項目所依賴的npm包
允許你指定一個包的版本[范圍] 
讓你建立起穩定,意味着你可以更好的與其他開發者共享

注意:npm init 時,用戶需回答一些問題,然后在當前目錄生成一個基本的package.json文件。所有問題之中,只有項目名稱(name)和項目版本(version)是必填的,其他都是選填的。

 

package.json字段說明

1、name

包的名稱,必須是唯一的,由小寫英文字母、數字和下划線組成,不能包含空格 

 2、version

項目版本號,符合語義化版本識別規范的版本字符串  

3、description

項目描述,項目的簡要說明 

4、keywords

{Array}關鍵詞數組,便於用戶搜索到我們的項目。

5、homepage

用於定義項目url主頁

6、bugs

提交bug的地址,項目問題反饋的Url或email配置,如:  

{ 
“url” : “https://github.com/issues“, 
“email” : “project@hostname.com” 
}

  

7、license

項目許可證,讓使用者知道是如何被允許使用此項目。默認是”ISC”  

8、author

定義該項目的作者。

9、private

代表npm是否發布該項目。如果設置為true, 那么npm會拒絕發布它

10、scripts

指定了運行腳本命令的npm命令行縮寫,比如start指定了運行npm run start時,所要執行的命令。下面的設置指定了npm run dev、npm run bulid、npm run unit、npm run test、npm run lint時,所要執行的命令。如下:

"scripts": {
    "dev": "node build/dev-server.js",
    "build": "node build/build.js",
    "unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
    "test": "npm run unit",
    "lint": "eslint --ext .js,.vue src test/unit/specs"
  },

  

11、dependencies,devDependencies

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

--save參數表示將該模塊寫入dependencies屬性,
--save-dev表示將該模塊寫入devDependencies屬性。

如下:

"dependencies": {
    "vue": "^2.2.2",
    "vue-router": "^2.2.0"
  },
  "devDependencies": {
    "autoprefixer": "^6.7.2",
    "babel-core": "^6.22.1",
    "babel-eslint": "^7.1.1",
    "babel-loader": "^6.2.10",
    "babel-plugin-transform-runtime": "^6.22.0",
    "babel-preset-env": "^1.2.1",
    "babel-preset-stage-2": "^6.22.0",
    "babel-register": "^6.22.0",
    "chalk": "^1.1.3",
}

  

12、config

config字段用於向環境變量輸出值。  

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

pixabayhttps://www.wode007.com/sites/73237.html wallhavenhttps://www.wode007.com/sites/73236.html

13、engines

指明了該項目所需要的node.js版本 

"engines": {
   "node": ">= 4.0.0",
   "npm": ">= 3.0.0"
 },

  

14、bin

許多包有一個或多個可執行文件希望被安裝到系統路徑。在npm下要這么做非常容易(事實上,npm就是這么運行的)。

這需要在你的package.json中提供一個bin字段,它是一個命令名和本地文件名的映射。在安裝時,如果是全局安裝,npm將會使用符號鏈接把這些文件鏈接到prefix/bin,如果是本地安裝,會鏈接到./node_modules/.bin/。

比如,要使用myapp作為命令時可以這么做:

{ "bin" : { "myapp" : "./cli.js" } }

  

這么一來,當你安裝myapp,npm會從cli.js文件創建一個到/usr/local/bin/myapp的符號鏈接(這使你可以直接在命令行執行myapp)。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM