mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-21 17:25:36 +00:00
df97806e5f
This is a really simple and ugly formatter that is compatible with treeherder's error highlighting mechanism. It is designed to be identical to the current eslint output on treeherder: https://dxr.mozilla.org/mozilla-central/rev/4d63dde701b47b8661ab7990f197b6b60e543839/tools/lint/eslint-formatter.js Eventually eslint will also use this and we can remove that file. Once bug 1276486 is fixed, we can make this look a little nicer. But for now it gets the job done. MozReview-Commit-ID: CwfWPcwWFxF --HG-- extra : rebase_source : 8dd39aefec1064e0836c847c6d223db43df4755b
118 lines
2.9 KiB
Python
118 lines
2.9 KiB
Python
# -*- Mode: python; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*-
|
|
# vim: set filetype=python:
|
|
# 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 json
|
|
import os
|
|
import signal
|
|
|
|
import which
|
|
from mozprocess import ProcessHandler
|
|
|
|
from mozlint import result
|
|
|
|
|
|
FLAKE8_NOT_FOUND = """
|
|
Could not find flake8! Install flake8 and try again.
|
|
|
|
$ pip install flake8
|
|
""".strip()
|
|
|
|
|
|
LINE_OFFSETS = {
|
|
# continuation line under-indented for hanging indent
|
|
'E121': (-1, 2),
|
|
# continuation line missing indentation or outdented
|
|
'E122': (-1, 2),
|
|
# continuation line over-indented for hanging indent
|
|
'E126': (-1, 2),
|
|
# continuation line over-indented for visual indent
|
|
'E127': (-1, 2),
|
|
# continuation line under-indented for visual indent
|
|
'E128': (-1, 2),
|
|
# continuation line unaligned for hanging indend
|
|
'E131': (-1, 2),
|
|
# expected 1 blank line, found 0
|
|
'E301': (-1, 2),
|
|
# expected 2 blank lines, found 1
|
|
'E302': (-2, 3),
|
|
}
|
|
"""Maps a flake8 error to a lineoffset tuple.
|
|
|
|
The offset is of the form (lineno_offset, num_lines) and is passed
|
|
to the lineoffset property of `ResultContainer`.
|
|
"""
|
|
|
|
results = []
|
|
|
|
|
|
def process_line(line):
|
|
try:
|
|
res = json.loads(line)
|
|
except ValueError:
|
|
return
|
|
|
|
if 'code' in res:
|
|
if res['code'].startswith('W'):
|
|
res['level'] = 'warning'
|
|
|
|
if res['code'] in LINE_OFFSETS:
|
|
res['lineoffset'] = LINE_OFFSETS[res['code']]
|
|
|
|
results.append(result.from_linter(LINTER, **res))
|
|
|
|
|
|
def lint(files, **lintargs):
|
|
binary = os.environ.get('FLAKE8')
|
|
if not binary:
|
|
try:
|
|
binary = which.which('flake8')
|
|
except which.WhichError:
|
|
pass
|
|
|
|
if not binary:
|
|
print(FLAKE8_NOT_FOUND)
|
|
return []
|
|
|
|
cmdargs = [
|
|
binary,
|
|
'--format', '{"path":"%(path)s","lineno":%(row)s,'
|
|
'"column":%(col)s,"rule":"%(code)s","message":"%(text)s"}',
|
|
]
|
|
|
|
exclude = lintargs.get('exclude')
|
|
if exclude:
|
|
cmdargs += ['--exclude', ','.join(lintargs['exclude'])]
|
|
|
|
cmdargs += files
|
|
|
|
# flake8 seems to handle SIGINT poorly. Handle it here instead
|
|
# so we can kill the process without a cryptic traceback.
|
|
orig = signal.signal(signal.SIGINT, signal.SIG_IGN)
|
|
proc = ProcessHandler(cmdargs, env=os.environ,
|
|
processOutputLine=process_line)
|
|
proc.run()
|
|
signal.signal(signal.SIGINT, orig)
|
|
|
|
try:
|
|
proc.wait()
|
|
except KeyboardInterrupt:
|
|
proc.kill()
|
|
|
|
return results
|
|
|
|
|
|
LINTER = {
|
|
'name': "flake8",
|
|
'description': "Python linter",
|
|
'include': [
|
|
'python/mozlint',
|
|
'tools/lint',
|
|
],
|
|
'exclude': [],
|
|
'type': 'external',
|
|
'payload': lint,
|
|
}
|