AdguardBrowserExtension

<p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cdn.adguard.com/public/Adguard/Common/Logos/ext_dark.svg" width="300px" alt="AdGuard浏览器扩展" /> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/df045752-d844-4068-8557-609eb4e1d54f.svg" width="300px" alt="AdGuard浏览器扩展"/> </picture> </p> <h3 align="center">具有高级隐私保护功能的广告拦截器</h3> <p align="center"> AdGuard是一款快速轻量的广告拦截浏览器扩展，<br/>能有效拦截各种类型的广告和跟踪器。 </p> <p align="center"> <a href="https://adguard.com/">AdGuard.com</a> | <a href="https://reddit.com/r/Adguard">Reddit</a> | <a href="https://twitter.com/AdGuard">Twitter</a> | <a href="https://t.me/adguard_en">Telegram</a> <br /><br /> </a> <a href="https://github.com/AdguardTeam/AdguardBrowserExtension/releases"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/609d5113-08ab-482a-a000-dc11cf06ef03.svg" alt="最新版本" /> </a> <a href="https://addons.mozilla.org/en-US/firefox/addon/adguard-adblocker/"> <img src="https://img.shields.io/amo/v/adguard-adblocker?labelColor=orange" alt="Mozilla 扩展版本" /> </a> </p> <br /> <p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cdn.adguard.com/public/Adguard/Common/adguard_extension_settings_dark.png" width="900px" alt="AdGuard浏览器扩展" /> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/927ef0c7-5e25-4120-a0fe-50fe028b08df.png" width="900px" alt="AdGuard浏览器扩展"/> </picture> </p>

AdGuard是一款快速轻量的广告拦截浏览器扩展，能有效拦截所有网页上的各种类型广告和跟踪器。我们专注于高级隐私保护功能，不仅可以拦截已知的跟踪器，还能防止网站建立您的隐藏档案。与其独立版本(Windows版、Mac版)不同，浏览器扩展完全免费且开源。您可以在这里了解更多关于它们之间的区别。

AdGuard不会收集您的任何信息，也不参与任何可接受的广告计划。我们唯一的收入来源是销售软件的高级版本，我们打算继续保持这种方式。

• 安装
  • Chrome和基于Chromium的浏览器
  • Firefox
  • Opera
  • Microsoft Edge
• 贡献
  • 翻译AdGuard
  • 测试AdGuard
  • 报告问题
  • 其他选项
• 开发
  • 要求
  • 如何构建
    • 测试和开发版构建
    • 与tsurlfilter/tswebextension的开发版本链接
    • 构建beta版和正式版
    • 分析包大小
  • 代码检查
  • 更新本地化
• 最低支持的浏览器版本

<a id="installation"></a>

安装

<a id="installation-chrome"></a>

Chrome和基于Chromium的浏览器

您可以从Chrome网上应用店获取最新可用的AdGuard扩展版本。

<a id="installation-firefox"></a>

Firefox

您可以从Mozilla附加组件网站获取AdGuard扩展的最新版本。

<a id="installation-opera"></a>

Opera

Opera本质上是一个Chromium浏览器，但它维护自己的扩展商店。 您可以从那里获取AdGuard扩展。

<a id="installation-edge"></a>

Microsoft Edge

AdGuard浏览器扩展的最新稳定版本可在Microsoft Store获取。

<a id="contribution"></a>

贡献

我们很幸运有一个不仅热爱AdGuard，还会回馈的社区。许多人以各种方式自愿帮助改善其他用户使用AdGuard的体验，您也可以加入他们！

我们也很乐意奖励社区中最活跃的成员。那么，您可以做些什么呢？

<a id="contribution-translating"></a>

翻译AdGuard

如果您想帮助翻译AdGuard，请在这里了解更多关于翻译我们产品的信息：https://kb.adguard.com/en/general/adguard-translations

<a id="contribution-testing"></a>

测试AdGuard

您可以获取任何浏览器的AdGuard浏览器扩展beta版。 所有关于这个主题的必要信息都可以在我们网站的专门页面上找到。

<a id="contribution-reporting"></a>

报告问题

GitHub可用于报告bug或提交功能请求。要做到这一点，请前往此页面并点击New issue按钮。

[!注意] 对于与过滤器相关的问题（遗漏的广告、误报等），请使用专门的仓库。

<a id="contribution-other"></a>

其他选项

这里有一个专门的页面，适合那些愿意贡献的人。

<a id="dev"></a>

开发

<a id="dev-requirements"></a>

要求

• node.js LTS
• NPM v8
• yarn v1.22

通过运行以下命令安装本地依赖：

  yarn install

<a id="dev-build"></a>

如何构建

测试和开发版构建

运行测试：

  yarn test

运行以下命令来构建开发版：

  yarn dev

这将在build目录下为所有浏览器创建未打包的扩展：

  build/dev/chrome
  build/dev/edge
  build/dev/firefox-amo
  build/dev/firefox-standalone
  build/dev/opera

要为特定浏览器构建开发版，请运行：

yarn dev <browser>

其中 <browser> 是以下选项之一: chrome, edge, opera, firefox, firefox-standalone, 例如:

yarn dev chrome

要在监视模式下运行开发构建，执行:

yarn dev --watch

或者针对特定浏览器:

yarn dev <browser> --watch

与 tsurlfilter/tswebextension 的开发版本链接

从 v4.0 版本开始,AdGuard 浏览器扩展使用开源库 tsurlfilter 来实现过滤引擎。

在开发浏览器扩展时,可能需要测试对 tsurlfilter 的更改。以下是将本地开发构建链接到 tsurlfilter 本地开发构建的步骤:

1. 克隆并构建 tsurlfilter 库。

2. 进入 tsurlfilter/packages/tsurlfilter 和 tsurlfilter/packages/tswebextension 目录,运行 yarn link。

3. 现在可以将这些包链接到浏览器扩展。在浏览器扩展根目录下运行以下 yarn link 命令:

yarn link @adguard/tsurlfilter
yarn link @adguard/tswebextension

4. 在监视模式下构建浏览器扩展:

yarn dev <browser> --watch

构建 beta 和 release 版本

在构建 release 版本之前,应手动下载将包含在构建中的必要资源:过滤器和公共后缀列表。

yarn resources

此命令还会检查过滤器中是否存在危险规则。 参见 dangerous rules

yarn beta
yarn release

需要将 certificate.pem 文件放入 ./private 目录。这个构建将创建未打包的扩展,然后将它们打包(Chrome 的 crx)。

分析包大小

如果想分析包大小,请使用 ANALYZE 环境运行构建:

yarn cross-env ANALYZE=true yarn <build command>

例如,如果想分析 Chrome 的 beta 构建,运行:

yarn cross-env ANALYZE=true yarn beta chrome

或者如果想分析所有 beta 构建,运行:

yarn cross-env ANALYZE=true yarn beta

分析器将生成报告到 ./build/analyze-reports 目录,格式如下:

build/analyze-reports
├── <browser-name>-<build-type>.html

<a id="dev-linter"></a>

代码检查器

尽管我们的代码目前可能不完全符合新的样式配置, 请在你的编辑器中设置 eslint 以遵循 .eslintrc

<a id="dev-localizations"></a>

更新本地化

要下载并附加本地化,运行:

yarn locales download

要将新短语上传到 crowdin,需要 ./Extension/_locales/en/messages.json 文件。然后运行:

yarn locales upload

要从本地消息中删除旧消息,运行:

yarn locales renew

要验证翻译,运行:

yarn locales validate

要显示本地化信息,运行:

yarn locales info

<a id="minimum-supported-browser-versions"></a>

最低支持的浏览器版本

浏览器	版本
基于 Chromium 的浏览器	80
Firefox	78
Firefox Mobile	113
Opera	67
Edge	80