关于 npm 你需要知道的一些事

npm 作为一款有名的 Node.js 包管理工具被许多开发人员所熟知,但是对于新手小白来说想要真正理解它似乎也不是那么容易。

关于npm,官网上是这么说的。
npm 由三个独立的部分组成:
  • 网站(registry) :是开发者查找包(package)、设置参数以及管理 npm 使用体验的主要途径。
  • 注册表(registry): 是一个巨大的数据库,保存了每个包(package)的信息。
  • 命令行工具(CLI):通过命令行或终端运行。开发者通过 CLI 与 npm 打交道。
有点懵。简单地说,npm上有很多其他开发人员上传的已经打包好的代码,我们可以使用npm 下载并使用它们。那么怎么用呢?

基础

npm 的所有命令可以概括为如下形式:
npm <command> [args]      // npm <命令名称> [其他参数]
一些常用的命令包括:

npm init : 初始化项目,使用 –force|-f|–yes|-y 跳过提问阶段直接生成package.json,使用 –scope 创建私有包

npm help :打印帮助信息;

npm version :获取当前的详细版本信息

  • npm -version : 仅获取 npm 的版本号,别名 npm -v

npm ls :列出已安装的所有包,别名 npm list

npm config :配置环境变量

  • npm config set <key><value> [-g|–global] :将配置健设置为指定值
  • npm config get <key> : 获取配置健的值
  • npm config list [-l] [–json] : 显示所有配置健
  • npm config delete<key> : 从所有配置文件中删除指定配置健
  • npm config edit:在编辑器中打开配置文件

npm install : 安装模块到 node_modules 中,别名 npm -i ,npm add 。不设置参数,将默认安装所有在 package.json 中列出的依赖包

  • npm install <folder> :安装本地文件系统中指定目录下的模块
  • npm install <tarball file> :安装本地文件系统中指定压缩包中的模块
  • npm install <tarball url> :通过 url 安装指定压缩包中的模块
  • npm install <alias> @npm:<name> :安装到本地时使用别名,用于多版本安装
  • npm install [<@scope> /]<name> :通过依赖包名在线安装
  • npm install [<@scope> /]<name> @<tag> :安装指定标签引用的软件包的版本
  • npm install [<@scope>/]<name> @<version> :安装指定版本的软件包
  • npm install [<@scope>/]<name> @<version range> :安装与指定版本范围匹配的软件包版本

npm uninstall [<@scope> /] <name> [@<version> ]… : 卸载指定依赖包,别名: npm remove , npm rm , npm r , npm un , npm unlink

npm update [-g] [<name> …] : 更新指定依赖包,别名: npm up , npm upgrade

关于 -g ,-P ,-D ,-S , -O:

  • g : 全局安装,将依赖包安装的操作系统上
  • P : –save-prod, 局部安装,模块写入到 dependencies 对象,默认值
  • D : –save-dev ,局部安装,模块写入到 devDependencies 对象,开发环境
  • S : –save ,局部安装,不同的是模块写入到 dependencies 对象,生产环境
  • O : –save-optional , 局部安装,不同的是模块写入到 optionalDependencies 对象
更多命令请访问>>>npm CLI Version 6.x

安装

npm是随同Node.js一起安装的包管理工具,新版本的 Node.js 已经集成了 npm,所以,当你安装完 Node.js之后,npm 一般也就安装好了。
安装完成后建议配置下缓存文件及全局安装文件的路径:
全局安装路径:npm config set prefix “D:\Program Files\nodejs\node_global”
默认缓存路径:npm config set cache “D:\Program Files\nodejs\node_cache”

使用

新建一个项目,在项目文件夹下按住 Shift 然后右键可打开命令窗口,输入命令 npm init -y 可快速初始化项目

package.json 文件

初始化后会生产一个 package.json 文件,该文件的默认内容为:
{
  "name": "npm-study",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}
注意: package.json 内容必须是一个 JSON ,而不是 JavaScript 对象!
下面简单介绍下常用配置项:
  • name :项目的名称,字符串。需为合法字符串(少于 214 个字符;以“-”或“.”间隔;禁止大写;符合 url 规则)
  • version :项目的版本号,字符串
  • description : 描述信息,字符串
  • keywords : 关键字、标签,数组
  • homepage : 项目主页地址,字符串
  • bugs : Bug 提交方式,字符串或对象
  • license : 开源协议,字符串或对象
  • author : 项目的作者,字符串或对象
  • contributors : 贡献者,数组
  • funding : 赞赏方式,字符串或数组
  • files : 其他相关文件,数组
  • main : 项目主入口文件,browser 客户端和 node 服务器均可使用,字符串
  • browser : 项目在 browser 客户端中的入口文件,字符串
  • bin : 用来指定 scripts 命令对应的可执行文件位置,字符串或对象
  • man :查找文档地址,对应 linux 下的 man 命令查找文档地址,字符串或数组
  • directories : 自定义指定文件夹路径,对象
  • repository : 代码仓库位置,对象
  • scripts : 指定运行脚本命令的 npm 命令行缩写,对象
  • config : 常用配置项,对象
  • dependencies : 项目依赖的模块列表,对象
  • devDependencies : 项目依赖的模块列表(开发环境),对象
  • peerDependencies :插件项目依赖的宿主模块,对象
  • bundledDependencies : 发布时绑定发布的依赖模块,数组
  • optionalDependencies : 可选的项目,依赖包安装失败项目仍能运行
  • engines : 限制项目所运行的 node 版本,对象
  • os : 指定项目只能运行在哪些操作系统中,数组
  • cpu : 指定项目只能运行在特定的cpu架构下,数组
  • preferGlobal : 限制项目只能全局安装,局部安装时提示,布尔值
  • private : 是否为私有项目,布尔值
  • publishConfig : 发布时的配置项,对象
更多命令细节请参考 >>> package.json 官方文档

package-lock.json 文件

使用上述命令安装一个依赖包,比如:npm i webpack -D 安装 webpack 会生成一个 package-lock.json 文件,该文件是 npm 5.x 版本新增的一个文件,主要用于锁定版本号,避免安装过程中的去重原则导致的依赖包更新后的兼容性问题。

npm-shrinkwrap.json 文件

使用 npm shrinkwrap 创建,package-lock.json 的前身,手动版本的版本控制文件,几乎与 package-lock.json 一致,有些细微的差别,前期不需要了解那么多。npm-shrinkwrap.json 与 package-lock.json 同时存在是会忽略 package-lock.json 的配置。

.npmrc 文件

npm 的配置文件,一般在“C:\Users\Administrator”目录下。通过 npm config 可以修改该文件下的值。几乎没啥用。
一月 4

历史上的今天

未经允许不得转载

文章标题:蝈蝈要安静 » 关于 npm 你需要知道的一些事

原文链接:https://blog.quietguoguo.com/4135.html

发布信息:文章由【蝈蝈要安静】于<2021-01-04>发布于【HTML/CSS/JS】分类下

相关标签:||

相关推荐

评论 抢沙发

  • 昵称(必填)
  • 邮箱(必填)
  • QQ(选填)
  • 网址(选填)