vitest-axe - GitLite

KO | EN

gitlite — search

#ai #typescript #llm #golang #rust #deep-learning #linux #docker #java #kubernetes #vue #security #mcp #openai

vitest-axe

(★ 96)

Custom Vitest matcher for testing accessibility with aXe. Forked from jest-axe.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- - matchers.test.ts.snap
  - readme.test.ts.snap
- axe.ts
- extend-expect.ts
- index.test.ts
- index.ts
- matchers.test.ts
- matchers.ts
- readme.test.ts
- to-have-no-violations.ts
- types.ts
- utils.ts
- setupTests.ts
.editorconfig
.gitignore
.nvmrc
.prettierignore
CHANGELOG.md
eslint.config.js
extend-expect.d.ts
extend-expect.js
LICENSE
matchers.d.ts
matchers.js
package.json
pnpm-lock.yaml
README.md
tsconfig.json
tsup.config.ts
vitest.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/chaance/vitest-axe

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vitest-axe

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install --save-dev vitest-axe

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn add --dev vitest-axe

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm add -D vitest-axe

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<h1>vitest-axe</h1>

<p>Custom Vitest matcher for testing accessibility with aXe</p>

</div>

---

[![version][version-badge]][package]
[![MIT License][license-badge]][license]

[![Watch on GitHub][github-watch-badge]][github-watch]

This library is a fork of [`jest-axe`](https://github.com/nickcolley/jest-axe).
It shares that library's implementation and API. It is intended to make it
easier to include its matchers without clashes between [Vitest][vitest] and
Jest's environment or types.

See the [`README` for the original package](https://github.com/nickcolley/jest-axe/blob/main/README.md) for usage details.

> [!IMPORTANT]
> There is currently a [bug in Happy DOM](https://github.com/capricorn86/happy-dom/issues/978) related to its implementation of `Node.prototype.isConnected`. [This causes compatibility issues with axe,](https://github.com/dequelabs/axe-core/issues/4087) which means that this library will not work if your [Vitest environment](https://vitest.dev/guide/environment.html#test-environment) is set to `happy-dom`.

## Installation

This module should be installed as one of your project's `devDependencies`:

```shell
# with npm
npm install --save-dev vitest-axe
# yarn
yarn add --dev vitest-axe
# pnpm
pnpm add -D vitest-axe
```

## Setup

### Import `vitest-axe/extend-expect` module

The simplest way to use this library is to import `vitest-axe/extend-expect`
from your [test setup file][test setup file].

```js
// vitest-setup.js
import "vitest-axe/extend-expect";
```

### Extend in test setup file

You can also import the matchers from `vitest-axe/matchers` then pass them to
Vitest's `expect.extend` method yourself:

```js
// vitest-setup.js
import * as matchers from "vitest-axe/matchers";
import { expect } from "vitest";
expect.extend(matchers);
```

### Extend in individual tests

```ts
import { expect } from "vitest";
import { axe } from "vitest-axe";
import { toHaveNoViolations } from "vitest-axe/matchers";

expect.extend({ toHaveNoViolations });

it("should have no axe violations", async () => {
	const html = "<html></html>";
	expect(await axe(html)).toHaveNoViolations();
});
```

### With TypeScript

If you [imported the `vitest/extend-expect` module](#import-vitest-axeextend-expect-module)
in your setup file, you should be good to go. Make sure your setup file is
[included in your `tsconfig.json`](https://www.typescriptlang.org/tsconfig#include).

If you do not import the `vitest/extend-expect` module, you will need to augment Vitest's `Assertion` and `AsymmetricMatchersContaining` interfaces.

```ts
import "vitest";
import type { AxeMatchers } from "vitest-axe/matchers";

declare module "vitest" {
	export interface Assertion extends AxeMatchers {}
	export interface AsymmetricMatchersContaining extends AxeMatchers {}
}
```

Further reading:

- [Extending matchers in Vitest](https://vitest.dev/guide/extending-matchers.html)
- [Module augmentation in TypeScript](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation)

## Usage

```ts
import { axe } from "vitest-axe";

it("should demonstrate this matcher's usage", async () => {
	const render = () => '<img src="#"/>';
	// pass anything that outputs html to axe
	const html = render();
	expect(await axe(html)).toHaveNoViolations();
});
```

[vitest]: https://vitest.dev/
[test setup file]: https://vitest.dev/config/#setupfiles
[version-badge]: https://img.shields.io/npm/v/vitest-axe.svg?style=flat-square
[package]: https://www.npmjs.com/package/vitest-axe
[license-badge]: https://img.shields.io/npm/l/vitest-axe.svg?style=flat-square
[license]: https://github.com/chaance/vitest-axe/blob/main/LICENSE
[github-watch-badge]: https://img.shields.io/github/watchers/chaance/vitest-axe.svg?style=social
[github-watch]: https://github.com/chaance/vitest-axe/watchers