npm包的文件结构和安装过程

2017-08-25  本文已影响0人  科研者

1. npm命令的配置

可以通过以下2种方式对npm命令进行配置：

  1. 通过npm的config指令；

    此命令是用来管理npm的配置文件的；所以通过config命令配置的项目实际上是通过更新配置文件npmrc来配置的；

  2. 通过修改npm命令的配置文件npmrc文件；

npmrc配置文件的位置如下：

npm内嵌配置文件：/usr/local/lib/node_modules/npm/npmrc
全局配置文件：/etc/npmrc
用户配置文件：~/.npmrc
项目配置文件$项目目录/.npmrc

具体的配置命令如下

npm config set <key> <value> [-g|--global]  //给配置参数key设置值为value；
npm config get <key>          //获取配置参数key的值；
npm config delete <key>       //删除置参数key及其值；
npm config list [-l]      //显示npm的所有配置参数的信息；
npm config edit     //编辑配置文件
npm get <key>     //获取配置参数key的值；
npm set <key> <value> [-g|--global]    //给配置参数key设置值为value；

2. 配置参数prefix

prefix参数指定全局安装时相关目录的共同路径，即全局安装的根目录；

prefix在各个系统中的默认值如下：

大多数操作系统：/usr/local；
Windows系统：%AppData%\npm；

prefix的默认值是一般node的安装位置；但在Unix系统上，prefix的位置是node安装位置的上一级目录，因为node通常安装在 {prefix}/bin/node，而不是{prefix}/node.exe；

3. npm包的安装方式及安装目录

1. npm的安装包的方式有2种：

  1. 全局安装：在安装包时，当 global参数被设置为true 或者 全局选项被指定时，会进行全局安装；此时，根据操作系统的不同，npm会将包安装分别安装如下位置：

    Unix系统：{prefix}/lib/node_modules
    Windows系统：{prefix}/node_modules

  2. 本地安装：在安装包时，当 global参数被设置为false 且 没有指定全局选项时，会进行本地安装；此时，npm会将包安装到当前包下的node_modules目录中 或 当前工作目录下(如果当前目录不在包中)的node_modules目录中； 对于本地安装的包，可以通过require("packagename")加载包的主模块 或 通过require("packagename/lib/path/to/sub/module")加载包的其他模块；

当被安装的包是可执行的脚本时，可执行文件会被分别链接到不同的文件夹下，具体如下：
在全局安装时：

在Unix系统中，可执行文件会被链接到{prefix}/bin目录下；
在Windows系统中，可执行文件会直接连接到{prefix}目录下；

在本地安装时：

可执行文件会被链接到./node_modules/.bin目录下，以便可以通过npm运行脚本。

2. 手册页的安装路径

  1. 在全局模式下，手册页被链接到{prefix}/share/man目录下；
  2. 在本地模式下，手册页不会被安装。
  3. 在Windows系统中也不会安装手册页。

3. 高速缓存文件的路径

缓存的文件的路径由cache配置参数指定。
cache配置参数的默认值如下：

Posix系统：~/.npm
Windows系统：~/npm-cache

4. 临时文件的路径

临时文件存储在由配置参数tmp指定的路径下；
在不同的操作系统中，tem的默认值为：

一般操作系统：环境变量TMPDIR、TMP 或 TEMP 的值；
Unix系统：/tmp
Windows系统：c:\windows\temp

程序会在每次运行时为临时文件生成一个唯一的目录，并程序成功退出后删除这个目录；

2. npm安装包的过程

以本地安装 npm install foo@1.2.3为例，npm的安装过程如下：

  1. npm会沿着当前文件夹的层级树查找包含 package.json文件 或 node_modules文件夹 的文件夹；
  2. 如果查找到匹配的文件夹，那么该文件夹会被作为npm的执行文件夹；如果没有查找到匹配的文件夹，则会使用当剪的文件夹作为npm的执行文件夹；
  3. 加载foo包到缓存中；
  4. 然后解压foo包到路径 ./node_modules/foo
  5. 然后加载foo包的依赖包到缓存中；
  6. 然后解压foo包的依赖包到路径 ./node_modules/foo/node_modules/...
  7. 把每一个可执行文件符号链接至路径 ./node_modules/.bin/，以便在必要时可以通过npm脚本找到它们；

3. 安装建议

  1. 如果被安装的包需要通过require()引入，则需要把包安装在本地；
  2. 如果被安装的包需要在命令行中运行，则需要把包安装在全局；
  3. 如果被安装的包即需要通过require()引入，又需要在命令行中运行，则需要把包 分别安装在本地和全局 或者 用 npm link 创建链接；
上一篇 下一篇

猜你喜欢

热点阅读