fix: Fix section-out-of-order not supporting comments section

src/robocop/linter/rules/duplications.py

@@ -468,6 +468,7 @@ def __init__(self) -> None:
     def section_order_to_str(order: dict[str, int]) -> str:
         by_index = sorted(order.items(), key=lambda x: x[1])
         name_map = {
+            Token.COMMENT_HEADER: "Comments",
             Token.SETTING_HEADER: "Settings",
             Token.VARIABLE_HEADER: "Variables",
             Token.TESTCASE_HEADER: "Test Cases / Tasks",

src/robocop/linter/rules/order.py

@@ -50,6 +50,7 @@ def parse_test_case_order_param(value: str) -> list[str]:
 
 def configure_sections_order(value: str) -> dict[str, int]:
     section_map: dict[str, str] = {
+        "comments": Token.COMMENT_HEADER,
         "settings": Token.SETTING_HEADER,
         "variables": Token.VARIABLE_HEADER,
         "testcase": Token.TESTCASE_HEADER,

tests/linter/rules/order/section_out_of_order/expected_output_comments.txt

@@ -0,0 +1,5 @@
+test.robot:11:1 [W] ORD03 '*** Comments ***' section header is defined in wrong order: Settings > Comments > Variables > Test Cases / Tasks > Keywords
+test.robot:20:1 [W] ORD03 '*** Settings ***' section header is defined in wrong order: Settings > Comments > Variables > Test Cases / Tasks > Keywords
+test.robot:23:1 [W] ORD03 '*** Variables ***' section header is defined in wrong order: Settings > Comments > Variables > Test Cases / Tasks > Keywords
+
+Found 3 issues.

tests/linter/rules/order/section_out_of_order/golden.robot

@@ -0,0 +1,5 @@
+*** Comments ***
+*** Settings ***
+*** Variables ***
+*** Test Cases ***
+*** Keywords ***

tests/linter/rules/order/section_out_of_order/golden_without_comment_header.robot

@@ -0,0 +1,7 @@
+test
+
+
+*** Settings ***
+*** Variables ***
+*** Test Cases ***
+*** Keywords ***

tests/linter/rules/order/section_out_of_order/missing_sections.robot

@@ -0,0 +1,4 @@
+*** Comments ***
+*** Settings ***
+*** Test Cases ***
+*** Keywords ***

tests/linter/rules/order/section_out_of_order/test_rule.py

@@ -26,3 +26,17 @@ def test_custom_order(self, sections_order):
 
     def test_extended(self):
         self.check_rule(src_files=["test.robot"], expected_file="expected_extended.txt", output_format="extended")
+
+    def test_comments_section(self):
+        # bug #1724
+        self.check_rule(
+            src_files=["test.robot", "golden_without_comment_header.robot"],
+            expected_file="expected_output_comments.txt",
+            configure=["section-out-of-order.sections_order=settings,comments,variables,testcases,keywords"],
+        )
+
+    def test_good_order(self):
+        self.check_rule(
+            src_files=["golden.robot", "missing_sections.robot", "golden_without_comment_header.robot"],
+            expected_file=None,
+        )