Add missing --skip-comments option (#421)

Author: bhirsz

docs/releasenotes/3.3.rst

@@ -31,6 +31,10 @@ English language is supported by default.
 * Updated MergeAndOrderSections to not merge language: <lang> header with other comment sections
 * Sections with only language: <lang> marker and less than ``section_lines`` empty lines will be not transformed by NormalizeNewLines
 
+Fixes
+------
+* Add missing ``--skip-comments`` option (#418)
+
 Other
 -----
 * Reorganized our imports to better support optional rich dependency (#419)

robotidy/cli.py

@@ -391,6 +391,7 @@ def print_transformers_list(target_version: int):
     help="Parse Robot Framework files using additional languages.",
     show_default="en",
 )
+@skip.comments_option
 @skip.documentation_option
 @skip.return_values_option
 @skip.keyword_call_option
@@ -435,6 +436,7 @@ def cli(
     force_order: bool,
     target_version: int,
     language: Optional[List[str]],
+    skip_comments: bool,
     skip_documentation: bool,
     skip_return_values: bool,
     skip_keyword_call: List[str],
@@ -492,6 +494,7 @@ def cli(
         timeout=skip_timeout,
         return_statement=skip_return,
         tags=skip_tags,
+        comments=skip_comments,
         block_comments=skip_block_comments,
     )
 

tests/utest/test_cli.py

@@ -5,7 +5,7 @@
 import pytest
 from click import FileError, NoSuchOption
 
-from robotidy import utils
+from robotidy import skip, utils
 from robotidy.cli import read_config
 from robotidy.files import DEFAULT_EXCLUDES, find_project_root, get_paths, read_pyproject_config
 from robotidy.transformers.aligners_core import AlignKeywordsTestsSection
@@ -445,3 +445,15 @@ def test_too_recent_target_version(self, mocked_version, option_name):
             f"Target Robot Framework version ({target_version}) "
             "should not be higher than installed version (" in error
         )
+
+    def test_skip_options(self, tmp_path):
+        alternate_names = {"--skip-return-statement": "--skip-return"}
+        with_values = {"--skip-keyword-call-pattern", "--skip-keyword-call"}
+        option_names = []
+        for skip_option in skip.SkipConfig.HANDLES:
+            option = f"--{skip_option.replace('_', '-')}"
+            option = alternate_names.get(option, option)
+            option_names.append(option)
+            if option in with_values:
+                option_names.append("empty")
+        run_tidy([*option_names, str(tmp_path)])