feat: add zendesk helpcenter markdown check (#25)

Author: snejku

validator/__init__.py

@@ -1,3 +1,5 @@
+import sdiff
+
 from . import parsers, checks, reports, fs
 
 
@@ -56,7 +58,13 @@ def __init__(self, contents, content_type, parser, reader):
         self.checks = []
 
     def md(self):
-        self.checks.append(checks.markdown(self.content_type))
+        self.checks.append(checks.markdown(self.content_type,
+                                           md_parser_cls=sdiff.MdParser))
+        return self
+
+    def zendesk_helpcenter_md(self):
+        self.checks.append(checks.markdown(self.content_type,
+                                           md_parser_cls=sdiff.ZendeskHelpMdParser))
         return self
 
     def url(self, **kwargs):

validator/checks/__init__.py

@@ -1,3 +1,7 @@
+from typing import Type
+
+from sdiff import MdParser
+
 from .md import MarkdownComparator
 from .url import UrlValidator, UrlOccurenciesValidator
 from .java import JavaComparator
@@ -17,10 +21,10 @@ def url_occurences(filetype):
     return UrlOccurenciesValidator()
 
 
-def markdown(filetype):
+def markdown(filetype, md_parser_cls: Type[MdParser] = MdParser):
     if filetype not in ['txt', 'html']:
         raise UndefinedCheckTypeError('got filetype %s' % filetype)
-    return MarkdownComparator()
+    return MarkdownComparator(md_parser_cls)
 
 
 def java_args(filetype):

validator/checks/md.py

@@ -1,5 +1,7 @@
 import re
-from sdiff import diff, renderer
+from typing import Type
+
+from sdiff import diff, renderer, MdParser
 from markdown import markdown
 
 from ..errors import MdDiff, ContentData
@@ -13,6 +15,9 @@ def save_file(content, filename):
 
 
 class MarkdownComparator(object):
+    def __init__(self, md_parser_cls: Type[MdParser] = MdParser):
+        self._md_parser_cls = md_parser_cls
+
     def check(self, data, parser, reader):
         if not data:
             return []
@@ -26,7 +31,9 @@ def check(self, data, parser, reader):
             for other in row:
                 other_parsed = parser.parse(reader.read(other))
                 other_html = markdown(other_parsed)
-                other_diff, base_diff, error = diff(other_parsed, base_parsed, renderer=renderer.HtmlRenderer())
+                other_diff, base_diff, error = diff(other_parsed, base_parsed,
+                                                    renderer=renderer.HtmlRenderer(),
+                                                    parser_cls=self._md_parser_cls)
                 if error:
                     error_msgs = []
                     if error: