Установка через yarn

Для интеграции библиотеки Axe-core в проект на JavaScript оптимальным способом является использование менеджера пакетов Yarn, что обеспечивает управление зависимостями, кеширование и контроль версий.

Подготовка проекта

Перед установкой необходимо убедиться, что проект инициализирован как Node.js проект. Если файл package.json отсутствует, его создают командой:

yarn init -y

Это создаст минимальный package.json с базовыми настройками проекта.

Установка библиотеки

Для установки последней стабильной версии Axe-core используется команда:

yarn add axe-core

Эта команда выполнит следующие действия:

  • Скачает пакет axe-core из реестра Yarn/npm.
  • Добавит зависимость в секцию dependencies файла package.json.
  • Обновит файл yarn.lock для фиксирования точной версии пакета, что гарантирует одинаковое поведение при установке на других машинах.

Использование Dev-зависимости

Если библиотека необходима только для тестирования и анализа доступности, её целесообразно установить как dev-зависимость:

yarn add axe-core --dev

Это позволит не включать библиотеку в production-бандл и сохранить размер итогового кода минимальным. В package.json такая зависимость будет отображена в разделе devDependencies.

Проверка установки

После завершения установки важно убедиться, что пакет доступен для импорта. В Node.js или тестовых файлах можно проверить следующим образом:

const axe = require('axe-core');

console.log(axe.version); // Должна выводиться версия библиотеки

Для проектов с использованием ES-модулей:

import axe from 'axe-core';

console.log(axe.version);

Обновление Axe-core через Yarn

Поддержание библиотеки в актуальном состоянии важно для получения последних исправлений безопасности и улучшений функциональности. Обновление выполняется командой:

yarn upgrade axe-core

Для точного контроля версии можно указать номер версии:

yarn add axe-core@4.9.2

Настройка Yarn для монорепозиториев

В проектах с несколькими пакетами (монорепозиториях) установка axe-core может производиться локально в конкретном пакете:

yarn workspace package-name add axe-core

Или глобально для всех пакетов через workspaces:

yarn workspaces foreach add axe-core

Преимущества использования Yarn

  • Быстрая установка за счет кеширования.
  • Детерминированные версии с помощью yarn.lock.
  • Удобная работа с монорепозиториями.
  • Разделение зависимостей на production и dev, что важно для тестовых библиотек вроде Axe-core.

Типичные ошибки при установке

  1. Отсутствие package.json — Yarn не сможет добавить зависимость. Решение: yarn init -y.
  2. Несовместимость версии Node.js — Axe-core требует Node.js 12+ для корректной работы.
  3. Конфликты зависимостей — могут возникать при наличии других библиотек, использующих старые версии Axe-core. В таком случае рекомендуется использовать yarn resolutions для фиксации версии.

Интеграция с тестовыми фреймворками

После установки через Yarn Axe-core легко подключается к Jest, Mocha, Cypress или другим тестовым инструментам. Например, для Jest:

import { configureAxe } from 'axe-core';

const axe = configureAxe({
  rules: {
    'color-contrast': { enabled: true },
  },
});

test('доступность компонента', async () => {
  const results = await axe.run(document.body);
  expect(results.violations).toHaveLength(0);
});

Это позволяет сразу использовать установку для анализа доступности элементов и соблюдения стандартов WCAG.

Итог

Установка через Yarn обеспечивает надежное управление версией Axe-core, удобство работы с зависимостями и интеграцию с современными инструментами тестирования. Использование dev-зависимостей минимизирует размер production-бандла, а контроль версий через yarn.lock гарантирует стабильность работы в командной разработке.

Оглавление