Skip to content

extended warning if globs are used instead of regex to top level #1750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asottile merged 1 commit into from
Jan 2, 2021
Merged

extended warning if globs are used instead of regex to top level #1750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions pre_commit/clientlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def check(self, dct: Dict[str, Any]) -> None:
)


class OptionalSensibleRegex(cfgv.OptionalNoDefault):
class OptionalSensibleRegexAtHook(cfgv.OptionalNoDefault):
def check(self, dct: Dict[str, Any]) -> None:
super().check(dct)

Expand All @@ -144,6 +144,17 @@ def check(self, dct: Dict[str, Any]) -> None:
)


class OptionalSensibleRegexAtTop(cfgv.OptionalNoDefault):
def check(self, dct: Dict[str, Any]) -> None:
super().check(dct)

if '/*' in dct.get(self.key, ''):
logger.warning(
f'The top-level {self.key!r} field is a regex, not a glob -- '
f"matching '/*' probably isn't what you want here",
)


class MigrateShaToRev:
key = 'rev'

Expand Down Expand Up @@ -259,8 +270,8 @@ def warn_unknown_keys_repo(
for item in MANIFEST_HOOK_DICT.items
if item.key != 'id'
),
OptionalSensibleRegex('files', cfgv.check_string),
OptionalSensibleRegex('exclude', cfgv.check_string),
OptionalSensibleRegexAtHook('files', cfgv.check_string),
OptionalSensibleRegexAtHook('exclude', cfgv.check_string),
)
CONFIG_REPO_DICT = cfgv.Map(
'Repository', 'repo',
Expand Down Expand Up @@ -329,6 +340,8 @@ def warn_unknown_keys_repo(
),
warn_unknown_keys_root,
),
OptionalSensibleRegexAtTop('files', cfgv.check_string),
OptionalSensibleRegexAtTop('exclude', cfgv.check_string),

# do not warn about configuration for pre-commit.ci
cfgv.OptionalNoDefault('ci', cfgv.check_type(dict)),
Expand Down
19 changes: 18 additions & 1 deletion tests/clientlib_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ def test_warn_mutable_rev_conditional():
cfgv.validate(config_obj, CONFIG_REPO_DICT)


def test_validate_optional_sensible_regex(caplog):
def test_validate_optional_sensible_regex_at_hook_level(caplog):
config_obj = {
'id': 'flake8',
'files': 'dir/*.py',
Expand All @@ -261,6 +261,23 @@ def test_validate_optional_sensible_regex(caplog):
]


def test_validate_optional_sensible_regex_at_top_level(caplog):
config_obj = {
'files': 'dir/*.py',
'repos': [],
}
cfgv.validate(config_obj, CONFIG_SCHEMA)

assert caplog.record_tuples == [
(
'pre_commit',
logging.WARNING,
"The top-level 'files' field is a regex, not a glob -- matching "
"'/*' probably isn't what you want here",
),
]


@pytest.mark.parametrize('fn', (validate_config_main, validate_manifest_main))
def test_mains_not_ok(tmpdir, fn):
not_yaml = tmpdir.join('f.notyaml')
Expand Down