Add deprecation warning to IgnoreInternalURLs in README

wjdp · Mar 28, 2022 · 72bd8a3 · 72bd8a3
1 parent 4266055
commit 72bd8a3
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -158,7 +158,7 @@ htmltest uses a YAML configuration file. Put `.htmltest.yml` in the same directo
 | `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 |
-| `IgnoreInternalURLs` | Array of strings of internal URLs to ignore. | empty |
+| `IgnoreInternalURLs` | Array of strings of internal URLs to ignore. Exact matches only. ⚠ Likely to be deprecated, use `IgnoreURLs` instead. | 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` |
 | `IgnoreEmptyHref` | When true prevents raising an error for links with `href=""`. | `false` |
@@ -189,8 +189,7 @@ DirectoryPath: "_site"
 EnforceHTTPS: true
 IgnoreURLs:
 - "example.com"
-IgnoreInternalURLs:
-- "/misc/js/script.js"
+- "^/misc/js/script.js$"
 IgnoreDirs:
 - "lib"
 CacheExpires: "6h"