package.json簡介

文章目錄

• • 一、package.json簡介
  • 二、package.json屬性說明
  • 三、生成package.json文件
  • • 注意：

一、package.json簡介

什麼是Node.js的模塊（Module）？

在Node.js中，模塊是一個庫或框架，也是一個Node.js項目。Node.js項目遵循模塊化的架構，當咱們建立了一個Node.js項目，意味着建立了一個模塊，這個模塊的描述文件，被稱爲package.json。

一般狀況下若是 package.json內容出錯，會致使項目出現bug，甚至阻止項目的運行。

因此在修改該文件時候必定要當心，格式，名稱等是否正確

二、package.json屬性說明

• name - 包名.
• version - 包的版本號。
• description - 包的描述。
• homepage - 包的官網URL。
• author - 包的做者，它的值是你在https://npmjs.org網站的有效帳戶名，遵循「帳戶名<郵件>」的規則，例如：zhangsan zhangsan@163.com。
• contributors - 包的其餘貢獻者。
• dependencies / devDependencies - 生產/開發環境依賴包列表。它們將會被安裝在 node_module 目錄下。
• repository - 包代碼的Repo信息，包括type和URL，type能夠是git或svn，URL則是包的Repo地址。
• main - main 字段指定了程序的主入口文件，require(‘moduleName’) 就會加載這個文件。這個字段的默認值是模塊根目錄下面的 index.js。
• keywords - 關鍵字

上述參數是極爲常見的參數，另外還能夠設置script、license等等。除了官方必須的一些參數外，咱們也能夠存儲咱們本身的關於模塊的描述信息在package.json。

三、生成package.json文件

可使用npm生成package.json文件，它能夠包含最基本的設置以及結果。

例如：運行

npm init

This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg> --save` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
name: (node_modules) runoob                   # 模塊名
version: (1.0.0) 
description: Node.js 測試模塊(www.xxxxx.com)  # 描述
entry point: (index.js) 
test command: make test
git repository: https://github.com/xxxxx/xxxxx.git  # Github 地址
keywords: 
author: 
license: (ISC) 
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "runoob",
  "version": "1.0.0",
  "description": "Node.js 測試模塊(www.runoob.com)",
  ……		# 其餘參數
}

Is this ok? (yes)： yes

最後輸入yes

這樣就生成了一個最基本的package.json文件。

注意：

手動更改的時候要徹底遵循嚴格的JSON書寫格式，不然容易出現意想不到的簡單錯誤。