paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-05 06:23:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

check-templates: Defer some indentation checks.

Browse Source 
This accomplishes a few things:

    * lighten the load for the main validation loop
    * defer indentation checks until we are sure the author
      even knows how to match up tags
    * add some info to the Token objects that we may soon
      consume in our pretty-printer
This commit is contained in:
Steve Howell
2021-12-02 01:57:04 +00:00
committed by Tim Abbott
parent f1fa9bff83
commit 6fc445ddd9
1 changed files with 56 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
tools/lib/template_parser.py
View File

@@ -35,6 +35,10 @@ class Token:
self.col = col
self.line_span = line_span
# These get set during the validation pass.
self.start_token: Optional[Token] = None
self.end_token: Optional[Token] = None
def tokenize(text: str) -> List[Token]:
def advance(n: int) -> None:
@@ -374,8 +378,6 @@ def validate(fn: Optional[str] = None, text: Optional[str] = None) -> None:
end_line = end_token.line
end_col = end_token.col
is_inline_tag = start_tag in HTML_INLINE_TAGS and start_token.kind == "html_start"
def report_problem() -> Optional[str]:
if (start_tag == "code") and (end_line == start_line + 1):
return "Code tag is split across two lines."
@@ -389,16 +391,6 @@ def validate(fn: Optional[str] = None, text: Optional[str] = None) -> None:
elif start_tag != end_tag:
return f"Mismatched tags: ({start_tag} != {end_tag})"
if end_line > start_line + 1:
if is_inline_tag:
end_row_text = lines[end_line - 1]
if end_row_text.lstrip().startswith(end_token.s):
if end_col != start_col:
return "Indentation for start/end tags does not match."
else:
if end_col != start_col:
return "Indentation for start/end tags does not match."
return None
problem = report_problem()
@@ -421,6 +413,10 @@ def validate(fn: Optional[str] = None, text: Optional[str] = None) -> None:
state.foreign = old_foreign
state.depth -= 1
# TODO: refine this for the else/elif use cases
end_token.start_token = start_token
start_token.end_token = end_token
state.matcher = f
for token in tokens:
@@ -448,6 +444,54 @@ def validate(fn: Optional[str] = None, text: Optional[str] = None) -> None:
if state.depth != 0:
raise TemplateParserException("Missing end tag")
ensure_matching_indentation(fn, tokens, lines)
def ensure_matching_indentation(fn: str, tokens: List[Token], lines: List[str]) -> None:
for token in tokens:
if token.start_token is None:
continue
end_token = token
start_token = token.start_token
start_line = start_token.line
start_col = start_token.col
start_tag = start_token.tag
end_tag = end_token.tag.strip("~")
end_line = end_token.line
end_col = end_token.col
def has_bad_indentation() -> bool:
is_inline_tag = start_tag in HTML_INLINE_TAGS and start_token.kind == "html_start"
if end_line > start_line + 1:
if is_inline_tag:
end_row_text = lines[end_line - 1]
if end_row_text.lstrip().startswith(end_token.s):
if end_col != start_col:
return True
else:
if end_col != start_col:
return True
return False
if has_bad_indentation():
raise TemplateParserException(
f"""
fn: {fn}
Indentation for start/end tags does not match.
start tag: {start_token.s}
start:
line {start_line}, col {start_col}
end:
{end_tag}
line {end_line}, col {end_col}
"""
)
def prevent_whitespace_violations(fn: str, tokens: List[Token]) -> None:
if tokens[0].kind in ("indent", "whitespace"):