前端工程化 - 配置 npmrc 文件

1,535 阅读3分钟

前端工程化 - 配置 npmrc 文件

最佳实践,在你的项目中配置好 npmrc 可以让团队获取第三方库保持一致性,比如设置为公司内部的私有仓库等等。

1. 简介

npmrc 文件的英文全称是 "npm running configuration"。

.npmrc 文件是 npm(Node Package Manager)的配置文件,用于存储 npm 的配置信息。

这些配置信息可以涉及各种方面,包括 npm 如何安装包、如何解析依赖关系、如何处理权限等。

该文件通常位于项目的根目录或用户的主目录下。

1.1 痛点

由于一些原因,咱们获取 node.js 的第三方包的时候经常会遇到一些网络问题。

这个时候,采用国内的镜像来下载第三方就非常有必要。

为了保持项目的一致性,我们最好把这个配置放在项目的根目录下,这样可以让整个团队统一获取第三方包的方式,减少不必要的错误,保持一致性。

2..npmrc 文件的优先级

该文件的优先级如下,比如,用户配置文件中的设置将覆盖全局配置文件中的设置。

  1. 项目配置文件:/path/to/my/project/.npmrc
  2. 用户配置文件:~/.npmrc
  3. 全局配置文件:$PREFIX/etc/npmrc
  4. npm 内置配置文件:/path/to/npm/npmrc

也就是说,项目配置文件中的设置拥有最高的优先级,所以我们只需要配置好项目中的 .npmrc 文件即可。

3. .npmrc 使用

.npmrc 使用 ini 文件格式,具体请看第五小节。

我们创建一个 .npmrc 文件,填入如下内容

registry=https://registry.npmmirror.com

这是阿里的 npm 镜像地址,如果需要重新切换为官网,重新修改为官网即可。

registry=https://registry.npmjs.org/

🟡注意

原来阿里的镜像地址 registry.npm.taobao.org 已经过时。

现在咱们应该使用 registry.npmmirror.com 这个地址。

4. 配置查看和修改

这里特别注意,你可以直接打开文件直接进行修改,也可以使用命令行来修改,打开文件修改的是对应文件的配置,命令行在修改的时候你需要特别告诉终端,你需要修改的是哪一个配置文件。

使用命令其实比较麻烦,这里不详细展开说,请使用以下命令详细查看帮助文档。

npm help config

5. INI文件格式

INI 文件格式是一种简单的文本文件格式,用于存储配置数据。

它被设计为由人类可读的格式,并且可以被程序轻松解析。

INI 文件通常用于存储程序的配置参数,如设置选项、路径、文件名等。

INI 文件的主要特点包括:

1.节(Sections)**:

INI 文件被分成多个节,每个节由方括号 [] 包围的标题标识。如:

[Settings]
resolution=1920x1080
volume=75

2. 键值对(Key-Value Pairs)

每个节包含一系列的键值对。键和值由等号 = 分隔。如:

resolution=1920x1080
volume=75

3. 注释(Comments)

INI 文件支持注释,以分号 ; 或井号 # 开头的行会被解析器忽略。如:

; This is a comment
# This is also a comment

4. 空行(Empty Lines)

空行或只包含空格的行也被解析器忽略。

5. 特殊字符

如果键或值中包含等号 =、逗号 , 或其他特殊字符,可能需要使用引号将值括起来,以确保正确解析。

6. 数组(Arrays)

在某些解析器中,可以通过在键名后添加 [] 来定义数组。例如:

colors[] = "red"
colors[] = "green"
colors[] = "blue"