包管理工具

包管理工具npm(Node Package Manager)

https://www.npmjs.com/

npm管理的包存放在:

  • 我们发布自己的包是发布到registry上面
  • 当我们安装一个包时其实是从registry上面下载的包;

项目配置文件

事实上,我们每一个项目都会有一个对应的配置文件,无论是前端项目还是后端项目:

  • 这个配置文件会记录着你项目的名称、版本号、项目描述等

  • 也会记录着你项目所依赖的其他库的信息和依赖库的版本号

  • 这个配置文件就叫做package.json

  • npm init #创建时填写信息 npm init -y # 所有信息使用默认的

常见的属性

必须填写的

  • name是项目的名称
  • version是当前项目的版本号;
  • description是描述信息,很多时候是作为项目的基本描述;
  • author是作者相关信息(发布时用到)
  • license是开源协议(发布时用到)

private属性

  • private属性记录当前的项目是否是私有的
  • 当值为true时,npm是不能发布它的,这是防止私有项目或模块发布出去的方式

main属性

  • 设置程序的入口。
    • 这个入口和webpack打包的入口并不冲突;
    • 它是在你发布一个模块的时候会用到的;
    • 比如我们使用axios模块 const axios = require(‘axios’);
    • 实际上是找到对应的main属性查找文件的;

scripts属性

  • scripts属性用于配置一些脚本命令,以键值对的形式存在;

  • 配置后我们可以通过 npm run 命令的key来执行这个命令

  • npm start和npm run start的区别是什么?

    • 它们是等价的
    • 对于常用的 start、 test、stop、restart可以省略掉run直接通过 npm start等方式运行;

    dependencies属性

  • dependencies属性是指定无论开发环境还是生成环境都需要依赖的包

  • 通常是我们项目实际开发用到的一些库模块

  • 与之对应的是devDependencies

devDependencies属性

  • 一些包在生成环境是不需要的,比如webpack、babel等
  • 这个时候我们会通过 npm install webpack –save-dev,将它安装到devDependencies属性中

在生成环境如何保证不安装这些包呢?

生成环境不需要安装时,我们需要通过npm install –production 来安装文件的依赖

engines属性

  • engines属性用于指定Node和NPM的版本号
  • 在安装的过程中,会先检查对应的引擎版本,如果不符合就会报错

browserslist属性

  • 用于配置打包后的JavaScript浏览器的兼容情况,参考
  • 否则我们需要手动的添加polyfills(补丁)来支持某些语法
  • 也就是说它是为webpack等打包工具服务的一个属性

版本管理的问题

安装的依赖版本出现:^2.0.3或~2.0.3 的意思是:

  • npm的包通常需要遵从semver版本规范

  • semver版本规范是 X.Y.Z

    • X主版本号(major):当你做了不兼容的 API 修改(可能不兼容之前的版本);

    • Y次版本号(minor):当你做了向下兼容的功能性新增(新功能增加,但是兼容之前的版本);

    • Z修订号(patch):当你做了向下兼容的问题修正(没有新功能,修复了之前版本的bug);

  • ^和~的区别

    • ^x.y.z:表示x是保持不变的,y和z永远安装最新的版本
    • ~x.y.z:表示x和y保持不变的,z永远安装最新的版本

npm工具解析

npm install命令

安装npm包:

  • 全局安装(global install)
    • npm install -g
  • 项目(局部)安装(local install)
    • npm install
  • 全局安装理解
    • 通常使用npm全局安装的包都是一些工具包:yarn、webpack等;并不是类似于 axios、express、koa等库文件;
    • 所以全局安装了之后并不能让我们在所有的项目中使用 axios等库;
    • 工具包配置全局变量

项目安装

  • 项目安装会在当前目录下生产一个 node_modules 文件夹

  • 局部安装分为开发时依赖和生产时依赖

    • 安装开发和生产依赖
      • npm install axios
        • npm i axios
  • 开发依赖

    • npm install webpack –save-dev
    • npm install webpack -D
    • npm i webpack –D
  • 根据package.json中的依赖包

    • npm install

npm install 原理

  • 首先 npm install会检测是否有package-lock.json文件
    • 如果没有lock文件
      • 开始分析依赖关系,就是我们可能会依赖其他的包,并且多个包之间会产生相同依赖的情况
      • 之后从registry仓库中下载压缩包(如果设置了镜像 那么从镜像服务器中下载压缩包(比如taobao))
      • 当获取到了压缩包会对压缩包缓存(从npm5开始有)
      • 将压缩包解压到项目的node_modules文件夹中
    • 有lock文件
      • 检测lock中包的版本是否和package.json中一致(按照semver版本规范检测)
        • 不一致,那么会重新构建依赖关系,直接会走顶层的流程
      • 一致的情况下,会去优先查找缓存
        • 没有找到,会从registry仓库下载,直接走顶层流程
      • 查找到,会获取缓存中的压缩文件,并且将压缩文件解压到node_modules文件夹中
  • 查看缓存位置的指令:npm config get cache

package-lock.json

  • name:项目的名称;
  • version:项目的版本;
  • lockfileVersion:lock文件的版本;
  • requires:使用requires来跟着模块的依赖关系
  • dependencies:项目的依赖
    • 比如当前项目依赖axios,但是axios依赖follow redireacts;
    • axios中的属性如下
      • version表示实际安装的axios的版本
      • resolved用来记录下载的地址,registry仓库中的位置;
      • requires记录当前模块的依赖
      • integrity用来从缓存中获取索引,再通过索引去获取压缩包文件;

npm其他命令

卸载某个依赖包:

  • npm uninstall package
  • npm uninstall package –save-dev
  • npm uninstall package -D

强制重新构建build

  • npm rebuild

清除缓存

Yarn工具

yarn是为了弥补npm的一些缺陷出现

npm install yarn -g

cnpm工具

由于不可描述原因 某些情况下我们没办法很好的从 https://registry.npmjs.org下载下来一些需要的包

可以设置淘宝的一个registry镜像

查看npm镜像:

  • npm config get registry

设置npm镜像

但是为了一些担心 ,我们可以使用cnpm

npm

设置为淘宝源:

1
npm config set registry http://registry.npm.taobao.org/

设置为默认源:

1
npm config set registry https://registry.npmjs.org/

yarn

设置为淘宝源:

1
yarn config set registry https://registry.npm.taobao.org

设置为默认源:

1
yarn config set registry https://registry.yarnpkg.com

npx工具

npx是npm5.2之后自带的一个命令。

  • npx的作用非常多,但是比较常见的是使用它来调用项目中的某个模块的指令

以webpack为例:

  • 比如全局安装的是wepack5.1.3
  • 项目中安装使用的是webpack3.6.0

当在终端执行webpack–version时

  • 显示的结果是webpack5.1.3 使用的是全局的
  • 因为在当前目录下找不到webpack时,就会去全局找

要解决这个问题:

  • 解决局部命令执行

    • 使用项目(局部)的webpack,常见的是两种方式
      • 明确查找到node_module下面的webpack
      • 在 scripts定义脚本,来执行webpack;
  • 方式一:在终端中使用如下命令(在项目根目录下)

    • ./node_modules/.bin/webpack –version
  • 方式二:修改package.json中的scripts

    1
    2
    3
    4
    5
    "scripts": {

    "webpack": "webpack --version"

    }
  • 方式三:使用npx

    • npx webpack –version
    • 它会到当前目录的node_modules/.bin目录下查找对应的命令;