Parcel Plugin for Web Extension: 从零搭建指南

2024-09-12 07:04:42作者：牧宁李

1. 目录结构及介绍

在使用parcel-plugin-web-extension时，一个典型的项目目录可能包括以下几个关键部分：

src: 这是主要的源代码目录，存放所有的JavaScript、HTML、CSS文件以及Web扩展的其他资源。例如，可能包含manifest.json作为入口点，背景脚本（background scripts）、内容脚本（content scripts）等。
manifest.json: 位于src目录下或根目录，这是Web扩展的核心配置文件，描述了扩展的功能、权限需求、图标和其他元数据。
public: 如果有静态资源需要被公共访问，如图片或样式文件，通常会放置在这里，并通过web_accessible_resources配置使其可访问。
src/background: 包含扩展的后台脚本文件夹，如果有的话。
src/content-scripts: 存放用于注入到目标网页的内容脚本。
.parcelrc 或者相关配置文件: 可能包含特定于Parcel的配置，比如指定使用parcel-plugin-web-extension。
package.json: 包含了项目的元数据，以及npm/yarn脚本，如启动命令和依赖信息。

2. 项目的启动文件介绍

在基于parcel-plugin-web-extension的项目中，主要的启动文件并非传统意义上的单一“启动”文件，而是manifest.json。这个文件告诉浏览器扩展的基本信息和配置。你通过以下方式启动项目：

npm run start 或者 yarn start

这背后的逻辑由package.json中的脚本定义，它通常调用Parcel来监视并自动打包你的应用，确保开发过程中的快速反馈循环。

3. 项目的配置文件介绍

(a) `manifest.json`

核心配置: 定义扩展的名称、版本、所需权限、脚本位置、图标等。对于MV3架构，还需关注服务工作者的配置。

(b) `.parcelrc` 或 Parcel 配置

虽然不是项目强制要求的，但通过创建.parcelrc，你可以指定parcel-plugin-web-extension为构建插件，确保Parcel处理Web扩展项目时遵循特定规则，例如：

{
  "extends": "@parcel/config-web-extension"
}

或者在package.json里指定Parcel配置：

{
  "parcelConfig": {
    "extends": "@parcel/config-web-extension"
  }
}

这一步简化了配置流程，确保插件正确集成。

(c) `package.json`

这里的配置主要是定义项目的依赖、脚本命令等。对于启动和构建流程来说至关重要：

{
  "scripts": {
    "start": "parcel serve src/manifest.json",
    "build": "parcel build src/manifest.json"
  },
  "devDependencies": {
    "parcel-plugin-web-extension": "^版本号"
  }
}