mirror of
https://github.com/pre-commit/pre-commit-hooks.git
synced 2026-06-28 21:50:46 +00:00
94 lines
2.4 KiB
Python
94 lines
2.4 KiB
Python
"""
|
|
A very simple pre-commit hook that, when passed one or more filenames
|
|
as arguments, will sort the lines in those files.
|
|
|
|
An example use case for this: you have a deploy-allowlist.txt file
|
|
in a repo that contains a list of filenames that is used to specify
|
|
files to be included in a docker container. This file has one filename
|
|
per line. Various users are adding/removing lines from this file; using
|
|
this hook on that file should reduce the instances of git merge
|
|
conflicts and keep the file nicely ordered.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
from collections.abc import Callable
|
|
from collections.abc import Iterable
|
|
from collections.abc import Sequence
|
|
from typing import Any
|
|
from typing import IO
|
|
|
|
PASS = 0
|
|
FAIL = 1
|
|
|
|
|
|
def sort_file_contents(
|
|
f: IO[bytes],
|
|
key: Callable[[bytes], Any] | None,
|
|
*,
|
|
unique: bool = False,
|
|
) -> int:
|
|
before = list(f)
|
|
# detect the line ending style of the file, based on the first line
|
|
new_line = b'\r\n' if before and before[0].endswith(b'\r\n') else b'\n'
|
|
|
|
lines: Iterable[bytes] = (
|
|
line.rstrip(new_line) for line in before if line.strip()
|
|
)
|
|
if unique:
|
|
lines = set(lines)
|
|
after = sorted(lines, key=key)
|
|
|
|
before_string = b''.join(before)
|
|
after_string = new_line.join(after)
|
|
|
|
if after_string:
|
|
after_string += new_line
|
|
|
|
if before_string == after_string:
|
|
return PASS
|
|
else:
|
|
f.seek(0)
|
|
f.write(after_string)
|
|
f.truncate()
|
|
return FAIL
|
|
|
|
|
|
def main(argv: Sequence[str] | None = None) -> int:
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('filenames', nargs='+', help='Files to sort')
|
|
|
|
mutex = parser.add_mutually_exclusive_group(required=False)
|
|
mutex.add_argument(
|
|
'--ignore-case',
|
|
action='store_const',
|
|
const=bytes.lower,
|
|
default=None,
|
|
help='fold lower case to upper case characters',
|
|
)
|
|
mutex.add_argument(
|
|
'--unique',
|
|
action='store_true',
|
|
help='ensure each line is unique',
|
|
)
|
|
|
|
args = parser.parse_args(argv)
|
|
|
|
retv = PASS
|
|
|
|
for arg in args.filenames:
|
|
with open(arg, 'rb+') as file_obj:
|
|
ret_for_file = sort_file_contents(
|
|
file_obj, key=args.ignore_case, unique=args.unique,
|
|
)
|
|
|
|
if ret_for_file:
|
|
print(f'Sorting {arg}')
|
|
|
|
retv |= ret_for_file
|
|
|
|
return retv
|
|
|
|
|
|
if __name__ == '__main__':
|
|
raise SystemExit(main())
|