Безкоштовна Ruby-бібліотека для валідації та забезпечення якості HTML-документів
Відкрита PHP-бібліотека для виконання валідації HTML. Вона дозволяє перевірку посилань, тестування доступності, налаштовувані правила, паралельну обробку тощо.
У динамічному світі веб-розробки забезпечення якості та цілісності вашого HTML-коду є надзвичайно важливим. Поламані посилання, недоступні зображення та інші помилки HTML можуть призвести до поганого користувацького досвіду та негативно вплинути на продуктивність вашого веб-сайту. Щоб спростити цей процес, розробники часто покладаються на автоматизовані інструменти та бібліотеки. Однією з таких бібліотек є HTMLProofer, потужний Ruby gem, який допомагає перевіряти HTML-документи та виявляти потенційні проблеми.
HTMLProofer — це бібліотека Ruby з відкритим кодом, яка виконує валідацію HTML, перевіряючи HTML‑документи за набором налаштовуваних правил. Вона використовує бібліотеку HTMLProofer для парсингу HTML і CSS, що робить її дуже ефективною у виявленні різних типів помилок, включаючи биті посилання, проблеми доступності та інші поширені проблеми HTML. Вона слугує цінним інструментом забезпечення якості, дозволяючи розробникам виявляти та виправляти проблеми до того, як вони вплинуть на кінцевих користувачів.
HTMLProofer дуже простий у використанні та пропонує гнучкість, дозволяючи розробникам визначати власний набір правил. Вони можуть вказати, які проблеми ігнорувати або позначати, залежно від вимог проєкту. Він може виявляти відсутні атрибути alt, неправильну структуру заголовків та інші проблеми, пов’язані з доступністю, дозволяючи розробникам покращувати доступність своїх веб‑сайтів. Незалежно від того, чи створюєте ви невеликий веб‑сайт чи масштабний додаток, впроваджуючи бібліотеку у ваш робочий процес розробки, ви можете заощадити час, підвищити якість коду та забезпечити користувачам безперешкодний перегляд.
Початок роботи з HTMLProofer
Рекомендований і найпростіший спосіб встановити HTMLProofer — використати RubyGems, інструмент керування залежностями для Ruby. Будь ласка, використайте наступну команду для безперебійної інсталяції.
$ gem install html-proofer
$ gem install HTMLProoferВи також можете встановити його вручну; завантажте останні файли релізу безпосередньо з репозиторію GitHub.
Перевірка HTML у Ruby-додатках
Бібліотека з відкритим кодом HTMLProofer включає підтримку виконання валідації HTML, перевіряючи HTML‑документи за набором налаштовуваних правил. Використовуючи потужність Nokogiri, бібліотеки для парсингу та пошуку в HTML, бібліотека валідовує ваш HTML відповідно до галузевих стандартів, виявляючи некоректні теги, невідповідні атрибути та інші синтаксичні помилки HTML. Вона застосовує паралельну обробку, що значно підвищує продуктивність при валідації великих наборів HTML‑файлів. Розподіляючи завдання валідації між кількома ядрами процесора, вона зменшує загальний час обробки, дозволяючи розробникам швидко перевіряти свій код. Бібліотека має власний механізм звітування, який виводить помилки в кінці запуску.
Як виконати перевірку HTML у Ruby-додатках?
require "html-proofer"
require "html/pipeline"
require "find"
# make an out dir
Dir.mkdir("out") unless File.exist?("out")
pipeline = HTML::Pipeline.new([
HTML::Pipeline::MarkdownFilter,
HTML::Pipeline::TableOfContentsFilter,
],
gfm: true)
# iterate over files, and generate HTML from Markdown
Find.find("./docs") do |path|
next unless File.extname(path) == ".md"
contents = File.read(path)
result = pipeline.call(contents)
File.open("out/#{path.split("/").pop.sub(".md", ".html")}", "w") { |file| file.write(result[:output].to_s) }
end
# test your out dir!
HTMLProofer.check_directory("./out").run
Як виконати перевірку посилань за допомогою Ruby API
Відкрита бібліотека HTMLProofer — незамінний інструмент для будь‑якого веб‑розробника, який прагне до безпомилкового HTML‑коду. Її широкий набір перевірок валідації гарантує, що HTML вашого веб‑сайту добре сформований і посилання працюють. Бібліотека відмінно справляється з перевіркою посилань у HTML‑документах. Вона сканує всі посилання та переконується, що вони не зламані і доступні, що допомагає підтримувати безперешкодний користувацький досвід. Вона може виявляти різні проблеми, такі як відсутні або неправильні URL‑адреси, зламані перенаправлення та посилання на неіснуючі сторінки.