pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-04-05 11:36:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add option to show expected output

Browse source 
This prints a diff between the given json file and the expected
(pretty) output, with this functionality hidden behind a cli flag
This commit is contained in:
Joey Pinhas 2019-08-16 12:38:41 -04:00
parent 3e9db01775
commit 780f20249f
1 changed files with 18 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

28
pre_commit_hooks/pretty_format_json.py
View file

@ -4,6 +4,7 @@ import argparse
import io import io
import json import json
import sys import sys
import difflib
from collections import OrderedDict from collections import OrderedDict
from typing import List from typing import List
from typing import Mapping from typing import Mapping
@ -55,6 +56,14 @@ def parse_topkeys(s): # type: (str) -> List[str]
return s.split(',') return s.split(',')
def get_diff(source, target):
source_lines = ''.join(source).split('\n')
target_lines = ''.join(target).split('\n')
d = difflib.Differ()
diff = d.compare(source_lines, target_lines)
return '\n'.join(diff)
def main(argv=None): # type: (Optional[Sequence[str]]) -> int def main(argv=None): # type: (Optional[Sequence[str]]) -> int
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
parser.add_argument( parser.add_argument(
@ -96,6 +105,13 @@ def main(argv=None): # type: (Optional[Sequence[str]]) -> int
default=[], default=[],
help='Ordered list of keys to keep at the top of JSON hashes', help='Ordered list of keys to keep at the top of JSON hashes',
) )
parser.add_argument(
'--show-expected',
action='store_true',
dest='show_expected',
default=False,
help='Show a diff between the input file and expected (pretty) output',
)
parser.add_argument('filenames', nargs='*', help='Filenames to fix') parser.add_argument('filenames', nargs='*', help='Filenames to fix')
args = parser.parse_args(argv) args = parser.parse_args(argv)
@ -115,16 +131,8 @@ def main(argv=None): # type: (Optional[Sequence[str]]) -> int
if contents != pretty_contents: if contents != pretty_contents:
print('File {} is not pretty-formatted'.format(json_file)) print('File {} is not pretty-formatted'.format(json_file))
contents_by_line = ''.join(contents).split('\n') if args.show_expected:
pretty_contents_by_line = ''.join(pretty_contents).split('\n') print(get_diff(contents, pretty_contents))
diff = len(contents_by_line) - len(pretty_contents_by_line)
if diff > 0:
pretty_contents_by_line.extend([''] * diff)
for line_num, line in enumerate(contents_by_line):
if line != pretty_contents_by_line[line_num]:
print('{}:{}'.format(json_file, line_num))
if args.autofix: if args.autofix:
_autofix(json_file, pretty_contents) _autofix(json_file, pretty_contents)