Test generated HTML for problems
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
htmldoc
htmltest
issues
output
refcache
.gitattributes
.gitignore
.goreleaser.yml
.travis.yml
LICENCE
README.md
appveyor.yml
build.sh
go.mod
go.sum
godownloader.sh
main.go

README.md

htmltest

Travis Build Status AppVeyor Build status Go Report Card codecov GoDoc

If you generate HTML files, html-proofer might be the tool for you. If you can't be bothered with a Ruby environment or fancy something a bit faster, htmltest may be a better option.

🔍 htmltest runs your HTML output through a series of checks to ensure all your links, images, scripts references work, your alt tags are filled in, et cetera.

🏇 Faster? Yep, quite a bit actually. On a site with over 2000 files htmlproofer took over three minutes, htmltest took 8.6 seconds. Both tools had full valid caches.

😕 Why make another tool: A mix of frustration with using htmlproofer/Ruby on large sites and needing a good project to get to grips with Go.

💾 Installation

🐧 Linux / 🍏 OSX / 📱 Arm

System-wide Install

curl https://htmltest.wjdp.uk | sudo bash -s -- -b /usr/local/bin

You'll be prompted for your password. After simply do htmltest to run.

Into Current Directory

curl https://htmltest.wjdp.uk | bash

By default this will install htmltest into ./bin of your current directory, to run do bin/htmltest. Rather suitable for CI environments.

win64 Windows

⬇️ Download the latest binary release and put it somewhere on your PATH.

Notes

We store temporary files in tmp/.htmltest by default. You probably want to ignore that in your version control system, and perhaps cache it in your CI system.

💻 Usage

htmltest - Test generated HTML for problems
           https://github.com/wjdp/htmltest

Usage:
  htmltest [options] [<path>]
  htmltest -v --version
  htmltest -h --help

Options:
  <path>                       Path to directory or file to test, if omitted we
                               attempt to read from .htmltest.yml.
  -c FILE, --conf FILE         Custom path to config file.
  -h, --help                   Show this text.
  -l LEVEL, --log-level LEVEL  Logging level, 0-3: debug, info, warning, error.
  -s, --skip-external          Skip external link checks, may shorten execution
                               time considerably.
  -v, --version                Show version and build time.

🔬 What's Tested?

Many options of the following tests can customised. Items marked 🔜 are not checked yet, but will be soon.

  • a link img script: Whether internal links work / are valid.
  • a: Whether internal hashes work.
  • a link img script: Whether external links work.
  • a: 🔜 Whether external hashes work.
  • a link: Whether external links use HTTPS.
  • img: Whether your images have valid alt attributes.
  • link: Whether pages have a valid favicon.
  • meta: Whether refresh tags are valid and the url works.
  • meta: 🔜 Whether images and URLs in the OpenGraph metadata are valid.
  • meta title: 🔜 Whether you've got the recommended tags in your head.
  • DOCTYPE: Whether a doctype is correctly specified.

What's Not

I'd like to test the following but won't be for a while.

  • Whether your HTML markup is valid. htmlproofer has the ruby library Nokogiri, I've not found one for Go yet.

🙈 Ignoring content

Add the data-proofer-ignore attribute to any tag to ignore it from every check. The name of this attribute can be customised.

<a href="http://notareallink" data-proofer-ignore>Not checked.</a>

📑 Caching

Checking external URLs can slow tests down and potentially annoy the URL's host. htmltest caches the status code of checked external URLs and stores this cache between runs. We write the cache to tmp/.htmltest/refcache.json and expire items after two weeks by default.

📠 Logging

If you've got a lot of errors, reading them off a TTY may be difficult. We write errors to tmp/.htmltest/htmltest.log by default. The log level is set in the config file.

🔧 Configuration

htmltest uses a YAML configuration file. Put .htmltest.yml in the same directory that you're running the tool from and you can just say htmltest to run your tests. You'll probably also want to cache the tmp/.htmltest directory.

Basic Options

Option Description Default
DirectoryPath Directory to scan for HTML files.
DirectoryIndex The file to look for when linking to a directory. index.html
FilePath Single file to test within DirectoryPath, omit to test all.
FileExtension Extension of your HTML documents, includes the dot. If FilePath is set we use the extension from that. .html
CheckDoctype Enables checking the document type declaration. true
CheckAnchors Enables checking <a… tags. true
CheckLinks Enables checking <link… tags. true
CheckImages Enables checking <img… tags true
CheckScripts Enables checking <script… tags. true
CheckMeta Enables checking <meta… tags. true
CheckGeneric Enables other tags, see items marked with checkGeneric on the tags wiki page. true
CheckExternal Enables external reference checking; all tag types. true
CheckInternal Enables internal reference checking; all tag types. When disabled will prevent internal hash checking unless the reference only contains a hash fragment (#heading) and therefore refers to the current page. true
CheckInternalHash Enables internal hash/fragment checking. true
CheckMailto Enables–albeit quite basic–mailto: link checking. true
CheckTel Enables–albeit quite basic–tel: link checking. true
CheckFavicon Enables favicon checking, ensures every page has a favicon set. false
CheckMetaRefresh Enables checking meta refresh tags. true
EnforceHTML5 Fails when the doctype isn't <!DOCTYPE html>. false
EnforceHTTPS Fails when encountering an http:// link. Useful to prevent mixed content errors when serving over HTTPS. false
IgnoreURLs Array of regexs of URLs to ignore. empty
IgnoreDirs Array of regexs of directories to ignore when scanning for HTML files. empty
IgnoreInternalEmptyHash When true prevents raising an error for links with href="#". false
IgnoreCanonicalBrokenLinks When true produces a warning, rather than an error, for broken canonical links. When testing a site which isn't live yet or before publishing a new page canonical links will fail. true
IgnoreAltMissing Turns off image alt attribute checking. false
IgnoreDirectoryMissingTrailingSlash Turns off errors for links to directories without a trailing slash. false
IgnoreTagAttribute Specify the ignore attribute. All tags with this attribute will be excluded from every check. "data-proofer-ignore"
HTTPHeaders Dictionary of headers to include in external requests {"Range": "bytes=0-0", "Accept": "*/*"}
TestFilesConcurrently ⚠️ 🚧 EXPERIMENTAL Turns on concurrent checking of files. false
DocumentConcurrencyLimit Maximum number of documents to process at once. 128
HTTPConcurrencyLimit Maximum number of open HTTP connections. If you raise this number ensure the ExternalTimeout is suitably raised. 16
LogLevel Logging level, 0-3: debug, info, warning, error. 2
LogSort How to sort/present issues. Can be seq for sequential output or document to group by document. document
ExternalTimeout Number of seconds to wait on an HTTP connection before failing. 15
StripQueryString Enables stripping of query strings from external checks. true
StripQueryExcludes List of URLs to disable query stripping on. ["fonts.googleapis.com"]
OutputDir Directory to store cache and log files in. Relative to executing directory. tmp/.htmltest
OutputCacheFile File within OutputDir to store reference cache. refcache.json
OutputLogFile File within OutputDir to store last tests errors. htmltest.log
CacheExpires Cache validity period, accepts go.time duration strings (…"m", "h"). 336h (two weeks)

Example

DirectoryPath: "_site"
EnforceHTTPS: true
IgnoreURLs:
- "example.com"
IgnoreDirs:
- "lib"
CacheExpires: "6h"

📢 Issues? Suggestions?

Submit an issue.