Improve naming and help output

antonbabenko · Jan 3, 2025 · 449d448 · 449d448
1 parent c2aab92
commit 449d448
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/src/pre_commit_terraform/_cli_parsing.py b/src/pre_commit_terraform/_cli_parsing.py
@@ -27,6 +27,7 @@ def populate_common_argument_parser(parser: ArgumentParser) -> None:
         '-h',
         '--hook-config',
         action='append',
+        metavar='KEY=VALUE',
         help='Arguments that configure hook behavior',
         default=[],
     )
@@ -42,6 +43,8 @@ def populate_common_argument_parser(parser: ArgumentParser) -> None:
         '-e',
         '--env-vars',
         '--envs',
+        dest='env_vars_strs',
+        metavar='KEY=VALUE',
         action='append',
         help='Setup additional Environment Variables during hook execution',
         default=[],

diff --git a/tests/pytest/test__cli_parsing.py b/tests/pytest/test__cli_parsing.py
@@ -20,7 +20,7 @@ def test_populate_common_argument_parser(mocker):
     assert args.args == ['arg1']
     assert args.hook_config == ['hook1']
     assert args.tf_init_args == ['init1']
-    assert args.env_vars == ['env1']
+    assert args.env_vars_strs == ['env1']
     assert args.files == ['file1', 'file2']
 
 
@@ -32,7 +32,7 @@ def test_populate_common_argument_parser_defaults(mocker):
     assert args.args == []
     assert args.hook_config == []
     assert args.tf_init_args == []
-    assert args.env_vars == []
+    assert args.env_vars_strs == []
     assert args.files == []
 
 
@@ -65,7 +65,7 @@ def test_populate_common_argument_parser_multiple_values(mocker):
     assert args.args == ['arg1', 'arg2']
     assert args.hook_config == ['hook1', 'hook2']
     assert args.tf_init_args == ['init1', 'init2']
-    assert args.env_vars == ['env1', 'env2']
+    assert args.env_vars_strs == ['env1', 'env2']
     assert args.files == ['file1', 'file2']
 
 
@@ -91,7 +91,7 @@ def test_attach_subcommand_parsers_to(mocker):
     assert args.args == ['arg1']
     assert args.hook_config == ['hook1']
     assert args.tf_init_args == ['init1']
-    assert args.env_vars == ['env1']
+    assert args.env_vars_strs == ['env1']
     assert args.files == ['file1', 'file2']
     assert args.invoke_cli_app == mock_subcommand_module.invoke_cli_app
 
@@ -168,7 +168,7 @@ def test_initialize_argument_parser(mocker):
     assert args.args == ['arg1']
     assert args.hook_config == ['hook1']
     assert args.tf_init_args == ['init1']
-    assert args.env_vars == ['env1']
+    assert args.env_vars_strs == ['env1']
     assert args.files == ['file1', 'file2']
     assert args.invoke_cli_app == mock_subcommand_module.invoke_cli_app