mirror of
https://github.com/pre-commit/pre-commit-hooks.git
synced 2026-04-05 11:36:54 +00:00
a17514d55e
This change adds an advisory mode via `--check` that only warns of formatting issues with files, but does not address them. This support is desirable because--while I don't mind the automagic changes when done in a mechanical way--some individuals who I described the current behavior of these fixers to were a bit uneasy about the magic that went along with them. Adding `--check` so others can opt out (similar to `black --check`) is a compromise on this front. Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
107 lines
3.5 KiB
Python
107 lines
3.5 KiB
Python
from __future__ import print_function
|
|
|
|
import argparse
|
|
import os
|
|
import sys
|
|
from typing import Optional
|
|
from typing import Sequence
|
|
|
|
|
|
def _fix_file(filename, is_markdown, chars=None, apply_fixes=True):
|
|
# type: (str, bool, Optional[bytes], bool) -> bool
|
|
with open(filename, mode='rb') as file_processed:
|
|
lines = file_processed.readlines()
|
|
newlines = [_process_line(line, is_markdown, chars) for line in lines]
|
|
if newlines != lines:
|
|
if apply_fixes:
|
|
with open(filename, mode='wb') as file_processed:
|
|
for line in newlines:
|
|
file_processed.write(line)
|
|
return newlines != lines
|
|
|
|
|
|
def _process_line(line, is_markdown, chars=None):
|
|
# type: (bytes, bool, Optional[bytes]) -> bytes
|
|
if line[-2:] == b'\r\n':
|
|
eol = b'\r\n'
|
|
line = line[:-2]
|
|
elif line[-1:] == b'\n':
|
|
eol = b'\n'
|
|
line = line[:-1]
|
|
else:
|
|
eol = b''
|
|
# preserve trailing two-space for non-blank lines in markdown files
|
|
if is_markdown and (not line.isspace()) and line.endswith(b' '):
|
|
return line[:-2].rstrip(chars) + b' ' + eol
|
|
return line.rstrip(chars) + eol
|
|
|
|
|
|
def main(argv=None): # type: (Optional[Sequence[str]]) -> int
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument(
|
|
'--check',
|
|
action='store_true',
|
|
help="Don't write the files back. Returns a non-zero code if changes "
|
|
'would be applied. Returns zero if no changes are required.',
|
|
)
|
|
parser.add_argument(
|
|
'--no-markdown-linebreak-ext',
|
|
action='store_true',
|
|
help=argparse.SUPPRESS,
|
|
)
|
|
parser.add_argument(
|
|
'--markdown-linebreak-ext',
|
|
action='append',
|
|
default=[],
|
|
metavar='*|EXT[,EXT,...]',
|
|
help=(
|
|
'Markdown extensions (or *) to not strip linebreak spaces. '
|
|
'default: %(default)s'
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
'--chars',
|
|
help=(
|
|
'The set of characters to strip from the end of lines. '
|
|
'Defaults to all whitespace characters.'
|
|
),
|
|
)
|
|
parser.add_argument('filenames', nargs='*', help='Filenames to fix')
|
|
args = parser.parse_args(argv)
|
|
|
|
if args.no_markdown_linebreak_ext:
|
|
print('--no-markdown-linebreak-ext now does nothing!')
|
|
|
|
md_args = args.markdown_linebreak_ext
|
|
if '' in md_args:
|
|
parser.error('--markdown-linebreak-ext requires a non-empty argument')
|
|
all_markdown = '*' in md_args
|
|
# normalize extensions; split at ',', lowercase, and force 1 leading '.'
|
|
md_exts = [
|
|
'.' + x.lower().lstrip('.') for x in ','.join(md_args).split(',')
|
|
]
|
|
|
|
# reject probable "eaten" filename as extension: skip leading '.' with [1:]
|
|
for ext in md_exts:
|
|
if any(c in ext[1:] for c in r'./\:'):
|
|
parser.error(
|
|
'bad --markdown-linebreak-ext extension {!r} (has . / \\ :)\n'
|
|
" (probably filename; use '--markdown-linebreak-ext=EXT')"
|
|
.format(ext),
|
|
)
|
|
chars = None if args.chars is None else args.chars.encode('utf-8')
|
|
return_code = 0
|
|
for filename in args.filenames:
|
|
_, extension = os.path.splitext(filename.lower())
|
|
md = all_markdown or extension in md_exts
|
|
if _fix_file(filename, md, chars, apply_fixes=not args.check):
|
|
if args.check:
|
|
print('Would fix {}'.format(filename))
|
|
else:
|
|
print('Fixing {}'.format(filename))
|
|
return_code = 1
|
|
return return_code
|
|
|
|
|
|
if __name__ == '__main__':
|
|
sys.exit(main())
|