Merge pull request #269 from stdweird/heredoc

panlint: fix heredoc linting

panc/src/main/scripts/panlint/panlint.py

@@ -37,6 +37,9 @@ def __init__(self, filename, number, text):
         self.text = str(text)
         self.problems = []
 
+    def __repr__(self):
+        return f"Line('{self.filename}', {self.number}, '{self.text}')"
+
 
 class Problem(object):
     """A class representing the abstract concept of a problem with a line of code.
@@ -90,7 +93,9 @@ def __str__(self):
 RE_COMMENT = re.compile(RS_COMMENT)
 RE_COMMENT_LINE = re.compile(r'^\s*' + RS_COMMENT + '.*$')
 RE_ANNOTATION = re.compile(r'@\w*\s*{.*?}', re.S)
-RE_OPERATOR = re.compile(r'([>=<!?]=|[<>+*=/-])')
+# Deal with heredoc as fake operator incl tag (so no bitshift). Will ignore it in the code.
+#   The order here is important: the < at the end must remain at the end or linting heredocs will fail.
+RE_OPERATOR = re.compile(r'([>=<!?]=|[>+*=/-]|<<\w+(?!;)|<)')
 RE_HEREDOC = re.compile(r'<<(\w+);\s*$.*?\1$', re.S | re.M)
 
 # Find usage and inclusion of components
@@ -196,6 +201,9 @@ def whitespace_around_operators(line, string_ranges):
             valid = True
             if inside_string(start, end, string_ranges):
                 continue
+            elif op.startswith('<<') and len(op) > 2:
+                # ignore fake heredoc operator
+                continue
             elif op == '-' and (
                     (
                         re.search(r'[^\w\s)=]\s*$', chars_before) and re.search(r'^\s*\d+\s*[^\w\s]', chars_after)

panc/src/main/scripts/panlint/test_files/test_good_heredoc.pan

@@ -0,0 +1,7 @@
+unique template unique/heredoc;
+
+'/abc' = <<EOF;
+verbatim text
+lots of stuff not allowed in pan, like 1+1
+
+EOF