前言
在Node.js项目中,离不开NPM(node package manager)包管理工具,在Node.js中,模块是一个库或框架,也是一 个Node.js项目。Node.js项目遵循模块化的架构,当我们创建了一个Node.js项目,意味着创建了一个模块,这个模块的描述文件,被称为package.json。同时项目中也会用到别人写的JavaScript代码。如果我们要使用别人写的包,每次都要根据名称搜索一下官方网站,下载代码,解压,再使用,非常繁琐。于是一个集中管理的工具应运而生,大家都把自己开发的模块打包后放到npm官网上,如果要使用,直接通过npm安装就可以直接用,npm可以根据依赖关系,把所有依赖的包都下载下来并管理起来。否则,靠我们自己手动管理,肯定既麻烦又容易出错。说到管理依赖包,我们怎么知道有哪些依赖包呢,这个时候package.json就起到了至关重要的作用,package.json是一个 JSON文件 ,位于项目的根目录中,它跟踪依赖关系和元数据。是项目的核心。它包含项目名称、描述和版本之类的信息,运行、开发以及将将项目发布到 NPM 所需信息。
正文
本文从三个角度:package.json、版本管理、依赖安装对 npm 的包管理机制进行了详细分析
初始化package.json
# 创建项目目录 my-project $mkdir my-project # 进入项目目录 $cd .\my-project\ # 初始化package.json $npm init -y
打开package.json
{ "name": "my-project", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC" }
必备属性
package.json 中有非常多的属性,其中必须填写的只有两个:name 和 version ,这两个属性组成一个 npm 模块的唯一标识。
- name项用于区分项目,必须唯一
{ "name": "my-project" }
- version用于区分该项目版本,必须在此项目中唯一
{ "version": "1.0.0", }
描述信息
- description用于添加模块的的描述信息,方便别人了解你的模块。
{ "description": "" }
- keywords用于给你的模块添加关键字。
{ "keywords": [] }
目录文件
- 程序入口
{ "main": "lib/index.js", }
脚本配置
- scripts
{ "scripts": { "test": "jest --config .jest.js --no-cache", "dist": "antd-tools run dist", "compile": "antd-tools run compile", "build": "npm run compile && npm run dist" } }
发布配置
- preferGlobal 如果你的 node.js 模块主要用于安装到全局的命令行工具,那么该值设置为 true ,当用户将该模块安装到本地时,将得到一个警告。这个配置并不会阻止用户安装,而是会提示用户防止错误使用而引发一些问题。
- private 如果将 private 属性设置为 true,npm将拒绝发布它,这是为了防止一个私有模块被无意间发布出去。
依赖
- dependencies
"dependencies": { "base64-js": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.0.1.tgz", "integrity": "sha1-aSbRsZT7xze47tUTdW3i/Np+pAg=" } }
协议
{ "license": "ISC" }