add CLI parameter --config.keepComments=true/false to control whether comments should be kept

Author: FelixSchwarz

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - support Python 3.14, drop support for Python 3.6, 3.7 and 3.8
 - generated HTML should match mjml 4.18.0
+- comments in mjml will be present in the generated html by default now to match the reference implementation
 - various fixes to match HTML generated the JS mjml, found by htmlcompare 0.4
 - type hints contributed by @xoudini
 - correctly render fractional width for mj-column (reported by @SinnySupernova)

mjml/scripts/mjml.py

@@ -8,12 +8,14 @@
 
 Options:
   --template-dir=<path>    base dir for mj-include (default: path of mjml file)
+  --config.keepComments=False  whether comments in mjml should be present in the generated html (default: true)
 """
 # ruff: noqa: E501
 
 import sys
 from io import BytesIO
 from pathlib import Path
+from typing import Union
 
 from docopt import docopt
 
@@ -25,14 +27,19 @@ def main():
     mjml_filename = arguments['<MJML-FILE>']
     output_filename = arguments['<OUTPUT-FILE>']
     template_dir = arguments['--template-dir']
+    keep_comments_str = arguments['--config.keepComments']
+    keep_comments = _parse_bool(keep_comments_str, default=True)
+    if keep_comments is None:
+        sys.stderr.write("value for --config.keepComments should be either true or false\n")
+        sys.exit(1)
 
     if mjml_filename == '-':
         stdin = sys.stdin.buffer
         mjml_fp = BytesIO(stdin.read())
-        result = mjml_to_html(mjml_fp, template_dir=template_dir)
+        result = mjml_to_html(mjml_fp, template_dir=template_dir, keep_comments=keep_comments)
     else:
         with Path(mjml_filename).open('rb') as mjml_fp:
-            result = mjml_to_html(mjml_fp, template_dir=template_dir)
+            result = mjml_to_html(mjml_fp, template_dir=template_dir, keep_comments=keep_comments)
     assert not result.errors, result.errors
 
     html_str = result.html
@@ -47,5 +54,20 @@ def main():
         sys.stdout.buffer.write(html_bytes)
 
 
+def _parse_bool(value: Union[str, None], *, default: bool) -> Union[bool, None]:
+    if value is None:
+        return default
+    truthy = {'true', '1', 'yes', 'y'}
+    falsey = {'false', '0', 'no', 'n'}
+
+    value_lower = value.strip().lower()
+    if value_lower in truthy:
+        return True
+    elif value_lower in falsey:
+        return False
+    else:
+        return None
+
+
 if __name__ == '__main__':
     main()