2018-01-27 09:35:31 +00:00
|
|
|
# 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/.
|
|
|
|
|
|
|
|
from __future__ import absolute_import, print_function
|
|
|
|
|
|
|
|
import os
|
|
|
|
import signal
|
|
|
|
import which
|
|
|
|
import re
|
|
|
|
|
|
|
|
# Py3/Py2 compatibility.
|
|
|
|
try:
|
|
|
|
from json.decoder import JSONDecodeError
|
|
|
|
except ImportError:
|
|
|
|
JSONDecodeError = ValueError
|
|
|
|
|
|
|
|
from mozlint import result
|
|
|
|
from mozprocess import ProcessHandlerMixin
|
|
|
|
|
|
|
|
|
|
|
|
CODESPELL_NOT_FOUND = """
|
|
|
|
Unable to locate codespell, please ensure it is installed and in
|
|
|
|
your PATH or set the CODESPELL environment variable.
|
|
|
|
|
|
|
|
https://github.com/lucasdemarchi/codespell or your system's package manager.
|
|
|
|
""".strip()
|
|
|
|
|
|
|
|
results = []
|
|
|
|
|
|
|
|
CODESPELL_FORMAT_REGEX = re.compile(r'(.*):(.*): (.*) ==> (.*)$')
|
|
|
|
|
|
|
|
|
|
|
|
class CodespellProcess(ProcessHandlerMixin):
|
|
|
|
def __init__(self, config, *args, **kwargs):
|
|
|
|
self.config = config
|
|
|
|
kwargs['processOutputLine'] = [self.process_line]
|
|
|
|
ProcessHandlerMixin.__init__(self, *args, **kwargs)
|
|
|
|
|
|
|
|
def process_line(self, line):
|
|
|
|
try:
|
|
|
|
match = CODESPELL_FORMAT_REGEX.match(line)
|
|
|
|
abspath, line, typo, correct = match.groups()
|
|
|
|
except AttributeError:
|
|
|
|
print('Unable to match regex against output: {}'.format(line))
|
|
|
|
return
|
|
|
|
|
|
|
|
# Ignore false positive like aParent (which would be fixed to apparent)
|
|
|
|
# See https://github.com/lucasdemarchi/codespell/issues/314
|
|
|
|
m = re.match(r'^[a-z][A-Z][a-z]*', typo)
|
|
|
|
if m:
|
|
|
|
return
|
|
|
|
res = {'path': os.path.relpath(abspath, self.config['root']),
|
|
|
|
'message': typo + " ==> " + correct,
|
|
|
|
'level': "warning",
|
|
|
|
'lineno': line,
|
|
|
|
}
|
|
|
|
results.append(result.from_config(self.config, **res))
|
|
|
|
|
|
|
|
def run(self, *args, **kwargs):
|
|
|
|
orig = signal.signal(signal.SIGINT, signal.SIG_IGN)
|
|
|
|
ProcessHandlerMixin.run(self, *args, **kwargs)
|
|
|
|
signal.signal(signal.SIGINT, orig)
|
|
|
|
|
|
|
|
|
|
|
|
def run_process(config, cmd):
|
|
|
|
proc = CodespellProcess(config, cmd)
|
|
|
|
proc.run()
|
|
|
|
try:
|
|
|
|
proc.wait()
|
|
|
|
except KeyboardInterrupt:
|
|
|
|
proc.kill()
|
|
|
|
|
|
|
|
|
|
|
|
def get_codespell_binary():
|
|
|
|
"""
|
|
|
|
Returns the path of the first codespell binary available
|
|
|
|
if not found returns None
|
|
|
|
"""
|
|
|
|
binary = os.environ.get('CODESPELL')
|
|
|
|
if binary:
|
|
|
|
return binary
|
|
|
|
|
|
|
|
try:
|
|
|
|
return which.which('codespell')
|
|
|
|
except which.WhichError:
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
|
|
def lint(paths, config, fix=None, **lintargs):
|
|
|
|
|
|
|
|
binary = get_codespell_binary()
|
|
|
|
|
|
|
|
if not binary:
|
|
|
|
print(CODESPELL_NOT_FOUND)
|
|
|
|
if 'MOZ_AUTOMATION' in os.environ:
|
|
|
|
return 1
|
|
|
|
return []
|
|
|
|
|
|
|
|
config['root'] = lintargs['root']
|
|
|
|
cmd_args = [binary,
|
|
|
|
'--disable-colors',
|
|
|
|
# Silence some warnings:
|
|
|
|
# 1: disable warnings about wrong encoding
|
|
|
|
# 2: disable warnings about binary file
|
2018-03-12 16:25:35 +00:00
|
|
|
'--quiet-level=3',
|
2018-01-27 09:35:31 +00:00
|
|
|
]
|
|
|
|
|
|
|
|
# Disabled for now because of
|
|
|
|
# https://github.com/lucasdemarchi/codespell/issues/314
|
|
|
|
# if fix:
|
|
|
|
# cmd_args.append('--write-changes')
|
|
|
|
|
|
|
|
base_command = cmd_args + paths
|
|
|
|
|
|
|
|
run_process(config, base_command)
|
|
|
|
return results
|