170 lines
4.4 KiB
Python
170 lines
4.4 KiB
Python
"""Main CLI entry point."""
|
|
|
|
import argparse
|
|
import pathlib
|
|
import sys
|
|
from typing import Optional
|
|
|
|
from tclint.checks import get_checkers
|
|
from tclint.cli.resolver import Resolver
|
|
from tclint.cli.utils import register_codec_warning
|
|
from tclint.commands.plugins import PluginManager
|
|
from tclint.comments import CommentVisitor
|
|
from tclint.config import Config, ConfigError, setup_config_cli_args
|
|
from tclint.parser import Parser, TclSyntaxError
|
|
from tclint.violations import Rule, Violation
|
|
|
|
try:
|
|
from tclint._version import __version__ # type: ignore
|
|
except ModuleNotFoundError:
|
|
__version__ = "(unknown version)"
|
|
|
|
# exit code flags
|
|
EXIT_OK = 0
|
|
EXIT_LINT_VIOLATIONS = 1
|
|
EXIT_SYNTAX_ERROR = 2
|
|
EXIT_INPUT_ERROR = 4
|
|
|
|
|
|
def filter_violations(
|
|
violations: list[Violation],
|
|
config_ignore: list[Rule],
|
|
inline_ignore: dict[int, list[Rule]],
|
|
) -> list[Violation]:
|
|
filtered_violations = []
|
|
|
|
for violation in violations:
|
|
if violation.id in config_ignore:
|
|
continue
|
|
line = violation.start[0]
|
|
if line in inline_ignore and violation.id in inline_ignore[line]:
|
|
continue
|
|
|
|
filtered_violations.append(violation)
|
|
|
|
return filtered_violations
|
|
|
|
|
|
def lint(
|
|
script: str,
|
|
config: Config,
|
|
plugins: PluginManager,
|
|
path: Optional[pathlib.Path],
|
|
debug=0,
|
|
) -> list[Violation]:
|
|
parser = Parser(debug=(debug > 0), commands=plugins.get_commands(config.commands))
|
|
|
|
violations = []
|
|
tree = parser.parse(script)
|
|
violations += parser.violations
|
|
|
|
if debug > 0:
|
|
print(tree.pretty(positions=(debug > 1)))
|
|
|
|
for checker in get_checkers(plugins):
|
|
violations += checker.check(script, tree, config)
|
|
|
|
v = CommentVisitor()
|
|
ignore_lines = v.run(tree, path)
|
|
violations = filter_violations(violations, config.ignore, ignore_lines)
|
|
|
|
return violations
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser("tclint")
|
|
parser.add_argument(
|
|
"--version", action="version", version=f"%(prog)s {__version__}"
|
|
)
|
|
parser.add_argument(
|
|
"source",
|
|
nargs="+",
|
|
help="files to lint. Provide '-' to read from stdin",
|
|
type=pathlib.Path,
|
|
)
|
|
parser.add_argument(
|
|
"-d",
|
|
"--debug",
|
|
action="count",
|
|
default=0,
|
|
help=(
|
|
"display debug output. Provide additional times to increase the verbosity"
|
|
" of output (e.g. -dd)"
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
"-c",
|
|
"--config",
|
|
help="path to config file",
|
|
type=pathlib.Path,
|
|
default=None,
|
|
metavar="<path>",
|
|
)
|
|
|
|
cwd = pathlib.Path.cwd()
|
|
setup_config_cli_args(parser, cwd)
|
|
args = parser.parse_args()
|
|
|
|
global_config = None
|
|
if args.config is not None:
|
|
try:
|
|
global_config = Config.from_path(args.config, cwd)
|
|
global_config.apply_cli_args(args)
|
|
except FileNotFoundError:
|
|
print(f"Config file path doesn't exist: {args.config}")
|
|
return EXIT_INPUT_ERROR
|
|
except ConfigError as e:
|
|
print(f"Invalid config file: {e}")
|
|
return EXIT_INPUT_ERROR
|
|
|
|
resolver = Resolver(args, global_config)
|
|
try:
|
|
sources = resolver.resolve_sources(args.source, cwd)
|
|
except FileNotFoundError as e:
|
|
print(f"Invalid path provided: {e}")
|
|
return EXIT_INPUT_ERROR
|
|
except ConfigError as e:
|
|
print(f"Invalid config file: {e}")
|
|
return EXIT_INPUT_ERROR
|
|
|
|
plugin_manager = PluginManager(trust_uninstalled=args.trust_plugins)
|
|
|
|
retcode = EXIT_OK
|
|
|
|
register_codec_warning("replace_with_warning")
|
|
|
|
for path, config in sources:
|
|
if path is None:
|
|
script = sys.stdin.read()
|
|
out_prefix = "(stdin)"
|
|
else:
|
|
with open(path, "r", errors="replace_with_warning") as f:
|
|
script = f.read()
|
|
out_prefix = str(path)
|
|
|
|
try:
|
|
violations = lint(
|
|
script,
|
|
config,
|
|
plugin_manager,
|
|
path,
|
|
debug=args.debug,
|
|
)
|
|
except TclSyntaxError as e:
|
|
line, col = e.start
|
|
print(f"{out_prefix}:{line}:{col}: syntax error: {e}")
|
|
retcode |= EXIT_SYNTAX_ERROR
|
|
continue
|
|
|
|
for violation in sorted(violations):
|
|
print(f"{out_prefix}:{violation}")
|
|
|
|
if len(violations) > 0:
|
|
retcode |= EXIT_LINT_VIOLATIONS
|
|
|
|
return retcode
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|