mirror of
https://github.com/pre-commit/pre-commit.git
synced 2026-01-13 20:40:08 -06:00
Merge pull request #1028 from yoavcaspi/warn_unknown_keys
Add warning to additional keys in config
This commit is contained in:
@@ -3,6 +3,7 @@ from __future__ import unicode_literals
|
||||
|
||||
import argparse
|
||||
import functools
|
||||
import logging
|
||||
import pipes
|
||||
import sys
|
||||
|
||||
@@ -15,6 +16,8 @@ from pre_commit.error_handler import FatalError
|
||||
from pre_commit.languages.all import all_languages
|
||||
from pre_commit.util import parse_version
|
||||
|
||||
logger = logging.getLogger('pre_commit')
|
||||
|
||||
|
||||
def check_type_tag(tag):
|
||||
if tag not in ALL_TAGS:
|
||||
@@ -106,6 +109,8 @@ META = 'meta'
|
||||
|
||||
|
||||
class MigrateShaToRev(object):
|
||||
key = 'rev'
|
||||
|
||||
@staticmethod
|
||||
def _cond(key):
|
||||
return cfgv.Conditional(
|
||||
@@ -144,6 +149,14 @@ def _entry(modname):
|
||||
)
|
||||
|
||||
|
||||
def warn_unknown_keys(extra, orig_keys):
|
||||
logger.warning(
|
||||
'Unexpected config key(s): {}'.format(
|
||||
', '.join(sorted(extra)),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
_meta = (
|
||||
(
|
||||
'check-hooks-apply', (
|
||||
@@ -222,6 +235,10 @@ CONFIG_REPO_DICT = cfgv.Map(
|
||||
),
|
||||
|
||||
MigrateShaToRev(),
|
||||
cfgv.WarnAdditionalKeys(
|
||||
('repo', 'rev', 'hooks'),
|
||||
warn_unknown_keys,
|
||||
),
|
||||
)
|
||||
DEFAULT_LANGUAGE_VERSION = cfgv.Map(
|
||||
'DefaultLanguageVersion', None,
|
||||
@@ -247,6 +264,17 @@ CONFIG_SCHEMA = cfgv.Map(
|
||||
cfgv.check_and(cfgv.check_string, check_min_version),
|
||||
'0',
|
||||
),
|
||||
cfgv.WarnAdditionalKeys(
|
||||
(
|
||||
'repos',
|
||||
'default_language_version',
|
||||
'default_stages',
|
||||
'exclude',
|
||||
'fail_fast',
|
||||
'minimum_pre_commit_version',
|
||||
),
|
||||
warn_unknown_keys,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user