安装 Plasmo

学习如何在您的开发环境中安装 Plasmo CLI,并初始化您的第一个 Plasmo 浏览器扩展项目。

安装 Plasmo

本指南将引导您完成 Plasmo CLI (命令行界面) 的安装,并创建您的第一个 Plasmo 项目。

系统要求

在开始之前,请确保您的开发环境满足以下要求:

  • Node.js: 版本 18.x 或更高版本。我们推荐使用最新的 LTS (长期支持) 版本。您可以从 Node.js 官网下载。
  • 包管理器: Plasmo 推荐使用 pnpm (版本 8.x 或更高)。您也可以使用 npm (通常随 Node.js 一起安装) 或 yarn。
    # 通过 npm 安装 pnpm (如果尚未安装)
    npm install -g pnpm
    
  • 浏览器: 最新版本的 Google Chrome, Microsoft Edge, Firefox 或其他支持 WebExtensions API 的现代浏览器,用于测试您的扩展。

创建一个新的 Plasmo 项目

创建新的 Plasmo 项目非常简单。打开您的终端并运行以下命令 (推荐使用 pnpm):

# 使用 pnpm (推荐)
pnpm create plasmo

# 或者使用 npx (npm)
# npx create-plasmo@latest

# 或者使用 yarn
# yarn create plasmo

CLI 工具会引导您完成项目的初始化过程,包括:

  1. 项目名称: 输入您的项目名称。
  2. 选择模板: 您可以选择使用 TypeScript 还是 JavaScript,以及是否集成 React, Svelte, Vue 等框架。对于初学者,选择默认的 React + TypeScript 通常是个不错的开始。
  3. 其他选项: 根据提示选择是否需要内容脚本、背景服务工作线程等。

项目创建完成后,CLI 会提示您进入项目目录。

进入项目目录并安装依赖

cd your-project-name # 将 your-project-name 替换为您实际的项目名
pnpm install         # 如果您选择了 pnpm
# npm install        # 如果您选择了 npm
# yarn install       # 如果您选择了 yarn

此命令会下载并安装项目所需的所有依赖项。

启动开发服务器

安装完依赖后,您可以启动 Plasmo 开发服务器:

pnpm dev   # 如果您选择了 pnpm
# npm run dev # 如果您选择了 npm
# yarn dev    # 如果您选择了 yarn

开发服务器启动后,Plasmo 会:

  • build/ 目录下生成一个未打包的浏览器扩展 (例如 build/chrome-mv3-dev)。
  • 监听文件变化,并在您修改代码时自动重新构建扩展 (热重载)。

接下来,您需要将这个未打包的扩展加载到您的浏览器中进行测试。具体步骤请参考 加载未打包的扩展 (我们稍后会创建此页面)。

恭喜!您已经成功安装了 Plasmo 并创建了您的第一个项目。现在您可以开始构建您的浏览器扩展了。

如果您有什么疑问,可以继续学习如何 创建您的第一个Plasmo项目 ,这里有更详细的指导。