Npm?Module作用及使用一文全解

更新時間：2023年11月09日 14:06:26 作者：程序員海軍

這篇文章主要介紹了Npm?Module作用及使用一文全解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

packge.json

一個 package.json 包括：

列出項目所依賴的包
指定項目可以使用語義版本控制規(guī)則使用的包版本
使您的構(gòu)建可重現(xiàn)，因此更容易與其他開發(fā)人員共享

包SEO：可以加一個 description ，別人可以在npm 網(wǎng)站更好的查找你的npm Module

package 必填字段

name version

package.json 文件必須包含“"name"”和"version"字段。

"name"字段包含包的名稱，必須為小寫和一個單詞，并且可以包含連字符和下劃線。

"version"字段必須采用 x.x.x 格式，并遵循語義版本控制準(zhǔn)則.

author

作者字段，作者信息用電子郵件和網(wǎng)站，它是可選的

{
  "name": "npm-demo",
  "version": "1.0.0",
  "author": "123456@qq.com",
  "description": "NPM Test Module",
  "main": "index.js",
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1"
  },
  "keywords": [],
  "license": "ISC"
}

創(chuàng)建 package.json

要創(chuàng)建 package.json 文件，請在命令行上，在 Node.js 模塊的根目錄中運行 npm init:

對于作用域模塊，運行 npm init --scope=@scope-name
對于無作用域模塊，運行 npm init

為必填字段（nameversion）以及main字段提供響應(yīng)：

- name：模塊的名稱。
- 版本：初始模塊version。我們建議遵循語義版本控制準(zhǔn)則并從 1.0.0 開始.

npm init 
npm init --yes

init 配置選項

可以為 init 命令設(shè)置默認(rèn)配置選項。例如，若要設(shè)置默認(rèn)作者電子郵件、作者姓名和許可證，請在命令行上運行以下命令：

> npm set init-author-email "example-user@example.com"
> npm set init-author-name "example_user"
> npm set init-license "MIT"

創(chuàng)建 READ.md 包描述文件創(chuàng)建無作用域公共包

什么是無作用域公共包？

無作用域包始終是公共的，并且僅由包名稱引用，它可以供別人和它人直接使用在項目當(dāng)中。

創(chuàng)建無作用域的公共包

 npm init

發(fā)布無作用域公共包

npm publish

創(chuàng)建作用域包

在用戶或組織命名空間中公開共享代碼，可以將公共用戶范圍或組織范圍的包發(fā)布到 npm 注冊表。

npm init --scope=@my-org

my-org 替換成組織范圍或者用戶范圍的命名就可以

發(fā)布作用域包

npm publish --access public

Npm 包范圍、訪問級別和可見性

范圍	訪問級別	可以查看和下載	可以寫入（發(fā)布）
組織	私人	組織中對包具有讀取訪問權(quán)限的團(tuán)隊成員	組織中對包具有讀寫訪問權(quán)限的團(tuán)隊成員
組織	公共	每個人都	組織中對包具有讀寫訪問權(quán)限的團(tuán)隊成員
用戶	私人	包所有者和已被授予對包的讀取訪問權(quán)限的用戶	包所有者和已被授予對包的讀寫訪問權(quán)限的用戶
用戶	公共	每個人都	包所有者和已被授予對包的讀寫訪問權(quán)限的用戶
無作用域	公共	每個人都	包所有者和已被授予對包的讀寫訪問權(quán)限的用戶