forked from mirrors/gecko-dev
7860c29e4c
Before, on Windows, this resulted in installing the package in the parent environment (not the `virtualenv`). We fix this by passing down the `virtualenv_manager` so linters can install packages they need using that object's helper methods. Differential Revision: https://phabricator.services.mozilla.com/D95738
137 lines
3.6 KiB
Python
137 lines
3.6 KiB
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 os
|
|
import re
|
|
import subprocess
|
|
|
|
# py2-compat
|
|
try:
|
|
from json.decoder import JSONDecodeError
|
|
except ImportError:
|
|
JSONDecodeError = ValueError
|
|
|
|
from mozfile import which
|
|
|
|
from mozlint import result
|
|
from mozlint.util.implementation import LintProcess
|
|
|
|
here = os.path.abspath(os.path.dirname(__file__))
|
|
CODESPELL_REQUIREMENTS_PATH = os.path.join(here, "codespell_requirements.txt")
|
|
|
|
CODESPELL_NOT_FOUND = """
|
|
Could not find codespell! Install codespell and try again.
|
|
|
|
$ pip install -U --require-hashes -r {}
|
|
""".strip().format(
|
|
CODESPELL_REQUIREMENTS_PATH
|
|
)
|
|
|
|
|
|
CODESPELL_INSTALL_ERROR = """
|
|
Unable to install correct version of codespell
|
|
Try to install it manually with:
|
|
$ pip install -U --require-hashes -r {}
|
|
""".strip().format(
|
|
CODESPELL_REQUIREMENTS_PATH
|
|
)
|
|
|
|
results = []
|
|
|
|
CODESPELL_FORMAT_REGEX = re.compile(r"(.*):(.*): (.*) ==> (.*)$")
|
|
|
|
|
|
class CodespellProcess(LintProcess):
|
|
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": abspath,
|
|
"message": typo.strip() + " ==> " + correct,
|
|
"level": "error",
|
|
"lineno": line,
|
|
}
|
|
results.append(result.from_config(self.config, **res))
|
|
|
|
|
|
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
|
|
|
|
return which("codespell")
|
|
|
|
|
|
def setup(root, **lintargs):
|
|
virtualenv_manager = lintargs["virtualenv_manager"]
|
|
try:
|
|
virtualenv_manager.install_pip_requirements(
|
|
CODESPELL_REQUIREMENTS_PATH, quiet=True
|
|
)
|
|
except subprocess.CalledProcessError:
|
|
print(CODESPELL_INSTALL_ERROR)
|
|
return 1
|
|
|
|
|
|
def lint(paths, config, fix=None, **lintargs):
|
|
log = lintargs["log"]
|
|
binary = get_codespell_binary()
|
|
if not binary:
|
|
print(CODESPELL_NOT_FOUND)
|
|
if "MOZ_AUTOMATION" in os.environ:
|
|
return 1
|
|
return []
|
|
|
|
config["root"] = lintargs["root"]
|
|
|
|
skip_files = ""
|
|
if "exclude" in config:
|
|
skip_files = "--skip=*.dic,{}".format(",".join(config["exclude"]))
|
|
|
|
exclude_list = os.path.join(here, "exclude-list.txt")
|
|
cmd_args = [
|
|
which("python"),
|
|
binary,
|
|
"--disable-colors",
|
|
# Silence some warnings:
|
|
# 1: disable warnings about wrong encoding
|
|
# 2: disable warnings about binary file
|
|
# 4: shut down warnings about automatic fixes
|
|
# that were disabled in dictionary.
|
|
"--quiet-level=7",
|
|
"--ignore-words=" + exclude_list,
|
|
skip_files,
|
|
]
|
|
|
|
if fix:
|
|
cmd_args.append("--write-changes")
|
|
log.debug("Command: {}".format(" ".join(cmd_args)))
|
|
|
|
base_command = cmd_args + paths
|
|
|
|
run_process(config, base_command)
|
|
return results
|