feat: show version info #13

Author: aj3sh

src/commitlint/cli.py

@@ -17,12 +17,37 @@
 import sys
 from typing import List
 
+import pkg_resources  # type: ignore
+
 from .commitlint import check_commit_message, remove_comments
 from .exceptions import CommitlintException
 from .git_helpers import get_commit_message_of_hash, get_commit_messages_of_hash_range
 from .messages import VALIDATION_SUCCESSFUL
 
 
+def get_version_info(package_name: str) -> str:
+    """
+    Returns the version information for the specified package.
+
+    Args:
+        package_name (str): The name of the package to retrieve version
+            information for.
+
+    Returns:
+        str: A string containing the version information if available,
+            or a message indicating that the version information is not available.
+
+    Example:
+        >>> get_version_info('commitlint')
+        commitlint 0.2.1
+    """
+    try:
+        version = pkg_resources.get_distribution(package_name).version
+        return f"{package_name} {version}"
+    except pkg_resources.DistributionNotFound:
+        return "Version information not available"
+
+
 def get_args() -> argparse.Namespace:
     """
     Parse CLI arguments for checking if a commit message.
@@ -37,6 +62,11 @@ def get_args() -> argparse.Namespace:
         description="Check if a commit message follows the conventional commit format."
     )
 
+    # version
+    parser.add_argument(
+        "--version", action="version", version=get_version_info(parser.prog)
+    )
+
     # for commit message check
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(