主要功能
- 包管理:
- 搜索、安装、更新和删除Node.js包。
- 管理项目的依赖关系,确保项目在不同环境中的一致性。
- 版本控制:
- 支持语义化版本控制(Semantic Versioning,简称SemVer),允许开发者指定包的版本范围。
- 提供版本锁定功能,确保项目使用的包版本不会意外更改。
- 脚本执行:
- 允许开发者在package.json文件中定义自定义脚本,并使用npm run命令执行它们。
- 提供生命周期钩子,允许开发者在包的安装、发布等阶段执行自定义代码。
- 用户管理:
- 支持用户注册、登录和注销。
- 允许用户发布自己的包到npm仓库,与全球开发者共享。
- 配置管理:
- 提供全局和局部配置选项,允许开发者根据需求调整npm的行为。
- 支持环境变量和配置文件的组合使用,以实现更灵活的配置管理。
安装
- 下载Node.js:
- 访问Node.js的官方网站:Node.js官网
- 下载适合操作系统的安装包(Windows、macOS、Linux)。
- 安装Node.js:
- 按照下载的安装包提示完成安装。Node.js安装包中自带npm,因此安装Node.js时会自动安装npm。
- 验证安装:
- 打开终端(Terminal、命令提示符或PowerShell)。
- 输入以下命令检查Node.js和npm是否安装成功:
node -v
npm -v
- 如果命令返回了版本号,说明安装成功。
常用命令
- 初始化项目:
- npm init:创建一个新的package.json文件,用于定义项目的元数据和依赖关系。
- 安装包:
- npm install 包名:安装指定版本的包,并将其添加到package.json的dependencies中。
- npm install --save-dev 包名:安装开发依赖包,并将其添加到package.json的devDependencies中。
- 运行脚本:
- npm run 脚本名:运行package.json中定义的自定义脚本。
- 更新包:
- npm update 包名:更新指定包到最新版本。
- npm update:更新项目中的所有依赖包到最新版本(或指定的版本范围)。
- 卸载包:
- npm uninstall 包名:卸载指定的包。
- 查看已安装包:
- npm list:列出项目中已安装的所有包及其依赖关系。
- 全局安装包:
- npm install -g 包名:全局安装包,以便在命令行中直接使用。
- 发布包:
- npm publish:将本地包发布到npm仓库。
配置
npm的配置可以通过命令行参数、环境变量和配置文件进行。常用的配置文件包括全局配置文件(通常位于 N P M C O N F I G H O M E / n p m r c 或 NPM_CONFIG_HOME/npmrc或 NPMCONFIGHOME/npmrc或HOME/.npmrc)和项目级配置文件(位于项目根目录下的.npmrc文件)。
-
配置文件
npm的主要配置文件是.npmrc文件。这个文件可以位于用户主目录下(作为全局配置),也可以位于项目根目录下(作为项目配置)。.npmrc文件是一个纯文本文件,用于存储npm的各种配置选项。- 全局配置文件:通常位于 N P M C O N F I G H O M E / n p m r c 或 NPM_CONFIG_HOME/npmrc或 NPMCONFIGHOME/npmrc或HOME/.npmrc(在Unix/Linux/macOS系统中,$HOME通常指向用户的主目录)。
- 项目配置文件:位于项目根目录下的.npmrc文件,该文件中的配置将覆盖全局配置。
-
配置选项
以下是一些常用的npm配置选项:- registry:指定用于下载包的npm注册表地址。例如,可以使用淘宝npm镜像来加速包的下载,配置命令为npm config set registry https://registry.npm.taobao.org/。
- proxy和https-proxy:设置HTTP/HTTPS代理服务器的地址和端口,这对于处于网络受限环境下的用户特别有用。
- save-prefix:指定在package.json文件中保存依赖项时使用的前缀(默认为^)。这决定了npm在安装依赖时使用的版本范围。
- save-exact:当设置为true时,将依赖项的确切版本保存在package.json文件中,而不是使用版本范围。这有助于确保项目在不同环境中的一致性。
- prefix:设置全局安装的路径。例如,npm config set prefix /usr/local将全局安装的包放在/usr/local目录下。
- cache:设置npm的缓存目录。例如,npm config set cache /path/to/cache将缓存放在指定目录下。
-
配置方法
- 使用命令行参数:
npm提供了npm config set命令来设置配置选项。例如,npm config set registry https://registry.npm.taobao.org/将npm的注册表地址设置为淘宝npm镜像。 - 使用环境变量:
某些npm配置选项也可以通过环境变量来设置。例如,NPM_CONFIG_REGISTRY环境变量可以用于设置注册表地址。 - 直接编辑.npmrc文件:
可以直接打开.npmrc文件并手动编辑其中的配置选项。使用文本编辑器打开该文件,然后添加或修改所需的配置。 - 使用npm config edit命令:
这个命令会打开一个文本编辑器(通常是系统默认的编辑器),让直接编辑npm的配置文件。
- 使用命令行参数:
注意事项
- 在修改npm配置之前,最好先备份当前的配置文件,以防出现意外情况。
- 如果项目中使用了.npmrc文件,请确保该文件不会被意外地包含在版本控制系统中(例如git),除非希望其他开发者也使用相同的配置。
- npm的配置选项可能会随着npm版本的更新而发生变化,因此建议查阅npm的官方文档以获取最新的配置信息。
npm仓库
npm仓库是存储Node.js包的中央存储库。开发者可以从npm仓库中搜索、安装和更新包。npm仓库还提供了包的信息页面,包括包的版本历史、依赖关系、作者信息、README文档等。
-
npm仓库的分类
npm仓库主要分为两类:公共仓库和私有仓库。- 公共仓库:如npmjs.org,是npm默认的仓库地址,任何人都可以访问和下载其中的包。这是大多数开发者获取和使用npm包的主要途径。
- 私有仓库:常用于企业内部,以便管理内部开发的模块和包,避免敏感信息泄露。私有仓库需要额外的配置和权限管理,以确保只有授权的用户才能访问和下载其中的包。
-
npm仓库的配置
npm仓库的配置可以通过修改~/.npmrc文件或使用npm config set命令来实现。这包括设置仓库地址、代理、缓存等选项。例如,要将npm的仓库地址设置为私有仓库,可以在~/.npmrc文件中添加registry=http://your-private-registry-url,或者使用npm config set registry http://your-private-registry-url命令。- 临时使用一个不同的仓库(只影响当前命令):
npm install --registry https://your-custom-registry-url <package-name>
2. **永久配置npm使用的仓库(影响全局):**
npm config set registry https://your-custom-registry-url
3. **通过.npmrc文件配置(影响当前项目):**
在项目根目录下创建或编辑.npmrc文件,添加以下内容:
registry=https://your-custom-registry-url
4. **使用环境变量设置(影响所有使用该环境变量的npm操作):**
export NPM_CONFIG_REGISTRY=https://your-custom-registry-url
- npm仓库的使用
要使用npm仓库,首先需要确保计算机上安装了Node.js和npm。安装完成后,就可以通过npm命令来管理项目中的依赖包了。例如,使用npm install 包名来安装指定的包,使用npm uninstall 包名来卸载包,使用npm update 包名来更新包到最新版本等。
此外,npm还提供了许多其他有用的命令和功能,如npm init用于创建一个新的Node.js项目并生成package.json文件,npm run用于运行package.json中定义的脚本等。
-
npm仓库的高级功能
除了基本的包管理功能外,npm仓库还支持一些高级功能,如:- 权限管理:可以为不同的用户或用户组分配不同的访问权限,以确保私有仓库的安全性。
- 包版本控制:可以设置保留策略,自动清理旧版本的包,以节省存储空间。
- 包签名:可以对发布的包进行签名,确保包的完整性和来源的可靠性。
- 私有包缓存:作为代理仓库时,可以缓存从上游仓库下载的包,提高下载速度并减轻上游仓库的负载。
-
示例
临时:
npm config set proxy http://registry.npm.taobao.org
npm config set https-proxy http://registry.npm.taobao.org
永久:
# .npmrc文件
proxy=http://registry.npm.taobao.org
https-proxy=http://registry.npm.taobao.org