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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
from __future__ import annotations
import argparse
import json
import logging
import shutil
import subprocess
import sys
import time
from enum import Enum
from typing import NamedTuple
LINTER_CODE = "SHELLCHECK"
class LintSeverity(str, Enum):
ERROR = "error"
WARNING = "warning"
ADVICE = "advice"
DISABLED = "disabled"
class LintMessage(NamedTuple):
path: str | None
line: int | None
char: int | None
code: str
severity: LintSeverity
name: str
original: str | None
replacement: str | None
description: str | None
def run_command(
args: list[str],
) -> subprocess.CompletedProcess[bytes]:
logging.debug("$ %s", " ".join(args))
start_time = time.monotonic()
try:
return subprocess.run(
args,
capture_output=True,
)
finally:
end_time = time.monotonic()
logging.debug("took %dms", (end_time - start_time) * 1000)
def check_files(
files: list[str],
) -> list[LintMessage]:
try:
proc = run_command(
["shellcheck", "--external-sources", "--format=json1"] + files
)
except OSError as err:
return [
LintMessage(
path=None,
line=None,
char=None,
code=LINTER_CODE,
severity=LintSeverity.ERROR,
name="command-failed",
original=None,
replacement=None,
description=(f"Failed due to {err.__class__.__name__}:\n{err}"),
)
]
stdout = str(proc.stdout, "utf-8").strip()
results = json.loads(stdout)["comments"]
return [
LintMessage(
path=result["file"],
name=f"SC{result['code']}",
description=result["message"],
line=result["line"],
char=result["column"],
code=LINTER_CODE,
severity=LintSeverity.ERROR,
original=None,
replacement=None,
)
for result in results
]
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="shellcheck runner",
fromfile_prefix_chars="@",
)
parser.add_argument(
"filenames",
nargs="+",
help="paths to lint",
)
if shutil.which("shellcheck") is None:
err_msg = LintMessage(
path="<none>",
line=None,
char=None,
code=LINTER_CODE,
severity=LintSeverity.ERROR,
name="command-failed",
original=None,
replacement=None,
description="shellcheck is not installed, did you forget to run `lintrunner init`?",
)
print(json.dumps(err_msg._asdict()), flush=True)
sys.exit(0)
args = parser.parse_args()
lint_messages = check_files(args.filenames)
for lint_message in lint_messages:
print(json.dumps(lint_message._asdict()), flush=True)
|
