diff --git a/Gemfile b/Gemfile index d65e2a66..fa75df15 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,3 @@ -source 'http://rubygems.org' +source 'https://rubygems.org' gemspec diff --git a/README.md b/README.md index 8b5e4b80..932984bc 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ You can enable or disable most of the following checks. ### HTML -* Whether your HTML markup is valid. This is done via [Nokogiri](http://www.nokogiri.org/tutorials/ensuring_well_formed_markup.html), to ensure well-formed markup. +* Whether your HTML markup is valid. This is done via [Nokogumbo](https://github.com/rubys/nokogumbo) to validate well-formed HTML5 markup. ## Usage @@ -196,7 +196,7 @@ htmlproofer ./_site ### Using through Docker -If you have trouble with (or don't want to) install Ruby/Nokogiri, the command-line tool can be run through Docker. See [html-proofer-docker](https://github.com/18F/html-proofer-docker) for more information. +If you have trouble with (or don't want to) install Ruby/Nokogumbo, the command-line tool can be run through Docker. See [html-proofer-docker](https://github.com/18F/html-proofer-docker) for more information. ## Ignoring content @@ -218,7 +218,7 @@ The `HTMLProofer` constructor takes an optional hash of additional options: | `check_external_hash` | Checks whether external hashes exist (even if the webpage exists). This slows the checker down. | `false` | | `check_favicon` | Enables the favicon checker. | `false` | | `check_opengraph` | Enables the Open Graph checker. | `false` | -| `check_html` | Enables HTML validation errors from Nokogiri | `false` | +| `check_html` | Enables HTML validation errors from Nokogumbo | `false` | |`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]` | `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` | | `disable_external` | If `true`, does not run the external link checker, which can take a lot of time. | `false` | @@ -247,13 +247,13 @@ See below for more information. ### Configuring HTML validation rules -If `check_html` is `true`, Nokogiri performs additional validation on your HTML. +If `check_html` is `true`, Nokogumbo performs additional validation on your HTML. You can pass in additional options to configure this validation. | Option | Description | Default | | :----- | :---------- | :------ | -| `report_invalid_tags` | When `check_html` is enabled, HTML markup that is unknown to Nokogiri are reported as errors. | `false` +| `report_invalid_tags` | When `check_html` is enabled, HTML markup that is unknown to Nokogumbo are reported as errors. | `false` | `report_missing_names` | When `check_html` is enabled, HTML markup that are missing entity names are reported as errors. | `false` | `report_script_embeds` | When `check_html` is enabled, `script` tags containing markup [are reported as errors](http://git.io/vOovv). Enabling this option ignores those errors. | `false` diff --git a/bin/htmlproofer b/bin/htmlproofer index ba67e59f..73d6d5c0 100755 --- a/bin/htmlproofer +++ b/bin/htmlproofer @@ -20,7 +20,7 @@ Mercenary.program(:htmlproofer) do |p| p.option 'checks_to_ignore', '--checks-to-ignore check1,[check2,...]', Array, ' An array of Strings indicating which checks you\'d like to not perform.' p.option 'check_external_hash', '--check-external-hash', 'Checks whether external hashes exist (even if the webpage exists). This slows the checker down (default: `false`).' p.option 'check_favicon', '--check-favicon', 'Enables the favicon checker (default: `false`).' - p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogiri (default: `false`).' + p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogumbo (default: `false`).' p.option 'check_img_http', '--check-img-http', 'Fails an image if it\'s marked as `http` (default: `false`).' p.option 'check_opengraph', '--check-opengraph', 'Enables the Open Graph checker (default: `false`).' p.option 'directory_index_file', '--directory-index-file', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)' @@ -32,9 +32,10 @@ Mercenary.program(:htmlproofer) do |p| p.option 'external_only', '--external_only', 'Only checks problems with external references' p.option 'file_ignore', '--file-ignore file1,[file2,...]', Array, 'A comma-separated list of Strings or RegExps containing file paths that are safe to ignore' p.option 'http_status_ignore', '--http-status-ignore 123,[xxx, ...]', Array, 'A comma-separated list of numbers representing status codes to ignore.' - p.option 'report_invalid_tags', '--report-invalid-tags', 'Ignore `check_html` errors associated with unknown markup (default: `false`)' - p.option 'report_missing_names', '--report-missing-names', 'Ignore `check_html` errors associated with missing entities (default: `false`)' - p.option 'report_script_embeds', '--report-script-embeds', 'Ignore `check_html` errors associated with `script`s (default: `false`)' + p.option 'report_invalid_tags', '--report-invalid-tags', 'Report `check_html` errors associated with unknown markup (default: `false`)' + p.option 'report_missing_names', '--report-missing-names', 'Report `check_html` errors associated with missing entities (default: `false`)' + p.option 'report_script_embeds', '--report-script-embeds', 'Report `check_html` errors associated with `script`s (default: `false`)' + p.option 'report_missing_doctype', '--report-missing-doctype', 'Report `check_html` errors associated with missing or out-of-order DOCTYPE (default: `false`)' p.option 'log_level', '--log-level ', String, 'Sets the logging level, as determined by Yell' p.option 'only_4xx', '--only-4xx', 'Only reports errors for links that fall within the 4xx status code range' p.option 'timeframe', '--timeframe