Fix S011 lint

Cylc does not parse Jinja2 when inside a Jinja2 comment.
cylc · May 15, 2023 · d48d9b5 · d48d9b5
1 parent 250431c
commit d48d9b5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/cylc/flow/scripts/lint.py b/cylc/flow/scripts/lint.py
@@ -164,7 +164,7 @@
         'url': 'https://github.com/cylc/cylc-flow/issues/3825',
         'index': 10
     },
-    re.compile(r'#.*?{[{%]'): {
+    re.compile(r'(?<!{)#.*?{[{%]'): {
         'short': 'Cylc will process commented Jinja2!',
         'url': '',
         'index': 11

diff --git a/tests/unit/scripts/test_lint.py b/tests/unit/scripts/test_lint.py
@@ -232,6 +232,12 @@ def test_check_cylc_file_lint(number):
     assert_contains(lint.messages, f'S{(number + 1):03d}')
 
 
+def test_check_cylc_file_jinja2_comments():
+    # Repalce the '# {{' line to be '{# {{' which should not be a warning
+    lint = lint_text(LINT_TEST_FILE.replace('# {{', '{# {{'), ['style'])
+    assert not filter_strings(lint.messages, 'S011')
+
+
 @pytest.mark.parametrize('exclusion', range(len(STYLE_CHECKS.values())))
 def test_check_exclusions(exclusion):
     """It does not report any items excluded."""