chore(args): update arg parsing to clap v3 (#49)

* Update arg parsing to clap v3 * Refactor code * Add help heading for flag arguments * Reformat code * chore(args): update help message of arguments * chore(args): enable wrap_help feature of clap * docs(readme): update command line arguments * Add expect message for parsing sort_commits Co-authored-by: Orhun Parmaksız <[email protected]>
orhun · Jan 31, 2022 · d961b53 · d961b53
1 parent 848d8a5
commit d961b53
Show file tree

Hide file tree

Showing 7 changed files with 161 additions and 156 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -131,7 +131,7 @@ CARGO_TARGET_DIR=target cargo build --release
 ### Command Line Arguments
 
 ```
-git-cliff [FLAGS] [OPTIONS] [RANGE]
+git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
 ```
 
 **Flags:**
@@ -150,18 +150,18 @@ git-cliff [FLAGS] [OPTIONS] [RANGE]
 **Options:**
 
 ```
--c, --config <PATH>               Sets the configuration file [env: CONFIG=]  [default: cliff.toml]
--w, --workdir <PATH>              Sets the working directory [env: WORKDIR=]
--r, --repository <PATH>           Sets the git repository [env: REPOSITORY=]
-    --include-path <PATTERN>...   Sets the path to include related commits [env: INCLUDE_PATH=]
-    --exclude-path <PATTERN>...   Sets the path to exclude related commits [env: EXCLUDE_PATH=]
-    --with-commit <MSG>...        Sets custom commit messages to include in the changelog [env: WITH_COMMIT=]
--p, --prepend <PATH>              Prepends entries to the given changelog file [env: PREPEND=
--o, --output <PATH>               Writes output to the given file [env: OUTPUT=]
--t, --tag <TAG>                   Sets the tag for the latest version [env: TAG=]
--b, --body <TEMPLATE>             Sets the template for the changelog body [env: TEMPLATE=]
--s, --strip <PART>                Strips the given parts from the changelog [possible values: header, footer, all]
-    --sort <sort>                 Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest]
+-c, --config <PATH>                Sets the configuration file [env: CONFIG=] [default: cliff.toml]
+-w, --workdir <PATH>               Sets the working directory [env: WORKDIR=]
+-r, --repository <PATH>            Sets the git repository [env: REPOSITORY=]
+    --include-path <PATTERN>...    Sets the path to include related commits [env: INCLUDE_PATH=]
+    --exclude-path <PATTERN>...    Sets the path to exclude related commits [env: EXCLUDE_PATH=]
+    --with-commit <MSG>...         Sets custom commit messages to include in the changelog [env: WITH_COMMIT=]
+-p, --prepend <PATH>               Prepends entries to the given changelog file [env: PREPEND=]
+-o, --output <PATH>                Writes output to the given file [env: OUTPUT=]
+-t, --tag <TAG>                    Sets the tag for the latest version [env: TAG=]
+-b, --body <TEMPLATE>              Sets the template for the changelog body [env: TEMPLATE=]
+-s, --strip <PART>                 Strips the given parts from the changelog [possible values: header, footer, all]
+    --sort <SORT>                  Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest]
 ```
 
 **Args:**

diff --git a/git-cliff/Cargo.toml b/git-cliff/Cargo.toml
@@ -20,15 +20,15 @@ path = "src/bin/completions.rs"
 pretty_env_logger = "0.4.0"
 log = "0.4.14"
 dirs-next = "2.0.0"
+clap_complete = "3.0"
 
 [dependencies.git-cliff-core]
 version = "0.5.0" # managed by release.sh
 path = "../git-cliff-core"
 
-[dependencies.structopt]
-version = "0.3.25"
-default-features = false
-features = ["suggestions", "color", "wrap_help"]
+[dependencies.clap]
+version = "3.0"
+features = ["derive", "env", "wrap_help"]
 
 [dev-dependencies]
 pretty_assertions = "1.0.0"