NPM 使用教程

我叫汪枫

于 2024-08-12 22:58:45 发布

阅读量425

点赞数 13

文章标签： npm

本文链接：https://blog.csdn.net/weixin_47121832/article/details/141144425

版权

NPM（Node Package Manager）是 JavaScript 世界中最流行的包管理器和软件仓库。它不仅允许开发者轻松地下载和管理依赖库，还支持发布自己的包，方便在项目中复用代码。无论是构建小型应用程序还是大型项目，NPM 都是一个不可或缺的工具。

在开始使用 NPM 之前，你需要确保已经安装了 Node.js。Node.js 自带 NPM，因此安装 Node.js 后会自动安装 NPM。

安装 Node.js：
你可以从 Node.js 官网下载最新的 Node.js 安装包并进行安装。安装完成后，可以在终端中输入以下命令查看 NPM 是否已正确安装：
```
node -v  # 检查 Node.js 版本
npm -v   # 检查 NPM 版本
```

在使用 NPM 管理项目依赖之前，首先需要初始化一个项目。这会在你的项目目录中生成一个 package.json 文件，记录项目的基本信息和依赖库。

初始化项目：
在你的项目根目录下运行以下命令：
```
npm init
```
NPM 会提示你输入一些项目的基本信息，如项目名称、版本、描述等。你可以根据需求填写，也可以直接按回车跳过，使用默认值。最后会生成一个类似这样的 package.json 文件：
```
{
  "name": "my-project",
  "version": "1.0.0",
  "description": "A sample project",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Your Name",
  "license": "ISC"
}
```
- 快速初始化：
  如果不想每次都手动输入项目信息，可以使用 -y 参数快速初始化，NPM 会使用默认值创建 package.json 文件。
```
npm init -y
```

NPM 最常用的功能之一就是安装依赖包。你可以从 NPM 官方仓库中下载任何公开发布的包，并将其添加到项目中。

安装依赖包：
使用以下命令可以安装某个依赖包，例如安装 express：
```
npm install express
```
这会在 node_modules 目录中下载并安装 express 包，并自动在 package.json 文件中的 dependencies 字段中添加对应的版本信息：
```
"dependencies": {
  "express": "^4.17.1"
}
```
安装开发依赖包：
如果某个包只在开发环境中使用（例如测试库），可以使用 --save-dev 或 -D 参数将其作为开发依赖添加：
```
npm install mocha --save-dev
```
package.json 文件中的 devDependencies 字段会记录这些开发依赖：
```
"devDependencies": {
  "mocha": "^8.2.1"
}
```

有时你可能需要卸载某个依赖包。可以使用以下命令：

npm uninstall package-name

例如，要卸载 express：

npm uninstall express

这会从 node_modules 目录中删除 express，并从 package.json 的 dependencies 字段中移除对应的记录。

有些工具或命令行工具需要全局安装。全局安装的包可以在系统的任何地方使用。

全局安装：
使用 -g 参数可以将包全局安装，例如安装 npm 自带的 http-server 工具：
```
npm install -g http-server
```
查看全局安装的包：
可以使用以下命令查看所有全局安装的包：
```
npm list -g --depth=0
```
--depth=0 参数限制只显示顶级包，而不会列出每个包的依赖。

NPM 允许你在 package.json 中定义脚本，以简化常用命令的执行。比如你可以将启动服务器的命令、编译代码的命令等放在脚本中。

定义脚本：
例如，添加一个启动脚本：

"scripts": {
  "start": "node index.js",
  "test": "mocha"
}

运行脚本：
运行脚本只需使用 npm run 命令。例如，要运行 start 脚本：
```
npm run start
```
对于 start 和 test 这两个脚本，可以直接运行 npm start 或 npm test，无需使用 run 关键字。

如果你开发了一个通用的功能模块，可以将其打包并发布到 NPM 上，供他人使用。

登录 NPM 账户：
首先需要登录 NPM 账户，如果没有账户，可以使用 npm adduser 注册：
```
npm login
```
发布包：
确保 package.json 中的 name 和 version 是唯一的，然后运行以下命令发布你的包：
```
npm publish
```
更新包：
每次更新包时，需要增加 version 号，否则 NPM 会拒绝发布。更新 version 后再次运行 npm publish 即可。

NPM 是管理 JavaScript 项目的强大工具，它简化了依赖管理、项目初始化、脚本运行和包发布等流程。通过掌握 NPM 的基本用法，你可以更高效地管理和开发项目。

希望这篇教程能帮助你更好地理解和使用 NPM。如果你有任何问题或想法，欢迎在评论区分享！

关注