开源项目 `predirect` 使用教程

开源项目 predirect 使用教程

predirectA manifest v3 web extension with minimal permissions to automatically redirect to privacy friendly frontends. ⭐️ Star to support our work!项目地址:https://gitcode.com/gh_mirrors/pr/predirect

本文档将详细介绍开源项目 predirect 的目录结构、启动文件和配置文件。项目链接：https://github.com/libreom/predirect.git

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

predirect 项目的目录结构如下：

predirect/
├── manifest.json
├── background.js
├── icons/
│   ├── icon16.png
│   ├── icon48.png
│   └── icon128.png
├── README.md
└── LICENSE

目录结构介绍

• manifest.json: 项目的配置文件，定义了扩展的基本信息和权限。
• background.js: 后台脚本文件，负责处理扩展的主要逻辑。
• icons/: 存放扩展图标的目录。
  • icon16.png: 16x16 像素的图标。
  • icon48.png: 48x48 像素的图标。
  • icon128.png: 128x128 像素的图标。
• README.md: 项目的说明文档。
• LICENSE: 项目的许可证文件。

2. 项目的启动文件介绍

predirect 项目的启动文件是 background.js。该文件负责处理扩展的主要逻辑，包括自动重定向到隐私友好的前端。

background.js 文件内容概述

// background.js 主要逻辑
chrome.webRequest.onBeforeRequest.addListener(
  function(details) {
    // 重定向逻辑
    return { redirectUrl: "https://privacy-friendly-frontend.com" };
  },
  { urls: ["<all_urls>"] },
  ["blocking"]
);

3. 项目的配置文件介绍

predirect 项目的配置文件是 manifest.json。该文件定义了扩展的基本信息和权限。

manifest.json 文件内容概述

{
  "manifest_version": 3,
  "name": "predirect",
  "version": "1.0",
  "description": "A manifest v3 web extension with minimal permissions to automatically redirect to privacy friendly frontends.",
  "permissions": [
    "webRequest",
    "webRequestBlocking",
    "storage"
  ],
  "background": {
    "service_worker": "background.js"
  },
  "icons": {
    "16": "icons/icon16.png",
    "48": "icons/icon48.png",
    "128": "icons/icon128.png"
  }
}

配置文件介绍

• manifest_version: 指定 manifest 文件的版本，这里是 3。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• permissions: 扩展所需的权限，包括 webRequest、webRequestBlocking 和 storage。
• background: 指定后台脚本文件。
• icons: 指定扩展图标的路径。

通过以上内容，您可以了解 predirect 项目的目录结构、启动文件和配置文件，从而更好地使用和开发该项目。

predirectA manifest v3 web extension with minimal permissions to automatically redirect to privacy friendly frontends. ⭐️ Star to support our work!项目地址:https://gitcode.com/gh_mirrors/pr/predirect