1. npm介绍
npm是Node.js自带的包管理工具,用于对Node.js包进行统一管理和分发并且可以使开发者轻松分享包以及协作开发。npm有两个重要的组成部分:一个是npm官方网站,以及客户端CLI(命令行接口),它们组合起来为Node.js开发人员提供了一个完整的生态系统来完成他们的应用程序。
1.1 官方网站
npm官方网站包含了超过100多万个Node.js包,这些包包括各种类型的模块,从简单的工具到庞大而复杂的框架。
1.2 命令行界面(CLI)
npm CLI 是 Node.js 包管理的主要命令行接口,并被用于为开源社区和个人包提供包管理服务。通过npm实现的大多数操作都是使用CLI提供的命令完成的。
2. 包与模块的关系
在 Node.js 中,一个包实际上只是一个包含了可用于 Node.js 模块的 JavaScript 文件的目录。每个包都必须拥有一个 package.json 文件,这个文件用来描述这个包的信息,包括包的名称,作者,版本号,依赖等等。Node.js 的模块系统允许开发者通过指定本地包的名称进行导入。
3. npm常用命令
3.1 安装包
在 Node.js 中,npm 用于安装、管理和卸载依赖包。通过使用如下命令可以将某个包安装到项目中:
npm install <package-name>
这条命令首先使用npm检查指定的包是否在npm数据库中可用。如果可以找到,则会下载该包。如果包中有其他包依赖项,则npm也会自动将它们一并下载下来。
3.2 卸载包
通过如下的命令可以将已安装的包从项目中卸载:
npm uninstall <package-name>
3.3 更新包
通过如下的命令可以更新已安装的包:
npm update <package-name>
如果您想同时更新项目中所有的包,可以使用如下命令:
npm update
3.4 搜索包
npm 包仓库中有大量的包,您可以通过 npm 搜索命令来查找您所需要的包:
npm search <search-term>
该命令会在 npm 包的数据库中搜寻指定的关键字,并返回所有相关联的包。您可以在搜索关键字的同时指定参数来执行特定类型和状态的搜索。
3.5 发布包
要将自己的包发布到 npm 包仓库中,您需要首先注册 npm 帐号。使用如下命令进行包的发布:
npm publish
4. 发布包的package.json文件
在发布包到 npm 仓库之前,您需要首先编写 package.json 文件。该文件中包含了关于此包的描述和元数据信息,如包名称,版本号,依赖项,许可证等等。
4.1 包名称(name)
name是必须的字段,这个字段必须是小写,没有任何空格,括号必须是单引号或双引号包裹。
"name": "my-package"
4.2 包版本(version)
version是必须的字段,这个字段必须是语义化版本号,即x.y.z,其中x表示major版本号,y表示minor版本号,z表示patch版本号。
"version": "1.0.0"
4.3 包描述(description)
description字段可帮助用户了解包的功能、用途。这个字段是可选项,但是为了更好地推广包,建议添加description字段。
"description": "This is a description of my package."
4.4 作用域(scope)
作用域是 npm 的一项功能,它允许包的名称被限定在一个特定的命名空间内。例如,“@mycompany/mypackage”是一个作用域名为“mycompany”的包。作用域必须以@ 符号开头,并且在包名称前加上作用域名称。
"name": "@mycompany/mypackage"
4.5 包主页(homepage)
homepage字段是可选的,包含有关包的主页的 URL。
"homepage": "https://github.com/user/repo#readme"
4.6 仓库(repository)
repository字段也是可选的,包含有关包的代码仓库的信息。
"repository": {
"type": "git",
"url": "https://github.com/user/repo.git"
}
4.7 作者(author)
author字段是可选的,包含包的作者的信息。它的值可以是字符串或一个对象。
"author": {
"name": "Jane Doe",
"email": "jane.doe@example.com",
"url": "https://jane-doe.com"
}
4.8 许可证(license)
license字段是可选的,指定使用何种类型的开源协议。如果是标准开源许可证,可以使用 license 内置几个常量。
(注:MIT许可证是一种非常流行的选择,因为它允许在许可证和版权声明中包含以下文本:“有关此软件包的版权和许可证的更多信息,请参见我们的完整许可证文件(https://opensource.org/licenses/MIT)。”,这样可以在保护版权的同时扩大软件被广泛使用的范围。)
"license": "MIT"
5.安装包的依赖项
理解如何管理依赖项是包开发中的重要部分。 Node.js 的包管理工具 npm 提供各种安装、升级和卸载依赖项的方法,以简化这一过程。
5.1 本地依赖(local dependencies)
本地依赖项存储在package.json文件的dependencies字段中。它们将作为包开发过程中的一部分来处理。当从源代码构建包时,npm 自动下载和安装此类依赖项和它们的依赖项。
"dependencies": {
"express": "^4.16.3",
"moment": "^2.22.2",
"cookie-parser": "^1.4.4"
}
5.2 全局依赖(global dependencies)
全局依赖项与本地依赖项不同,全局依赖项是安装在用户计算机上的npm包。这些包通常在Node.js开发环境中使用而非在某个特定的包项目中。
可以通过如下命令来安装全局依赖项:
npm install -g <package-name>
5.3 开发依赖项(devDependencies)
devDependencies字段指定测试和开发过程中需要的依赖项。
"devDependencies": {
"eslint": "^4.18.2",
"mocha": "^5.2.0",
"chai": "^4.1.2"
}
6. 使用.npmignore文件排除文件
默认情况下,npm 会将项目中所有文件包含在你发布的包中。要排除特定的文件或目录,您可以创建一个.npmignore文件,类似于.gitignore文件。
node_modules
*.log
.DS_Store
7. 解决依赖项的版本问题
在使用npm时,考虑依赖项的版本是十分重要的。仔细选择可以确保包的功能和兼容性。
7.1 语义化版本控制
在npm中,程序包使用语义化版本控制。语义化版本控制是一个三数字版本号,其中每个数字代表以下内容:
第一个数字是作为大版本号,表示开发者对代码库进行了大规模的修改,大版本号的变化意味着向后兼容存在大的改变。
第二个数字是次要版本号,代表次要的更改,包括小的特性改进和新功能添加。
第三个数字是修补版本号,通常表示一些错误的改正或漏洞修补。
7.2 ^和~语义化版本控制符
语义化版本控制不允许在标准版本号之后的逗号后引入任何其他数字。但有时某些包可能仍需要轻度更新,这时可以使用^或~符号来解决问题。
^包装符号 - 如果指定的是^符号,npm会自动在前面的主版本号后加1,以添加支持向后兼容的修改。
"dependencies": {
"foo": "^1.2.3"
}
~包装符号 - 该符号又称为波浪线包装符号,它让npm自动在指定版本的最后一个解释器版本后增加次要版本和/或错误的修复版号。
"dependencies": {
"foo": "~1.2.3"
}
8. 结束语
通过本文,您应该了解了npm的基础知识以及如何使用npm实现包的管理。要获得更多和更深入的资料,请访问npm官方网站。