Polly.js 开源项目教程

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

Polly.js 项目的目录结构如下：

pollyjs/
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── docs/
│   ├── quick-start.md
│   └── ...
├── examples/
│   └── ...
├── packages/
│   ├── @pollyjs/adapter-fetch/
│   ├── @pollyjs/adapter-xhr/
│   ├── @pollyjs/core/
│   ├── @pollyjs/persister-local-storage/
│   ├── @pollyjs/persister-rest/
│   └── ...
├── scripts/
│   └── ...
└── tests/
    └── ...

目录介绍

• CONTRIBUTING.md: 贡献指南文件，指导如何为项目贡献代码。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• docs/: 包含项目的文档，如快速开始指南等。
• examples/: 包含示例代码，展示如何使用 Polly.js。
• packages/: 包含项目的各个包，如核心包、适配器和持久化器等。
• scripts/: 包含项目的脚本文件，如构建和测试脚本。
• tests/: 包含项目的测试文件。

2. 项目的启动文件介绍

Polly.js 的启动文件主要位于 packages/@pollyjs/core 目录下。核心包 @pollyjs/core 是 Polly.js 的核心模块，负责管理请求的录制、回放和存根。

启动文件

• index.js: 核心包的入口文件，导出 Polly 类和其他核心功能。
• polly.js: Polly 类的实现文件，包含 Polly 实例的创建和管理。

3. 项目的配置文件介绍

Polly.js 的配置文件主要通过代码进行配置，没有独立的配置文件。配置可以通过创建 Polly 实例时传入的选项对象进行设置。

配置示例

import { Polly } from '@pollyjs/core';
import FetchAdapter from '@pollyjs/adapter-fetch';
import LocalStoragePersister from '@pollyjs/persister-local-storage';

Polly.register(FetchAdapter);
Polly.register(LocalStoragePersister);

const polly = new Polly('Simple Example', {
  adapters: ['fetch'],
  persister: 'local-storage',
  recordIfMissing: true,
});

配置选项

• adapters: 指定使用的适配器，如 fetch 或 xhr。
• persister: 指定使用的持久化器，如 local-storage 或 rest。
• recordIfMissing: 如果请求未被录制，是否进行录制。

通过以上配置，可以灵活地控制 Polly.js 的行为，满足不同的测试需求。