PWAsForFirefox 项目使用教程

1. 项目的目录结构及介绍

PWAsForFirefox 项目的目录结构如下：

PWAsForFirefox/
├── editorconfig
├── gitattributes
├── gitignore
├── LICENSE
├── README.md
├── crowdin.yml
├── docs/
├── extension/
│   ├── background/
│   ├── content/
│   ├── icons/
│   ├── locale/
│   ├── options/
│   ├── popup/
│   ├── scripts/
│   ├── styles/
│   ├── _locales/
│   ├── manifest.json
│   └── ...
├── native/
│   ├── src/
│   └── Cargo.toml
└── ...

目录介绍

• editorconfig, gitattributes, gitignore: 项目配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• crowdin.yml: 用于本地化配置。
• docs/: 项目文档目录。
• extension/: 扩展的主要代码目录。
  • background/: 后台脚本。
  • content/: 内容脚本。
  • icons/: 图标文件。
  • locale/: 本地化文件。
  • options/: 选项页面。
  • popup/: 弹出页面。
  • scripts/: 其他脚本。
  • styles/: 样式文件。
  • _locales/: 多语言支持。
  • manifest.json: 扩展的清单文件。
• native/: 本地应用相关代码。
  • src/: 源代码。
  • Cargo.toml: Rust 项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 extension/manifest.json，它是 Firefox 扩展的清单文件，包含了扩展的基本信息和启动配置。

manifest.json 文件介绍

{
  "manifest_version": 2,
  "name": "PWAsForFirefox",
  "version": "2.12.1",
  "description": "A tool to install, manage, and use Progressive Web Apps (PWAs) in Mozilla Firefox.",
  "icons": {
    "48": "icons/icon.png"
  },
  "background": {
    "scripts": ["background/background.js"]
  },
  "browser_action": {
    "default_icon": "icons/icon.png",
    "default_popup": "popup/popup.html"
  },
  "permissions": [
    "webRequest",
    "webRequestBlocking",
    "tabs",
    "activeTab",
    "storage",
    "https://*/*"
  ],
  "content_scripts": [
    {
      "matches": ["https://*/*"],
      "js": ["content/content.js"]
    }
  ]
}

启动文件功能

• manifest_version: 指定清单文件的版本。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• icons: 扩展的图标。
• background: 后台脚本配置。
• browser_action: 浏览器动作配置。
• permissions: 扩展所需的权限。
• content_scripts: 内容脚本配置。

3. 项目的配置文件介绍

项目的配置文件主要包括 editorconfig, gitattributes, gitignore, crowdin.yml, 和 native/Cargo.toml。

editorconfig

用于统一代码编辑器的配置，确保代码风格一致。

gitattributes

用于指定 Git 如何处理文件的属性，例如换行符的处理。

gitignore

用于指定 Git 忽略的文件和目录。

crowdin.yml

用于本地化配置，与 Crowdin 集成。

native/Cargo.toml

Rust 项目的配置文件，包含项目的依赖和构建配置。

[package]
name = "native"
version = "0.1.0"
edition = "2018"

[dependencies]
ser