# iPerf.js

iPerf is a simple performance testing framework for front-end renderers. It is developed based on Vite and supports testing rendering time, frame rate, and can collect hardware information.

## Install

```bash
npm install iperf --save-dev
```

## Usage

1. Create a test file, e.g. `test.perf.ts`:

```typescript
export const TestName = async ({ perf, container }) => {
  // Test the rendering duration by marking the start and end of the rendering process
  const canvas = document.createElement('canvas');
  container.appendChild(canvas);

  const ctx = canvas.getContext('2d');
  perf.mark('start');
  for (let i = 0; i < 1000; i++) {
    ctx.fillRect(0, 0, 100, 100);
  }
  perf.mark('end');
  perf.measure('rendering', 'start', 'end');

  // Test the rendering duration by giving a callback function
  await perf.evaluate('rendering', () => {
    for (let i = 0; i < 1000; i++) {
      ctx.fillRect(0, 0, 100, 100);
    }
  });

  // Record the frame rate
  requestAnimationFrame(function loop() {
    perf.frame();
    ctx.clearRect(0, 0, 100, 100);
    ctx.fillRect(0, 0, 100, 100);
    requestAnimationFrame(loop);
  });
};
```

2. Run the test:

```bash
npx perf
```

### Run specific test files

You can specify which test files to run using the `--file` or `-f` option:

```bash
# Run a single test file
npx perf --file test.perf.ts

# Run multiple test files
npx perf --file test1.perf.ts test2.perf.ts

# Short form
npx perf -f test.perf.ts
```

By default, iPerf will run all files matching the pattern `**/*.perf.ts` in your project.

## Configuration

You can configure iPerf by creating a `perf.config.js` file in the root of your project:

```javascript
import { defineConfig } from 'iperf';

export default defineConfig({
  perf: {
    socket: {
      port: 7880,
      timeout: 60 * 1000,
    },
    report: {
      dir: 'perf/reports-1',
    },
  },
  // other vite options
});
```

## Preview Mode

In this mode, iPerf will open a browser window to preview the test. You can enable it by adding the `preview` option:

```bash
npx perf preview
```


## License

&copy; 2024 Aarebecca. ISC License.