@alecto/project-html-css-validator

@alecto/project-html-css-validator — це інструмент для розробників і QA-інженерів, який автоматизує перевірку якості коду веб-проектів, допомагаючи виявляти помилки в HTML, CSS і забезпечувати відповідність кодстайлу.

Зміст

• Опис проекту
• Особливості
• Системні вимоги
• Встановлення
• Валідація коду
• Розміщення проектів для валідації
• Результати валідації
• Система повторних спроб
• Залежності
• Налаштування
• Примітки
• Ліцензія

Опис проекту

HTML-CSS-VALIDATOR - це інструмент для автоматичної валідації коду веб-проектів, що включає:

• Валідацію HTML-файлів через офіційний W3C валідатор
• Валідацію CSS-файлів через W3C CSS валідатор
• Перевірку базового кодстайлу через EditorConfig
• Інтелектуальну систему повторних спроб при перевищенні лімітів запитів

Особливості

• Автоматичний режим повторних спроб при помилках з'єднання або обмеженнях API валідаторів
• Детальне логування результатів з кольоровим виводом
• Підтримка пакетної перевірки декількох файлів
• Зручні скрипти для швидкого запуску
• Виявлення та звітування про помилки структури HTML
• Перевірка стилів CSS на відповідність стандартам W3C
• Інтелектуальна обробка обмежень API (429 Too Many Requests)

Системні вимоги

• Windows 10/11
• Node.js LTS версії
• npm або yarn

Примітка: Для macOS та Linux функціональність обмежена. BAT-файли не працюють, використовуйте npm/yarn команди.

Встановлення

1. Скачайте та встановіть Node.js LTS версії з офіційного сайту

2. Склонуйте або завантажте проект

   Важливо: У шляху до папки з проектом не повинно бути кирилиці, пробілів та спеціальних символів

3. Відкрийте консоль у папці проекту та виконайте:

   npm install

   або якщо ви використовуєте Yarn:

   yarn

Валідація коду

Через npm/yarn

Відкрийте консоль у папці проекту та виконайте одну з команд:

npm run all          # Валідація HTML, CSS та перевірка EditorConfig
npm run validate     # Валідація тільки HTML та CSS
npm run editorconfig # Перевірка тільки EditorConfig

Якщо ви використовуєте Yarn:

yarn all
yarn validate
yarn editorconfig

Через BAT-файли (тільки для Windows)

В папці tests розташовані BAT-файли для швидкого запуску:

• !all.bat - валідація HTML, CSS та перевірка EditorConfig
• !editorconfig.bat - перевірка EditorConfig

Розміщення проектів для валідації

1. Скопіюйте папку проекту, який потрібно перевірити, в директорію:

   project-html-css-validator\tests\

2. Запустіть потрібний скрипт валідації

Результати валідації

Результати виводяться в консоль із кольоровим форматуванням:

• Зелений текст - валідні файли без помилок
• Червоний текст - виявлені помилки у файлах
• Жовтий текст - попередження або інформаційні повідомлення

Приклад виводу результатів:

 ----- Тестування файлу... -----
 index.html Валідний
 ----- Тестування файлу... -----
 styles.css НЕ валідний
Рядок 15: Властивість 'display' має невірне значення

Система повторних спроб

Валідатор має вбудовану систему повторних спроб при обмеженнях API сервера W3C:

1. Перша спроба виконується одразу
2. У разі невдачі - друга спроба через 2 секунди
3. Якщо і друга спроба невдала - третя спроба через 5 секунд

Це дозволяє успішно обробляти тимчасові обмеження серверів валідації (429 Too Many Requests).

Залежності

Основні залежності проекту:

• w3c-html-validator - для валідації HTML-коду
• w3c-css-validator - для валідації CSS-коду
• editorconfig-checker - для перевірки відповідності кодстайлу
• chalk - для кольорового форматування виводу

Детальніше у файлі package.json.

Налаштування

Валідатор автоматично виключає з перевірки такі папки:

• libs
• img
• psd
• bootstrap
• node_modules
• Файли нормалізації стилів (normalize.css, reset.css)

Ви можете налаштувати виключення, змінивши параметри в скриптах у файлі package.json.

Примітки

• Проект розроблено для особистого використання та надається "як є"
• Код відкритий для вивчення та модифікації під власні потреби
• Оновлення та виправлення вносяться за потреби розробника

Ліцензія

ISC License