AdGuardSDNSFilter 开源项目使用教程

AdGuardSDNSFilter 开源项目使用教程

AdGuardSDNSFilterAdGuard DNS filter项目地址:https://gitcode.com/gh_mirrors/ad/AdGuardSDNSFilter

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

AdGuardSDNSFilter 项目的目录结构如下：

AdGuardSDNSFilter/
├── Filters/
│   └── filter.txt
├── README.md
├── package.json
├── yarn.lock
└── src/
    └── ...

目录结构介绍

• Filters/: 包含过滤规则文件 filter.txt，这是 AdGuard Home 和公共 AdGuard DNS 服务器的默认过滤器。
• README.md: 项目说明文档，包含项目的基本信息和使用指南。
• package.json: 项目的依赖管理文件，定义了项目所需的依赖和脚本。
• yarn.lock: 锁定依赖版本的文件，确保在不同环境下安装相同的依赖版本。
• src/: 项目的源代码目录，包含构建过滤器所需的脚本和配置。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中定义的脚本。以下是常用的启动命令：

{
  "scripts": {
    "install": "yarn install",
    "build": "yarn run build"
  }
}

启动命令介绍

• yarn install: 安装项目依赖。
• yarn run build: 构建过滤器，输出到 Filters/filter.txt。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 src/ 目录下的脚本文件。以下是主要的配置文件：

package.json

{
  "name": "AdGuardSDNSFilter",
  "version": "1.0.0",
  "scripts": {
    "install": "yarn install",
    "build": "yarn run build"
  },
  "dependencies": {
    ...
  }
}

src/ 目录下的脚本文件

src/ 目录下的脚本文件用于构建过滤器。具体文件和功能如下：

• build.js: 构建过滤器的入口脚本，负责生成 Filters/filter.txt。
• config.js: 配置文件，定义过滤器的规则和来源。

通过以上配置和脚本，可以手动构建 AdGuard DNS 过滤器。

---

以上是 AdGuardSDNSFilter 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

AdGuardSDNSFilterAdGuard DNS filter项目地址:https://gitcode.com/gh_mirrors/ad/AdGuardSDNSFilter