third-party/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-04-15 01:51:46 +04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add a check and test to the real top level and improve the warning message

Browse source
This commit is contained in:
Yoav Caspi 2019-05-11 22:57:52 +03:00
parent fd9d9d276b
commit 217d31ec1c
2 changed files with 32 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
pre_commit/clientlib.py
View file

@ -149,12 +149,10 @@ def _entry(modname):
def warn_on_unknown_keys_at_top_level(extra, orig_keys): def warn_on_unknown_keys_at_top_level(extra, orig_keys):
logger.warning( logger.warning(
'Your pre-commit-config contain these extra keys: {}. ' 'Unexpected config key(s): {}'.format(
'while the only valid keys are: {}.'.format( ', '.join(sorted(extra)),
', '.join(extra),
', '.join(sorted(orig_keys)),
), ),
), )
_meta = ( _meta = (
@ -236,7 +234,7 @@ CONFIG_REPO_DICT = cfgv.Map(
MigrateShaToRev(), MigrateShaToRev(),
cfgv.WarnAdditionalKeys( cfgv.WarnAdditionalKeys(
{'repo', 'rev', 'hooks'}, ('repo', 'rev', 'hooks'),
warn_on_unknown_keys_at_top_level, warn_on_unknown_keys_at_top_level,
), ),
) )
@ -264,6 +262,10 @@ CONFIG_SCHEMA = cfgv.Map(
cfgv.check_and(cfgv.check_string, check_min_version), cfgv.check_and(cfgv.check_string, check_min_version),
'0', '0',
), ),
cfgv.WarnAdditionalKeys(
('repos',),
warn_on_unknown_keys_at_top_level,
),
) )

27
tests/clientlib_test.py
View file

@ -118,7 +118,7 @@ def test_validate_config_old_list_format_ok(tmpdir):
assert not validate_config_main((f.strpath,)) assert not validate_config_main((f.strpath,))
def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog): def test_validate_warn_on_unknown_keys_at_repo_level(tmpdir, caplog):
f = tmpdir.join('cfg.yaml') f = tmpdir.join('cfg.yaml')
f.write( f.write(
'- repo: https://gitlab.com/pycqa/flake8\n' '- repo: https://gitlab.com/pycqa/flake8\n'
@ -133,8 +133,29 @@ def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
( (
'pre_commit', 'pre_commit',
logging.WARNING, logging.WARNING,
'Your pre-commit-config contain these extra keys: args. ' 'Unexpected config key(s): args',
'while the only valid keys are: hooks, repo, rev.', ),
]
def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
f = tmpdir.join('cfg.yaml')
f.write(
'repos:\n'
'- repo: https://gitlab.com/pycqa/flake8\n'
' rev: 3.7.7\n'
' hooks:\n'
' - id: flake8\n'
'foo:\n'
' id: 1.0.0\n',
)
ret_val = validate_config_main((f.strpath,))
assert not ret_val
assert caplog.record_tuples == [
(
'pre_commit',
logging.WARNING,
'Unexpected config key(s): foo',
), ),
] ]