Skip to content

Fix check-useless-exclude to consider types filter #837

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
Oct 2, 2018
Merged

Fix check-useless-exclude to consider types filter #837

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
5 changes: 4 additions & 1 deletion pre_commit/meta_hooks/check_useless_excludes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from pre_commit import git
from pre_commit.clientlib import load_config
from pre_commit.clientlib import MANIFEST_HOOK_DICT
from pre_commit.commands.run import _filter_by_types


def exclude_matches_any(filenames, include, exclude):
Expand Down Expand Up @@ -39,8 +40,10 @@ def check_useless_excludes(config_file):
# Not actually a manifest dict, but this more accurately reflects
# the defaults applied during runtime
hook = apply_defaults(hook, MANIFEST_HOOK_DICT)
types, exclude_types = hook['types'], hook['exclude_types']
filtered_by_types = _filter_by_types(files, types, exclude_types)
include, exclude = hook['files'], hook['exclude']
if not exclude_matches_any(files, include, exclude):
if not exclude_matches_any(filtered_by_types, include, exclude):
print(
'The exclude pattern {!r} for {} does not match any files'
.format(exclude, hook['id']),
Expand Down
31 changes: 31 additions & 0 deletions tests/meta_hooks/check_useless_excludes_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,37 @@ def test_useless_exclude_for_hook(capsys, tempdir_factory):
assert expected == out


def test_useless_exclude_with_types_filter(capsys, tempdir_factory):
config = {
'repos': [
{
'repo': 'meta',
'hooks': [
{
'id': 'check-useless-excludes',
'exclude': '.pre-commit-config.yaml',
'types': ['python'],
},
],
},
],
}

repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config)

with cwd(repo):
assert check_useless_excludes.main(()) == 1

out, _ = capsys.readouterr()
out = out.strip()
expected = (
"The exclude pattern '.pre-commit-config.yaml' for "
"check-useless-excludes does not match any files"
)
assert expected == out


def test_no_excludes(capsys, tempdir_factory):
config = {
'repos': [
Expand Down