refactor: Code Review - round 1 changes

Author: SCrocky

commitizen/cli.py

@@ -465,6 +465,11 @@ def main():
             raise InvalidCommandArgumentError(
                 f"Invalid commitizen arguments were found before -- separator: `{' '.join(unknown_args[:pos])}`. "
             )
+        # Log warning for -- without any extra args
+        elif len(unknown_args) == 1:
+            logger.warning(
+                "Incomplete commit command: received -- separator without any following git arguments"
+            )
         extra_args = " ".join(unknown_args[1:])
         arguments["extra_cli_args"] = extra_args
 

commitizen/commands/commit.py

@@ -99,12 +99,11 @@ def __call__(self):
 
         if signoff:
             out.warn("signoff mechanic is deprecated, please use `cz commit -- -s` instead.")
-            c = git.commit(m, "-s")
-
-        if self.arguments.get("extra_cli_args"):
-            c = git.commit(m, extra_args=self.arguments.get("extra_cli_args"))
+            extra_args = "-s " + self.arguments.get("extra_cli_args")
         else:
-            c = git.commit(m)
+            extra_args = self.arguments.get("extra_cli_args")
+
+        c = git.commit(m, extra_args=extra_args)
 
         if c.return_code != 0:
             out.error(c.err)

docs/commit.md

@@ -19,8 +19,10 @@ case for this is to [automatically prepare a commit message](./tutorials/auto_pr
 
 `git` command options that are not implemented by commitizen can be use via the `--` syntax for the `commit` command.
 The syntax separates commitizen arguments from `git commit` arguments by a double dash. This is the resulting syntax:
-```
-cz commit -commitizen-args -- -git-cli-args
+```sh
+cz commit <commitizen-args> -- <git-cli-args>
+
+# e.g., cz commit --dry-run -- -a -S
 ```
 For example, using the `-S` option on `git commit` to sign a commit is now commitizen compatible: `cz c -- -S`
 

tests/test_cli.py

@@ -167,3 +167,4 @@ def test_unknown_args_before_double_dash_raises(mocker: MockFixture):
     with pytest.raises(InvalidCommandArgumentError) as excinfo:
         cli.main()
     assert "Invalid commitizen arguments were found before -- separator" in str(excinfo.value)
+

tests/test_command_commit.py

@@ -0,0 +1,22 @@
+import sys
+
+from unittest.mock import patch
+from pytest_mock import MockFixture
+
+from commitizen import cli
+from commitizen.commands.commit import Commit
+
+
+def test_extra_args_no_raise(mocker: MockFixture):
+    testargs = ["cz", "c", "--dry-run", "--", "-extra-args1", "-extra-arg2"]
+    extra_cli_args = "-extra-args1 -extra-args2"
+    mocker.patch.object(sys, "argv", testargs)
+    commit_call = mocker.patch.object(Commit, "__call__")
+
+    def assert_extra_args(self):
+        assert self.arguments["extra_cli_args"] == extra_cli_args
+
+    with patch.object(Commit, "test_extra_args", assert_extra_args, autospec=True) as mock:
+        commit_call.side_effect = Commit.test_extra_args
+        cli.main()
+        Commit.__call__.assert_called_once()