summaryrefslogtreecommitdiffstats
path: root/python/mozlint/mozlint/formatters/compact.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /python/mozlint/mozlint/formatters/compact.py
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'python/mozlint/mozlint/formatters/compact.py')
-rw-r--r--python/mozlint/mozlint/formatters/compact.py41
1 files changed, 41 insertions, 0 deletions
diff --git a/python/mozlint/mozlint/formatters/compact.py b/python/mozlint/mozlint/formatters/compact.py
new file mode 100644
index 0000000000..54ee194215
--- /dev/null
+++ b/python/mozlint/mozlint/formatters/compact.py
@@ -0,0 +1,41 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import attr
+
+from ..result import Issue
+
+
+class CompactFormatter(object):
+ """Formatter for compact output.
+
+ This formatter prints one error per line, mimicking the
+ eslint 'compact' formatter.
+ """
+
+ # If modifying this format, please also update the vim errorformats in editor.py
+ fmt = "{path}: line {lineno}{column}, {level} - {message} ({rule})"
+
+ def __init__(self, summary=True):
+ self.summary = summary
+
+ def __call__(self, result):
+ message = []
+ num_problems = 0
+ for path, errors in sorted(result.issues.items()):
+ num_problems += len(errors)
+ for err in errors:
+ assert isinstance(err, Issue)
+
+ d = attr.asdict(err)
+ d["column"] = ", col %s" % d["column"] if d["column"] else ""
+ d["level"] = d["level"].capitalize()
+ d["rule"] = d["rule"] or d["linter"]
+ message.append(self.fmt.format(**d))
+
+ if self.summary and num_problems:
+ message.append(
+ "\n{} problem{}".format(num_problems, "" if num_problems == 1 else "s")
+ )
+ return "\n".join(message)