AdGuard Scriptlets 项目使用教程

1. 项目目录结构及介绍

AdGuard Scriptlets 项目是一个用于内容屏蔽的JavaScript函数库。以下是项目的目录结构及各部分的简要介绍：

AdguardTeam/Scriptlets/
├── .github/              # GitHub 工作流程和配置文件
├── bamboo-specs/         # Bamboo CI 配置文件
├── scripts/              # 脚本文件，用于项目构建和测试
├── src/                  # 源代码目录，包含Scriptlets的实现
├── tests/                # 测试代码目录
├── types/                # 类型定义文件
├── wiki/                 # 项目文档和指南
├── .env-example          # 环境变量示例文件
├── .eslintignore         # ESLint 忽略文件
├── .eslintrc.cjs         # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .markdownlint.json    # Markdown Lint 配置文件
├── .markdownlintignore   # Markdown Lint 忽略文件
├── CHANGELOG.md          # 项目更新日志
├── LICENSE               # 项目许可证信息
├── README.md             # 项目说明文件
├── babel.config.js       # Babel 配置文件
├── browserstack.js       # BrowserStack 测试配置文件
├── package.json          # Node.js 项目配置文件
├── pnpm-lock.yaml        # pnpm 锁文件
├── rollup.config.js      # Rollup 打包配置文件
├── tsconfig.build.json   # TypeScript 编译配置文件
├── tsconfig.json         # TypeScript 编译配置文件
└── vitest.config.ts      # Vitest 测试配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 pnpm 包管理器。在项目根目录下，可以通过以下命令安装依赖并启动项目：

pnpm install         # 安装项目依赖
pnpm build           # 构建项目

构建完成后，可以使用以下命令运行测试：

pnpm test            # 运行所有测试

具体测试某个Scriptlet或Redirect，可以使用如下命令：

pnpm test:qunit scriptlets --name set-cookie  # 测试 set-cookie Scriptlet
pnpm test:qunit redirects --name ati-smarttag  # 测试 ati-smarttag Redirect

3. 项目的配置文件介绍

项目中有几个主要的配置文件，以下是它们的简要介绍：

• .eslintrc.cjs: ESLint 配置文件，用于指定代码风格规则和检查标准。
• package.json: Node.js 项目配置文件，包含了项目的名称、版本、描述、依赖、脚本等信息。
• tsconfig.json: TypeScript 编译配置文件，用于配置TypeScript的编译选项。
• vitest.config.ts: Vitest 测试配置文件，用于配置测试环境和测试选项。

这些配置文件为项目的开发提供了标准和规则，确保代码质量和项目的一致性。