blob: f7fd089736d47a42c3dde8313b788225d362f2a9 [file]
# Copyright 2025 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
misleading_characters = {
# smart quotes are misleading
r"“": '"',
r"”": '"',
# en and em dashes are misleading
r"–": "-",
r"—": "-",
}
_MISLEADING_CHARS_RE = "|".join(misleading_characters.keys())
# Lints for confusing characters like smart quotes and en dashes.
# It's better to avoid these so that they don't crop up in code snippets
# and produce confusing failures when developers copy-paste them from
# documentation.
def confusing_characters(ctx):
for path, meta in ctx.scm.affected_files().items():
for num, line in meta.affected_lines():
for match in ctx.re.allmatches(_MISLEADING_CHARS_RE, line):
c = match.groups[0]
ctx.emit.finding(
message = "Avoid using confusing characters: {}".format(c),
level = "warning",
filepath = path,
line = num,
col = match.offset + 1,
# Columns are byte offsets, and all the misleading
# characters are multibyte in UTF-8.
end_col = match.offset + 1 + len(c),
replacements = [misleading_characters[c]],
)