deprecate pre-commit-validate-{config,manifest}

asottile · asottile · commit 777ffdd692b8 · 2022-04-24T19:08:47.000-04:00
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -1,6 +1,6 @@
 -   id: validate_manifest
     name: validate pre-commit manifest
     description: This validator validates a pre-commit hooks manifest file
-    entry: pre-commit-validate-manifest
+    entry: pre-commit validate-manifest
     language: python
-    files: ^(\.pre-commit-hooks\.yaml|hooks\.yaml)$
+    files: ^\.pre-commit-hooks\.yaml$
diff --git a/pre_commit/clientlib.py b/pre_commit/clientlib.py
@@ -14,6 +14,8 @@
 
 import pre_commit.constants as C
 from pre_commit.color import add_color_option
+from pre_commit.commands.validate_config import validate_config
+from pre_commit.commands.validate_manifest import validate_manifest
 from pre_commit.errors import FatalError
 from pre_commit.languages.all import all_languages
 from pre_commit.logging_handler import logging_handler
@@ -100,14 +102,12 @@ def validate_manifest_main(argv: Sequence[str] | None = None) -> int:
     args = parser.parse_args(argv)
 
     with logging_handler(args.color):
-        ret = 0
-        for filename in args.filenames:
-            try:
-                load_manifest(filename)
-            except InvalidManifestError as e:
-                print(e)
-                ret = 1
-        return ret
+        logger.warning(
+            'pre-commit-validate-manifest is deprecated -- '
+            'use `pre-commit validate-manifest` instead.',
+        )
+
+        return validate_manifest(args.filenames)
 
 
 LOCAL = 'local'
@@ -409,11 +409,9 @@ def validate_config_main(argv: Sequence[str] | None = None) -> int:
     args = parser.parse_args(argv)
 
     with logging_handler(args.color):
-        ret = 0
-        for filename in args.filenames:
-            try:
-                load_config(filename)
-            except InvalidConfigError as e:
-                print(e)
-                ret = 1
-        return ret
+        logger.warning(
+            'pre-commit-validate-config is deprecated -- '
+            'use `pre-commit validate-config` instead.',
+        )
+
+        return validate_config(args.filenames)
diff --git a/pre_commit/commands/validate_config.py b/pre_commit/commands/validate_config.py
@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from pre_commit import clientlib
+
+
+def validate_config(filenames: list[str]) -> int:
+    ret = 0
+
+    for filename in filenames:
+        try:
+            clientlib.load_config(filename)
+        except clientlib.InvalidConfigError as e:
+            print(e)
+            ret = 1
+
+    return ret
diff --git a/pre_commit/commands/validate_manifest.py b/pre_commit/commands/validate_manifest.py
@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from pre_commit import clientlib
+
+
+def validate_manifest(filenames: list[str]) -> int:
+    ret = 0
+
+    for filename in filenames:
+        try:
+            clientlib.load_manifest(filename)
+        except clientlib.InvalidManifestError as e:
+            print(e)
+            ret = 1
+
+    return ret
diff --git a/pre_commit/main.py b/pre_commit/main.py
@@ -21,6 +21,8 @@
 from pre_commit.commands.run import run
 from pre_commit.commands.sample_config import sample_config
 from pre_commit.commands.try_repo import try_repo
+from pre_commit.commands.validate_config import validate_config
+from pre_commit.commands.validate_manifest import validate_manifest
 from pre_commit.error_handler import error_handler
 from pre_commit.logging_handler import logging_handler
 from pre_commit.store import Store
@@ -34,8 +36,10 @@
 # pyvenv
 os.environ.pop('__PYVENV_LAUNCHER__', None)
 
-
-COMMANDS_NO_GIT = {'clean', 'gc', 'init-templatedir', 'sample-config'}
+COMMANDS_NO_GIT = {
+    'clean', 'gc', 'init-templatedir', 'sample-config',
+    'validate-config', 'validate-manifest',
+}
 
 
 def _add_config_option(parser: argparse.ArgumentParser) -> None:
@@ -304,6 +308,20 @@ def main(argv: Sequence[str] | None = None) -> int:
     _add_config_option(uninstall_parser)
     _add_hook_type_option(uninstall_parser)
 
+    validate_config_parser = subparsers.add_parser(
+        'validate-config', help='Validate .pre-commit-config.yaml files',
+    )
+    add_color_option(validate_config_parser)
+    _add_config_option(validate_config_parser)
+    validate_config_parser.add_argument('filenames', nargs='*')
+
+    validate_manifest_parser = subparsers.add_parser(
+        'validate-manifest', help='Validate .pre-commit-hooks.yaml files',
+    )
+    add_color_option(validate_manifest_parser)
+    _add_config_option(validate_manifest_parser)
+    validate_manifest_parser.add_argument('filenames', nargs='*')
+
     help = subparsers.add_parser(
         'help', help='Show help for a specific command.',
     )
@@ -378,6 +396,10 @@ def main(argv: Sequence[str] | None = None) -> int:
                 config_file=args.config,
                 hook_types=args.hook_types,
             )
+        elif args.command == 'validate-config':
+            return validate_config(args.filenames)
+        elif args.command == 'validate-manifest':
+            return validate_manifest(args.filenames)
         else:
             raise NotImplementedError(
                 f'Command {args.command} not implemented.',
diff --git a/tests/clientlib_test.py b/tests/clientlib_test.py
@@ -122,8 +122,8 @@ def test_validate_config_old_list_format_ok(tmpdir, cap_out):
     f = tmpdir.join('cfg.yaml')
     f.write('-  {repo: meta, hooks: [{id: identity}]}')
     assert not validate_config_main((f.strpath,))
-    start = '[WARNING] normalizing pre-commit configuration to a top-level map'
-    assert cap_out.get().startswith(start)
+    msg = '[WARNING] normalizing pre-commit configuration to a top-level map'
+    assert msg in cap_out.get()
 
 
 def test_validate_warn_on_unknown_keys_at_repo_level(tmpdir, caplog):
@@ -139,6 +139,12 @@ def test_validate_warn_on_unknown_keys_at_repo_level(tmpdir, caplog):
     ret_val = validate_config_main((f.strpath,))
     assert not ret_val
     assert caplog.record_tuples == [
+        (
+            'pre_commit',
+            logging.WARNING,
+            'pre-commit-validate-config is deprecated -- '
+            'use `pre-commit validate-config` instead.',
+        ),
         (
             'pre_commit',
             logging.WARNING,
@@ -162,6 +168,12 @@ def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
     ret_val = validate_config_main((f.strpath,))
     assert not ret_val
     assert caplog.record_tuples == [
+        (
+            'pre_commit',
+            logging.WARNING,
+            'pre-commit-validate-config is deprecated -- '
+            'use `pre-commit validate-config` instead.',
+        ),
         (
             'pre_commit',
             logging.WARNING,
diff --git a/tests/main_test.py b/tests/main_test.py
@@ -79,6 +79,7 @@ def test_adjust_args_try_repo_repo_relative(in_git_dir):
 FNS = (
     'autoupdate', 'clean', 'gc', 'hook_impl', 'install', 'install_hooks',
     'migrate_config', 'run', 'sample_config', 'uninstall',
+    'validate_config', 'validate_manifest',
 )
 CMDS = tuple(fn.replace('_', '-') for fn in FNS)
 

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ def test_adjust_args_try_repo_repo_relative(in_git_dir):`
`79`	`79`	`FNS = (`
`80`	`80`	`'autoupdate', 'clean', 'gc', 'hook_impl', 'install', 'install_hooks',`
`81`	`81`	`'migrate_config', 'run', 'sample_config', 'uninstall',`
	`82`	`+ 'validate_config', 'validate_manifest',`
`82`	`83`	`)`
`83`	`84`	`CMDS = tuple(fn.replace('_', '-') for fn in FNS)`
`84`	`85`