Add version option

Author: domdfcoding

formate/__main__.py

@@ -33,18 +33,31 @@
 # 3rd party
 import click
 from consolekit import click_command
-from consolekit.options import MultiValueOption, colour_option, flag_option, verbose_option
+from consolekit.options import MultiValueOption, colour_option, flag_option, verbose_option, version_option
 from consolekit.terminal_colours import ColourTrilean, resolve_color_default
 from consolekit.tracebacks import handle_tracebacks, traceback_option
 from domdf_python_tools.typing import PathLike
 
-# this package
-from formate import Reformatter
-from formate.utils import _find_from_parents
+__all__ = ("main", "version_callback")
 
-__all__ = ("main", )
+
+def version_callback(ctx: click.Context, param: click.Option, value: int):
+	# this package
+	import formate
+
+	if not value or ctx.resilient_parsing:
+		return
+
+	if value > 1:
+		python_version = sys.version.replace('\n', ' ')
+		click.echo(f"formate version {formate.__version__}, Python {python_version}")
+	else:
+		click.echo(f"formate version {formate.__version__}")
+
+	ctx.exit()
 
 
+@version_option(version_callback)
 @flag_option("--diff", "show_diff", help="Show a diff of changes made")
 @traceback_option()
 @colour_option()
@@ -91,8 +104,9 @@ def main(
 	from domdf_python_tools.paths import PathPlus
 
 	# this package
+	from formate import Reformatter
 	from formate.config import load_toml
-	from formate.utils import SyntaxTracebackHandler, syntaxerror_for_file
+	from formate.utils import SyntaxTracebackHandler, _find_from_parents, syntaxerror_for_file
 
 	retv = 0
 

tests/test_cli.py

@@ -0,0 +1,36 @@
+# stdlib
+import re
+import sys
+from typing import Optional
+
+# 3rd party
+import pytest
+from coincidence.regressions import AdvancedFileRegressionFixture
+from consolekit.testing import CliRunner
+from domdf_python_tools.words import LF
+
+# this package
+import formate
+from formate.__main__ import main
+
+
+def test_help(advanced_file_regression: AdvancedFileRegressionFixture):
+
+	runner = CliRunner()
+
+	result = runner.invoke(main, catch_exceptions=False, args="--help")
+	assert result.exit_code == 0
+	result.check_stdout(advanced_file_regression)
+
+
+def test_version():
+
+	runner = CliRunner()
+
+	result = runner.invoke(main, catch_exceptions=False, args="--version")
+	assert result.exit_code == 0
+	assert result.stdout == f"formate version {formate.__version__}\n"
+
+	result = runner.invoke(main, catch_exceptions=False, args=["--version", "--version"])
+	assert result.exit_code == 0
+	assert result.stdout == f"formate version {formate.__version__}, Python {sys.version.replace(LF, ' ')}\n"

tests/test_cli_/test_help.txt

@@ -0,0 +1,16 @@
+Usage: main [OPTIONS] [FILENAME]...
+
+  Reformat the given Python source files.
+
+Options:
+  -c, --config-file TEXT  The path or filename of the TOML configuration file to
+                          use. If a filename is given it is searched for in the
+                          current and parent directories.  [default:
+                          formate.toml]
+  -e, --exclude PATTERN   Patterns for files to exclude from formatting.
+  -v, --verbose           Show verbose output.
+  --colour / --no-colour  Whether to use coloured output.
+  -T, --traceback         Show the complete traceback on error.
+  --diff                  Show a diff of changes made
+  --version               Show the version and exit.
+  -h, --help              Show this message and exit.