npm的配置文件

  • 那么对于一个项目来说,我们如何使用npm来管理这么多包呢?

    • 事实上,我们每一个项目都会有一个对应的配置文件,无论是前端项目(Vue、React)还是后端项目(Node);
    • 这个配置文件会记录着你项目的名称、版本号、项目描述等;
    • 也会记录着你项目所依赖的其他库的信息和依赖库的版本号;
  • 这个配置文件就是package.json

  • 那么这个配置文件如何得到呢?

    • 方式一:手动从零创建项目,npm init –y
    • 方式二:通过脚手架创建项目,脚手架会帮助我们生成package.json,并且里面有相关的配置
  • 必须填写的属性:name、version

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

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

    • 设置程序的入口。
      • 比如我们使用axios模块 const axios = require(‘axios’);
      • 如果有main属性,实际上是找到对应的main属性查找文件的;
  • scripts属性

    • scripts属性用于配置一些脚本命令,以键值对的形式存在;
    • 配置后我们可以通过 npm run 命令的key来执行这个命令;
    • npm start和npm run start的区别是什么?
      • 它们是等价的;
      • 对于常用的 start、 test、stop、restart可以省略掉run直接通过 npm start等方式运行;
  • dependencies属性

    • dependencies属性是指定无论开发环境还是生成环境都需要依赖的包;
    • 通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、axios等等;
    • 与之对应的是devDependencies;
  • devDependencies属性

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

    • 还有一种项目依赖关系是对等依赖,也就是你依赖的一个包,它必须是以另外一个宿主包为前提的;
    • 比如element-plus是依赖于vue3的,ant design是依赖于react、react-dom;

依赖的版本管理

  • 我们会发现安装的依赖版本出现:^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:表示x和y保持不变的,z永远安装最新的版本;

npm install 命令

  • 安装npm包分两种情况:
    • 全局安装(global install): npm install webpack -g;
    • 项目(局部)安装(local install): npm install webpack
  • 全局安装
    • 全局安装是直接将某个包安装到全局:
    • 比如全局安装yarn: <font style="color:#DF2A3F;"> npm install yarn -g</font>
  • 但是很多人对全局安装有一些误会:
    • 通常使用npm全局安装的包都是一些工具包:yarn、webpack等;
    • 并不是类似于 axios、express、koa等库文件;
    • 所以全局安装了之后并不能让我们在所有的项目中使用 axios等库;

项目安装

  • 项目安装会在当前目录下生成一个 node_modules 文件夹,我们之前讲解require查找顺序时有讲解过这个包在什么情况下被 查找;
  • 局部安装分为开发时依赖和生产时依赖