webhint

Быстрый старт

webhint — это настраиваемый инструмент проверки кода, который помогает улучшить доступность, производительность, совместимость с браузерами вашего сайта и многое другое, анализируя ваш код на соответствие лучшим практикам и отсутствие распространённых ошибок.

Инструмент можно запустить через командную строку (CLI), в виде расширения для браузера и как расширение для Visual Studio Code.

Чтобы использовать его через командную строку вам потребуется установить версию Node.js (v14.x или выше) на вашем компьютере, а также использовать npx для тестирования.

Тестирование с помощью npx

Запустите следующую команду:

npx hint https://example.com

Это проанализирует https://example_пример.com с использованием базовой конфигурации.

Локальная установка webhint

Установите webhint как зависимость проекта:

npm install hint --save-dev

Добавьте задачу скрипта в ваш package.json:

{
    ...
    "scripts": {
        "webhint": "hint"
    }
}

Запустите её через:

npm run webhint -- http://localhost:8080

Если вы используете yarn, вы можете пропустить шаг создания задачи и запустить непосредственно:```bash yarn hint http://localhost:8080

Для получения более подробной информации о `webhint`, его конфигурации и других возможностях, обратитесь к онлайн [руководству пользователя][user guide] или локальной версии [руководства пользователя][local user guide].

## Вклад в проект `webhint`

Проект следует принципу монорепозитория. Это значит, что код для всех вариантов `webhint` (CLI, браузерное расширение, расширение для Visual Studio Code, правила, форматеры и т.д.) находится здесь и публикуется как отдельные npm пакеты.

Чтобы собрать проект из исходников вам потребуется установить последнюю версию `node` и [yarn][]. После этого выполните следующие команды из корневой директории клонированной версии:

```bash
yarn
yarn build

Сборка может занять некоторое время, поэтому будьте терпеливы.

Для получения более подробной информации о внутреннем устройстве webhint, структуре проекта, создании новых правил, парсеров, форматеров и т.д., обратитесь к онлайн руководству для вкладчиков или локальной версии руководства для вкладчиков.### Вклад в расширение браузера и расширение VS Code

Для того чтобы узнать, как создать одно из этих расширений, проверьте файлы CONTRIBUTING.md каждого из этих пакетов:

• packages/extension-browser/CONTRIBUTING.md для расширения браузера.
• packages/extension-vscode/CONTRIBUTING.md для расширения VS Code.## Кодекс поведения

Все проекты в организации webhintio следуют этому Кодексу поведения, который соответствует Кодексу поведения OpenJS Foundation.

Другие важные ссылки

• [Устав][]
• [Управление][]

Лицензия

Код доступен под лицензией Apache 2.0.