summaryrefslogtreecommitdiffstats
path: root/python/mozlint/mozlint/formatters/unix.py
blob: ae096f3e2ebcf0722b4eeb5139582582f47cd066 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 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 UnixFormatter(object):
    """Formatter that respects Unix output conventions frequently
    employed by preprocessors and compilers.  The format is
    `<FILENAME>:<LINE>[:<COL>]: <RULE> <LEVEL>: <MESSAGE>`.

    """

    fmt = "{path}:{lineno}:{column} {rule} {level}: {message}"

    def __call__(self, result):
        msg = []

        for path, errors in sorted(result.issues.items()):
            for err in errors:
                assert isinstance(err, Issue)

                slots = attr.asdict(err)
                slots["path"] = slots["relpath"]
                slots["column"] = "%d:" % slots["column"] if slots["column"] else ""
                slots["rule"] = slots["rule"] or slots["linter"]

                msg.append(self.fmt.format(**slots))

        return "\n".join(msg)