✨ feat: Add sign flag to GPG sign and start command (#13)

* ✨ feat: Add `sign` flag to GPG sign

Equivalent to `git commit -S`

* ✨ feat: Add `start` command

Acts as default commit with config-based defaults

* 🏗  build: Bump version to 0.6.0

* 📝 docs: Update Readme to document `start`

* ✨ feat: Improve start args feedback

Author: vict0rsch

README.md

@@ -35,6 +35,7 @@ Use your own emojis by editing the "custom emojis" file listed by `gitmopy info`
 
 ```bash
 alias gpy="gitmopy"
+alias gpys="gitmopy start"
 alias gpyc="gitmopy commit"
 alias gpya="gitmopy commit --add"
 alias gpyk="gitmopy commit --add --keep-alive"
@@ -54,6 +55,9 @@ $ gitmopy commit --add --keep-alive
 # same using an alias, + push after every commit (could be dangerous)
 $ gpyk --push
 
+# use your default commit settings (configured via `gitmopy config`)
+$ gitmopy start
+
 
 # Specific usage
 # --------------
@@ -98,32 +102,51 @@ $ gitmopy commit --help
 $ gitmopy info
 
 gitmopy info:
-  version      : 0.4.2
+  version      : 0.6.0
   app path     : /Users/victor/.gitmopy
   history      : /Users/victor/.gitmopy/history.json
   config       : /Users/victor/.gitmopy/config.yaml
   custom emojis: /Users/victor/.gitmopy/custom_gitmojis.yaml
 
 Current configuration:
-  skip_scope      : False
-  skip_message    : False
-  capitalize_title: True
-  enable_history  : True
-  emoji_set       : gitmoji
+  skip_scope          : False
+  skip_message        : False
+  capitalize_title    : True
+  enable_history      : True
+  emoji_set           : gitmoji
+  default_commit_flags: ['add', 'keep_alive', 'sign', 'simple']
+  default_commit_args : {'remote': 'origin', 'repo': '.'}
 ```
 
 Update configuration with
 
 ```text
 $ gitmopy config
-$ gitmopy config
+
 ❓ Configure gitmopy locally. Use 'space' to (de-)select, 'enter' to validate.
 ❯ ○ Skip commit scope
   ○ Skip commit message
   ◉ Capitalize commit title
   ◉ Remember commit history for auto-complete and emoji sorting
 
 Config will be saved in /Users/victor/.gitmopy/config.yaml.
+
+✓ Configure gitmopy locally.
+❓ Emoji set to use for commits
+❯ gitmoji
+  ai-devmojis
+
+❓ Default commit binary flags used in `gitmopy start`
+❯ ◉ add
+  ○ dry
+  ◉ keep_alive
+  ○ push
+  ◉ sign
+  ◉ simple
+
+❓ repo (Path to the git repository): .
+
+❓ remote (Comma-separated list of remotes to push to): origin
 ```
 
 Get help with
@@ -133,18 +156,22 @@ $ gitmopy --help
 
  Usage: gitmopy [OPTIONS] COMMAND [ARGS]...
 
-╭─ Options ───────────────────────────────────────────────────────────────────────────╮
-│ --install-completion          Install completion for the current shell.             │
-│ --show-completion             Show completion for the current shell, to copy it or  │
-│                               customize the installation.                           │
-│ --help                        Show this message and exit.                           │
-╰─────────────────────────────────────────────────────────────────────────────────────╯
-╭─ Commands ──────────────────────────────────────────────────────────────────────────╮
-│ commit  Commit staged files. Use --add to interactively select files to stage if    │
-│         none is already staged                                                      │
-│ config  Configure gitmopy                                                           │
-│ info    Print gitmopy info                                                          │
-╰─────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────╮
+│ --install-completion          Install completion for the current shell.         │
+│ --show-completion             Show completion for the current shell, to copy it │
+│                               or customize the installation.                    │
+│ --help                        Show this message and exit.                       │
+╰─────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ──────────────────────────────────────────────────────────────────────╮
+│ commit   Commit staged files. Use --add to interactively select files to stage  │
+│          if none is already staged                                              │
+│ config   Configure gitmopy                                                      │
+│ info     Print gitmopy info                                                     │
+│ start    Runs the commit command with the default arguments you have set in the │
+│          configuration file. If no such arguments are set, you will be prompted │
+│          to set them interactively.                                             │
+╰─────────────────────────────────────────────────────────────────────────────────╯
+
 
 $ gitmopy commit --help
 
@@ -153,30 +180,66 @@ $ gitmopy commit --help
  Commit staged files. Use --add to interactively select files to stage if none is
  already staged
 
-╭─ Options ───────────────────────────────────────────────────────────────────────────╮
-│ --repo                             TEXT  Path to the git repository [default: .]    │
-│ --add           --no-add                 Whether or not to interactively select     │
-│                                          files to stage if none is already staged   │
-│                                          [default: no-add]                          │
-│ --push          --no-push                Whether to `git push` after commit. If     │
-│                                          multiple remotes exist, you will be asked  │
-│                                          to interactively choose the ones to push   │
-│                                          to. Use --remote to skip interactive       │
-│                                          selection. Disabled by default.            │
-│                                          [default: no-push]                         │
-│ --dry           --no-dry                 Whether or not to actually commit.         │
-│                                          [default: no-dry]                          │
-│ --remote                           TEXT  Remote to push to after commit. Use to     │
-│                                          skip interactive remote selection when     │
-│                                          several exist. Use several '--remote       │
-│                                          {remote name}' to push to multiple remotes │
-│ --keep-alive    --no-keep-alive          Whether or not to keep the app alive after │
-│                                          commit, to be ready for another one.       │
-│                                          [default: no-keep-alive]                   │
-│ --help                                   Show this message and exit.                │
-╰─────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────╮
+│ --repo                             TEXT  Path to the git repository             │
+│                                          [default: .]                           │
+│ --add           --no-add                 Whether or not to interactively select │
+│                                          files to stage if none is already      │
+│                                          staged                                 │
+│                                          [default: no-add]                      │
+│ --push          --no-push                Whether to `git push` after commit. If │
+│                                          multiple remotes exist, you will be    │
+│                                          asked to interactively choose the ones │
+│                                          to push to. Use --remote to skip       │
+│                                          interactive selection. Disabled by     │
+│                                          default.                               │
+│                                          [default: no-push]                     │
+│ --dry           --no-dry                 Whether or not to actually commit.     │
+│                                          [default: no-dry]                      │
+│ --remote                           TEXT  Remote to push to after commit. Use to │
+│                                          skip interactive remote selection when │
+│                                          several exist. Use several '--remote   │
+│                                          {remote name}' to push to multiple     │
+│                                          remotes                                │
+│ --keep-alive    --no-keep-alive          Whether or not to keep the app alive   │
+│                                          after commit, to be ready for another  │
+│                                          one.                                   │
+│                                          [default: no-keep-alive]               │
+│ --simple        --no-simple              Whether or not to use a simple commit  │
+│                                          which merges conventional commits and  │
+│                                          gitmoji.                               │
+│                                          [default: no-simple]                   │
+│ --sign          --no-sign                Whether or not to sign the commit with │
+│                                          GPG. Equivalent to `git commit -S`.    │
+│                                          [default: no-sign]                     │
+│ --help                                   Show this message and exit.            │
+╰─────────────────────────────────────────────────────────────────────────────────╯
 ```
 
+## Default commit settings
+
+You can configure default settings for the `gitmopy start` command which will run `gitmopy commit` with your preferred arguments. To set these up:
+
+1. Run `gitmopy config`
+2. Navigate to "Default commit binary flags used in `gitmopy start`"
+3. Select the flags you want enabled by default (e.g., `add`, `keep-alive`, `push`, etc.)
+4. Navigate to "Default commit arguments used in `gitmopy start`"
+5. Configure:
+    - `repo`: Path to your git repository (default: ".")
+    - `remote`: Comma-separated list of remotes to push to (default: "origin")
+
+Then simply run `gitmopy start` to use your default settings!
+
+For example, if you always want to:
+
+-   Work in the current directory
+-   Be able to select files to stage
+-   Keep committing until you're done
+-   Sign your commits
+-   Push to origin
+
+Configure these settings once with `gitmopy config` and just run `gitmopy start` instead of `gitmopy commit --add --keep-alive --push --remote origin --sign`!
+
 ## To Do
 
 -   Features

gitmopy/cli.py

@@ -40,6 +40,7 @@
     print,
     print_staged_files,
     resolve_path,
+    set_start_options,
     terminal_separator,
 )
 
@@ -310,6 +311,12 @@ def commit(
             help="Whether or not to use a simple commit which merges conventional commits and gitmoji."
         ),
     ] = False,
+    sign: Annotated[
+        bool,
+        typer.Option(
+            help="Whether or not to sign the commit with GPG. Equivalent to `git commit -S`."
+        ),
+    ] = False,
 ):
     """
     Main command: commit staged files, and staging files if need be.
@@ -433,7 +440,10 @@ def commit(
             save_to_history(commit_dict)
 
         # commit
-        repo.index.commit(commit_message)
+        if sign:
+            repo.git.commit("-S", "-m", commit_message)
+        else:
+            repo.index.commit(commit_message)
 
         if push:
             push_cli(repo, remote)
@@ -454,6 +464,7 @@ def config():
     """
     Command to setup gitmopy's configuration.
     """
+    set_start_options()
     config_prompt()
 
 
@@ -481,5 +492,43 @@ def info():
     print()
 
 
+@app.command()
+def start():
+    """
+    Runs the commit command with the default arguments you have set in the
+    configuration file. If no such arguments are set, you will be prompted to
+    set them interactively.
+    """
+    conf = load_config()
+    if "default_commit_args" not in conf:
+        config()
+        conf = load_config()
+    commit_args = {
+        "repo": conf["default_commit_args"]["repo"],
+        "remote": list(
+            map(str.strip, conf["default_commit_args"]["remote"].split(","))
+        ),
+    }
+    for flag in conf["default_commit_flags"]:
+        commit_args[flag] = True
+    if not commit_args.get("push"):
+        commit_args.pop("remote", None)
+    cmd = "  $ gitmopy commit"
+    for flag, v in commit_args.items():
+        if isinstance(v, bool):
+            if v:
+                cmd += f" --{flag}"
+        elif isinstance(v, list):
+            for value in v:
+                cmd += f" --{flag} {value}"
+        else:
+            cmd += f" --{flag} {v}"
+    print(f"{col('Running:', 'b', True)} {cmd.strip()}")
+    print()
+    print(terminal_separator())
+    print()
+    commit(**commit_args)
+
+
 if __name__ == "__main__":
     app()

gitmopy/constants.py

@@ -79,11 +79,27 @@
         "default": "gitmoji",
         "options": ["gitmoji", "ai-devmojis"],
     },
+    {
+        "value": "default_commit_flags",
+        "name": "Default commit binary flags used in `gitmopy start`",
+        "default": [],
+        "options": [],  # must be set programmatically by `set_start_options`
+    },
+    {
+        "value": "default_commit_args",
+        "name": "Default commit arguments used in `gitmopy start`",
+        "default": {"repo": ".", "remote": "origin"},
+        "options": {
+            "repo": "Path to the git repository",
+            "remote": "Comma-separated list of remotes to push to",
+        },
+    },
 ]
 """
 Choices for the setup prompt.
 """
 
+
 DEFAULT_CONFIG = {c["value"]: c["default"] for c in DEFAULT_CHOICES}
 """
 Default gitmopy configuration.

gitmopy/prompt.py

@@ -257,6 +257,36 @@ def config_prompt() -> None:
         ).execute()
         options[ldict["value"]] = option
 
+    multiple_choices = [
+        c
+        for c in gpyc.DEFAULT_CHOICES
+        if isinstance(c["default"], list) and "options" in c
+    ]
+
+    for c in multiple_choices:
+        option = inquirer.checkbox(
+            message=c["name"],
+            choices=c["options"],
+            default=c["default"],
+            qmark="❓",
+            amark="✓",
+        ).execute()
+        options[c["value"]] = option
+
+    string_inputs = [c for c in gpyc.DEFAULT_CHOICES if isinstance(c["default"], dict)]
+
+    for c in string_inputs:
+        for k, v in c["options"].items():
+            option = inquirer.text(
+                message=f"{k} ({v}):",
+                qmark="❓",
+                amark="✓",
+                default=c["default"][k],
+            ).execute()
+            if c["value"] not in options:
+                options[c["value"]] = {}
+            options[c["value"]][k] = option
+
     for c in choices:
         config[c.value] = c.value in selected
     config.update(options)

gitmopy/utils.py

@@ -13,7 +13,13 @@
 from rich.console import Console
 from yaml import safe_dump, safe_load
 
-from gitmopy.constants import APP_PATH, COLORS, DEFAULT_CONFIG, USER_EMOJIS_PATH
+from gitmopy.constants import (
+    APP_PATH,
+    COLORS,
+    DEFAULT_CHOICES,
+    DEFAULT_CONFIG,
+    USER_EMOJIS_PATH,
+)
 
 console = Console()
 print = console.print
@@ -309,3 +315,23 @@ def standard_width_emoji(emoji: str, to=2) -> str:
     if len(emoji) > 1:
         emoji = emoji[0]
     return emoji + " " * (to - wcwidth.wcwidth(emoji))
+
+
+def set_start_options():
+    """
+    Set the options for the default commit arguments automatically from the ``gitmopy commit`` command's signature.
+    """
+    global DEFAULT_CHOICES
+    import inspect
+
+    from gitmopy.cli import commit
+
+    start_idx = next(
+        i for i, c in enumerate(DEFAULT_CHOICES) if c["value"] == "default_commit_flags"
+    )
+
+    DEFAULT_CHOICES[start_idx]["options"] = sorted(
+        arg
+        for arg in inspect.signature(commit).parameters.keys()
+        if arg not in {"repo", "remote"}
+    )

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitmopy"
-version = "0.5.0"
+version = "0.6.0"
 description = "A python command-line for gitmoji"
 authors = [{ name = "vict0rsch", email = "[email protected]" }]
 license = { text = "MIT" }