如何在 ServBay 中启用和使用 npm (Node.js 包管理器)

npm（Node Package Manager）是 Node.js 的官方包管理工具，也是全球最大的开源软件库之一。对于 Node.js 开发者来说，npm 是不可或缺的工具，它能够帮助您轻松地安装、共享和管理项目中的代码依赖。通过 ServBay 提供的集成环境，您可以快速开始使用 npm 进行开发。

前提条件

在使用 npm 之前，您需要在 ServBay 中安装 Node.js。

1. 打开 ServBay 应用。
2. 导航到“软件包”（Packages）面板。
3. 找到 Node.js 软件包，并确保它已安装并处于运行状态。

ServBay 会自动配置好 Node.js 环境，其中就包含了 npm。

确认 npm 已安装并可用

通过 ServBay 安装的 Node.js 已经自带了 npm，并且默认是启用的。您可以通过终端快速确认 npm 是否已正确安装并可访问。

1. 打开您的终端应用程序（如 macOS 的 Terminal）。

2. 输入以下命令查看 npm 的版本号：

   npm -v

   如果命令成功执行并显示版本号（例如 10.2.0 或更高版本），则表示 npm 已正确安装并可在当前环境中直接使用。

   # 示例输出
   10.2.0

   如果您看到“command not found: npm”之类的错误，请确保您已经通过 ServBay 安装了 Node.js 软件包，并且 ServBay 的环境变量已正确加载（通常重启终端或您的电脑可以解决环境变量的问题）。

更新 npm

尽管 ServBay 安装的 Node.js 版本通常包含一个稳定版本的 npm，但 npm 本身会独立于 Node.js 进行频繁更新。为了获取最新的功能和修复，您可以通过 npm 自身来更新它：

npm install -g npm@latest

这条命令会全局安装最新版本的 npm。-g 标志表示全局安装，这样您就可以在任何地方使用新版本的 npm 命令。

更新完成后，再次运行 npm -v 确认版本：

npm -v

npm 的核心功能与常见用法

npm 的强大之处在于其庞大的开源生态系统和便捷的依赖管理能力。以下是一些使用 npm 进行日常开发的常见场景和命令：

初始化新的 Node.js 项目

在一个空目录中开始一个新的 Node.js 项目时，您可以使用 npm init 命令来创建一个 package.json 文件。这个文件是项目的核心，记录了项目的元数据、依赖信息以及可运行的脚本等。

cd /Applications/ServBay/www/my-new-project.servbay.demo
npm init

npm init 会引导您填写项目名称、版本、描述、入口文件等信息。您也可以使用 npm init -y 来快速生成一个默认的 package.json 文件。

安装项目依赖

在项目的根目录（包含 package.json 文件的目录）下，可以使用 npm install 命令安装项目中所需的所有依赖包。

cd /Applications/ServBay/www/my-project.servbay.demo
npm install

这条命令会读取 package.json 文件中的 dependencies 和 devDependencies 字段，并下载安装相应的模块到项目的 node_modules 目录中。

添加新的依赖包

当您的项目需要引入新的库或框架时，可以使用 npm install <package-name> 命令来安装。

# 安装一个运行时依赖，例如 Express 框架
npm install express

# 安装一个开发时依赖，例如用于测试的 Mocha
npm install mocha --save-dev

默认情况下，npm install <package-name> 会将包安装到项目的 node_modules 目录，并自动更新 package.json 文件中的 dependencies 字段。使用 --save-dev 标志会将包添加到 devDependencies 字段，这通常用于开发、测试或构建工具。

移除依赖包

如果项目不再需要某个依赖包，可以使用 npm uninstall <package-name> 命令来移除它。

npm uninstall express

这会从 node_modules 目录中删除该包，并更新 package.json 文件。

更新项目依赖

为了确保项目依赖的版本是最新的（在 package.json 指定的范围之内），可以使用 npm update 命令。

npm update

这条命令会检查 node_modules 中已安装的包，并根据 package.json 文件中的版本范围更新到最新的兼容版本。

使用 npm 脚本 (Scripts)

package.json 文件中的 scripts 字段允许您定义自定义的命令行脚本。这是一种非常方便的方式来自动化重复性任务，例如运行开发服务器、执行测试、构建项目等。

例如，您可以在 package.json 文件中添加如下 scripts：

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js",
    "test": "mocha test/**/*.js",
    "build": "webpack --config webpack.config.js"
  },
  "dependencies": {
    "express": "^4.18.2"
  },
  "devDependencies": {
    "mocha": "^10.2.0",
    "webpack": "^5.89.0"
  }
}

然后，您就可以在终端中使用 npm run <script-name> 命令来执行这些脚本：

# 启动应用
npm start

# 运行测试
npm test

# 执行构建
npm run build

注意，对于 start, test, install, restart, stop 等少数几个特定的脚本名称，您可以省略 run，直接使用 npm start, npm test 等。

常用 npm 命令速查

除了上面介绍的核心用法，还有一些其他常用的 npm 命令：

• 安装全局包：用于安装可以在系统任何位置使用的命令行工具。

  npm install -g <package-name>
  # 例如，安装用于运行临时命令的 npx (通常与 Node.js 一起安装)
  npm install -g npx
  # 例如，安装常用的命令行工具 nodemon，用于开发时自动重启应用
  npm install -g nodemon

• 执行临时命令 (npx)：npx 是 npm 5.2+ 版本自带的工具，用于执行 node_modules/.bin 目录下的可执行文件，或者临时下载并运行一个包中的命令，而无需全局安装。

  # 在不全局安装 create-react-app 的情况下创建一个新的 React 应用
  npx create-react-app my-react-app

• 查看全局安装的包：列出所有全局安装的包及其版本。

  npm list -g --depth=0

• 清理 npm 缓存：有时安装出错可能是缓存问题，清理缓存可能有助于解决。

  npm cache clean --force

• 查看包信息：查看某个包的详细信息，包括版本、依赖、仓库地址等。

  npm view <package-name>

• 搜索包：在 npm 仓库中搜索包。

  npm search <keyword>

故障排除

• npm command not found: 确保您已通过 ServBay 安装了 Node.js 软件包，并且您的终端会话能够访问到 Node.js 和 npm 的安装路径。通常重启终端或电脑可以解决路径问题。
• 安装依赖失败: 检查网络连接。有时公司的代理设置会影响 npm 安装，可能需要配置 npm 的代理。也可以尝试清理 npm 缓存 (npm cache clean --force) 后重试。
• 权限问题: 在 macOS 上，全局安装 (npm install -g) 有时会遇到权限问题。推荐使用 Node Version Manager (nvm) 或确保 ServBay 正确配置了安装路径，避免直接使用 sudo 进行全局安装，因为这可能导致更复杂的问题。ServBay 安装的 Node.js 通常已经处理了权限问题，允许用户在 ServBay 的安装目录下进行操作。

总结

通过 ServBay，您可以轻松地在本地环境中获得一个功能齐全的 Node.js 开发环境，并立即开始使用强大的 npm 工具进行包管理和项目开发。掌握 npm 的基本用法和常用命令，将极大地提升您的开发效率。随着您对 Node.js 生态系统的深入，npm 将是您不可或缺的伙伴。