mkdocs-htmlproofer-plugin 1.2.0__tar.gz → 1.3.0__tar.gz

{mkdocs-htmlproofer-plugin-1.2.0/mkdocs_htmlproofer_plugin.egg-info → mkdocs-htmlproofer-plugin-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-htmlproofer-plugin
-Version: 1.2.0
+Version: 1.3.0
 Summary: A MkDocs plugin that validates URL in rendered HTML files
 Home-page: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
 Author: Manu Zhang
@@ -27,6 +27,8 @@ License-File: LICENSE.md
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -140,6 +142,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.0 → mkdocs-htmlproofer-plugin-1.3.0}/README.md

@@ -4,6 +4,8 @@
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -117,6 +119,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.0 → mkdocs-htmlproofer-plugin-1.3.0}/htmlproofer/plugin.py

@@ -70,6 +70,7 @@ class HtmlProoferPlugin(BasePlugin):
         ('validate_rendered_template', config_options.Type(bool, default=False)),
         ('ignore_urls', config_options.Type(list, default=[])),
         ('warn_on_ignored_urls', config_options.Type(bool, default=False)),
+        ('ignore_pages', config_options.Type(list, default=[])),
     )
 
     def __init__(self):
@@ -116,12 +117,19 @@ class HtmlProoferPlugin(BasePlugin):
 
         all_element_ids = set(tag['id'] for tag in soup.select('[id]'))
         all_element_ids.add('')  # Empty anchor is commonly used, but not real
-        for a in soup.find_all('a', href=True):
-            url = a['href']
 
+        urls = set(a['href'] for a in soup.find_all('a', href=True)) | set(img['src'] for img in soup.find_all('img'))
+
+        for url in urls:
             if any(fnmatch.fnmatch(url, ignore_url) for ignore_url in self.config['ignore_urls']):
                 if self.config['warn_on_ignored_urls']:
                     log_warning(f"ignoring URL {url} from {page.file.src_path}")
+            elif any(
+                fnmatch.fnmatch(page.file.src_path, ignore_page)
+                for ignore_page in self.config['ignore_pages']
+            ):
+                if self.config['warn_on_ignored_urls']:
+                    log_warning(f"ignoring URL {url} from {page.file.src_path}")
             else:
                 url_status = self.get_url_status(url, page.file.src_path, all_element_ids, opt_files)
                 if self.bad_url(url_status) and self.is_error(self.config, url, url_status):
@@ -151,7 +159,7 @@ class HtmlProoferPlugin(BasePlugin):
 
             if self.config['skip_downloads'] is False:
                 # Download the entire contents as to not break previous behaviour.
-                for _ in response.iter_content(chunk_size=1024):
+                for _ in response.iter_content(chunk_size=1024 * 1024):
                     pass
 
             return response.status_code
@@ -194,18 +202,20 @@ class HtmlProoferPlugin(BasePlugin):
             return True
 
         url_target, _, optional_anchor = match.groups()
-        _, extension = os.path.splitext(url_target)
-        if extension == ".html":
-            # URL is a link to another local Markdown file that may include an anchor.
-            target_markdown = HtmlProoferPlugin.find_target_markdown(url_target, src_path, files)
-            if target_markdown is None:
-                # The corresponding Markdown page was not found.
-                return False
-            if optional_anchor and not HtmlProoferPlugin.contains_anchor(target_markdown, optional_anchor):
-                # The corresponding Markdown header for this anchor was not found.
-                return False
-        elif HtmlProoferPlugin.find_source_file(url_target, src_path, files) is None:
+        source_file = HtmlProoferPlugin.find_source_file(url_target, src_path, files)
+        if source_file is None:
             return False
+
+        # If there's an anchor (fragment) on the link, we try to find it in the source_file
+        if optional_anchor:
+            _, extension = os.path.splitext(source_file.src_uri)
+            # Currently only Markdown-based pages are supported, but conceptually others could be added below
+            if extension == ".md":
+                if source_file.page is None or source_file.page.markdown is None:
+                    return False
+                if not HtmlProoferPlugin.contains_anchor(source_file.page.markdown, optional_anchor):
+                    return False
+
         return True
 
     @staticmethod

{mkdocs-htmlproofer-plugin-1.2.0 → mkdocs-htmlproofer-plugin-1.3.0/mkdocs_htmlproofer_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-htmlproofer-plugin
-Version: 1.2.0
+Version: 1.3.0
 Summary: A MkDocs plugin that validates URL in rendered HTML files
 Home-page: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
 Author: Manu Zhang
@@ -27,6 +27,8 @@ License-File: LICENSE.md
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -140,6 +142,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.0 → mkdocs-htmlproofer-plugin-1.3.0}/setup.py

@@ -9,7 +9,7 @@ def read(fname: str):
 
 setup(
     name='mkdocs-htmlproofer-plugin',
-    version='1.2.0',
+    version='1.3.0',
     description='A MkDocs plugin that validates URL in rendered HTML files',
     long_description=read('README.md'),
     long_description_content_type='text/markdown',