Merge pull request #23 from aj3sh/version-info

feat: show version info

Author: subashcs

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commitlint
-version = 0.2.1
+version = attr: commitlint.__version__.__version__
 license = MIT
 author = opensource-nepal
 author_email = [email protected], [email protected]

src/commitlint/__init__.py

@@ -1,4 +1,5 @@
 """Main module for commitlint"""
+
 from .commitlint import check_commit_message
 
 __all__ = ["check_commit_message"]

src/commitlint/__version__.py

@@ -0,0 +1,6 @@
+"""
+This module contains the version information of the current commitlint.
+TODO: automatically bump version through CI.
+"""
+
+__version__ = "0.2.1"

src/commitlint/cli.py

@@ -12,11 +12,13 @@
         commitlint --file path/to/your/file.txt
 
 """
+
 import argparse
 import os
 import sys
 from typing import List
 
+from .__version__ import __version__
 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
@@ -37,6 +39,11 @@ def get_args() -> argparse.Namespace:
         description="Check if a commit message follows the conventional commit format."
     )
 
+    # version
+    parser.add_argument(
+        "-V", "--version", action="version", version=f"%(prog)s {__version__}"
+    )
+
     # for commit message check
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(