style(args): group remote-related CLI arguments under REMOTE OPTIONS heading (#1271)

* feat: group remote-related CLI arguments under REMOTE OPTIONS heading

* fix indentation

* feat: add remote options section to command-line arguments documentation

* feat: change order of remote options

Author: ritoban23

git-cliff/src/args.rs

@@ -253,12 +253,10 @@ pub struct Opt {
 		default_value_t = Sort::Oldest
 	)]
     pub sort: Sort,
-    /// Sets the commit range to process.
-    #[arg(value_name = "RANGE", help_heading = Some("ARGS"))]
-    pub range: Option<String>,
     /// Sets the GitHub API token.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITHUB_TOKEN",
 		value_name = "TOKEN",
 		hide_env_values = true,
@@ -268,6 +266,7 @@ pub struct Opt {
     /// Sets the GitHub repository.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITHUB_REPO",
 		value_parser = clap::value_parser!(RemoteValue),
 		value_name = "OWNER/REPO",
@@ -277,6 +276,7 @@ pub struct Opt {
     /// Sets the GitLab API token.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITLAB_TOKEN",
 		value_name = "TOKEN",
 		hide_env_values = true,
@@ -286,6 +286,7 @@ pub struct Opt {
     /// Sets the GitLab repository.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITLAB_REPO",
 		value_parser = clap::value_parser!(RemoteValue),
 		value_name = "OWNER/REPO",
@@ -295,6 +296,7 @@ pub struct Opt {
     /// Sets the Gitea API token.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITEA_TOKEN",
 		value_name = "TOKEN",
 		hide_env_values = true,
@@ -304,6 +306,7 @@ pub struct Opt {
     /// Sets the Gitea repository.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "GITEA_REPO",
 		value_parser = clap::value_parser!(RemoteValue),
 		value_name = "OWNER/REPO",
@@ -313,6 +316,7 @@ pub struct Opt {
     /// Sets the Bitbucket API token.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "BITBUCKET_TOKEN",
 		value_name = "TOKEN",
 		hide_env_values = true,
@@ -322,12 +326,16 @@ pub struct Opt {
     /// Sets the Bitbucket repository.
     #[arg(
 		long,
+		help_heading = "REMOTE OPTIONS",
 		env = "BITBUCKET_REPO",
 		value_parser = clap::value_parser!(RemoteValue),
 		value_name = "OWNER/REPO",
 		hide = !cfg!(feature = "bitbucket"),
 	)]
     pub bitbucket_repo: Option<RemoteValue>,
+    /// Sets the commit range to process.
+    #[arg(value_name = "RANGE", help_heading = Some("ARGS"))]
+    pub range: Option<String>,
     /// Load TLS certificates from the native certificate store.
     #[arg(long, help_heading = Some("FLAGS"), hide = !cfg!(feature = "remote"))]
     pub use_native_tls: bool,

website/docs/usage/args.md

@@ -49,6 +49,11 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
     --from-context <PATH>          Generates changelog from a JSON context [env: GIT_CLIFF_CONTEXT=]
 -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]
+```
+
+## Remote Options
+
+```
     --github-token <TOKEN>         Sets the GitHub API token [env: GITHUB_TOKEN]
     --github-repo <OWNER/REPO>     Sets the GitHub repository [env: GITHUB_REPO=]
     --gitlab-token <TOKEN>         Sets the GitLab API token [env: GITLAB_TOKEN]