Updates the check command with an optional --file flag and provides updates. (#67)

Author: award28

CHANGELOG.md

@@ -14,6 +14,13 @@ The [Changelogger tool](https://pypi.org/project/changelogged) is used for autom
 <!-- BEGIN RELEASE NOTES -->
 ### [Unreleased]
 
+### [0.10.0] - 2023-03-05
+
+#### Added
+- Alias commands `up` and `ch` for `upgrade` and `check`, respectively.
+- Add the `--file` option to the check command, allowing users to specify which files to check.
+- Added progress feedback as versioned files are checked.
+
 ### [0.9.1] - 2023-03-05
 
 #### Changed
@@ -115,7 +122,8 @@ The [Changelogger tool](https://pypi.org/project/changelogged) is used for autom
 - `unreleased add`, which allows inline or prompted adding of unreleased changes.
 <!-- END RELEASE NOTES -->
 <!-- BEGIN LINKS -->
-[Unreleased]: https://github.com/award28/changelogger/compare/0.9.1...HEAD
+[Unreleased]: https://github.com/award28/changelogger/compare/0.10.0...HEAD
+[0.10.0]: https://github.com/award28/changelogger/compare/0.9.1...0.10.0
 [0.9.1]: https://github.com/award28/changelogger/compare/0.9.0...0.9.1
 [0.9.0]: https://github.com/award28/changelogger/compare/0.8.0...0.9.0
 [0.8.0]: https://github.com/award28/changelogger/compare/0.7.0...0.8.0

changelogger/app/__init__.py

@@ -1,4 +1,6 @@
+from functools import partial, wraps
 from pathlib import Path
+from typing import Callable
 
 import typer
 from git.exc import InvalidGitRepositoryError
@@ -13,13 +15,39 @@
 from changelogger.app.commands.versions import versions
 from changelogger.conf import settings
 
-app = typer.Typer()
-app.command()(add)
-app.command()(check)
-app.command()(init)
-app.command()(notes)
-app.command()(upgrade)
-app.command()(versions)
+
+class App(typer.Typer):
+    def add_command(
+        self,
+        cmd: Callable,
+        alias: str | None = None,
+    ) -> None:
+        """Adds the provided callable as command on this App instance.
+        If an alias is provided, the command can be invoked with that
+        name as well.
+        """
+        self.command()(cmd)
+
+        if not alias:
+            return
+
+        alias_cmd = wraps(cmd)(partial(cmd))
+        alias_cmd.__doc__ = (
+            f"Alias for the `{cmd.__name__}` command. {cmd.__doc__}"
+        )
+
+        # Alias commands
+        self.command(alias, rich_help_panel="Aliases")(alias_cmd)
+
+
+app = App()
+
+app.add_command(add)
+app.add_command(check, "ch")
+app.add_command(init)
+app.add_command(notes)
+app.add_command(upgrade, "up")
+app.add_command(versions)
 
 
 def version_callback(value: bool):

changelogger/app/commands/check.py

@@ -1,8 +1,11 @@
+from collections import Counter
+from typing import Callable
+
 import typer
 from rich import print
+from rich.progress import Progress
 
 from changelogger import changelog, templating
-from changelogger.app.commands.notes import _unreleased_notes
 from changelogger.conf import settings
 from changelogger.conf.models import VersionedFile
 from changelogger.exceptions import ValidationException
@@ -17,24 +20,97 @@ def check(
         "--fail",
         help="Exit with a status of 2 if any versioned files are invalid.",
     ),
+    files: list[str] = typer.Option(
+        [],
+        "--file",
+        help="Only check the specified file(s).",
+    ),
 ) -> None:
     """Checks the versioned files for any unparsable sections which do not match
     the Changelogger configuration and reports them.
     """
+    versioned_files = (
+        settings.VERSIONED_FILES
+        if not (files_set := set(files))
+        else [
+            file
+            for file in settings.VERSIONED_FILES
+            if str(file.rel_path) in files_set
+        ]
+    )
     try:
-        _check_changelog()
-        _check_versioned_files()
+        _check_versioned_files(versioned_files)
     except ValidationException as e:
         print(f"[bold red]Error:[/bold red] {str(e)}")
         if sys_exit:
             raise typer.Exit(code=2)
     else:
         print(
-            ":white_heavy_check_mark: [bold green]All versioned files are valid![/bold green]"
+            ":white_heavy_check_mark: [bold green]Versioned files are valid![/bold green]"
         )
 
 
-def _check_changelog() -> None:
+def _check_versioned_files(versioned_files: list[VersionedFile]) -> None:
+    """For each of the user-specified and default versioned files, check
+    that a search for the pattern over the files content results in a find.
+    """
+
+    # Contrive a fake update so we can check if the pattern would have been
+    # found.
+    old_version = changelog.get_latest_version()
+    update = ChangelogUpdate(
+        new_version=old_version.bump_minor(),
+        old_version=old_version,
+        release_notes=changelog.get_release_notes("Unreleased", old_version),
+    )
+
+    counts = Counter(file.rel_path for file in versioned_files)
+    with Progress() as progress:
+        if settings.CHANGELOG_PATH in counts:
+            counts[settings.CHANGELOG_PATH] += 6
+
+        tasks = {
+            path: progress.add_task(
+                f'Checking [green]"{path}"[/green]',
+                total=total,
+            )
+            for path, total in counts.items()
+        }
+
+        for file in versioned_files:
+            _check_versioned_file(file, update)
+            progress.advance(tasks[file.rel_path])
+
+        if any(
+            file.rel_path == settings.CHANGELOG_PATH
+            for file in versioned_files
+        ):
+            advancer = lambda: progress.advance(
+                tasks[settings.CHANGELOG_PATH],
+            )
+            _check_changelog(advancer)
+
+
+def _check_versioned_file(
+    file: VersionedFile, update: ChangelogUpdate
+) -> None:
+    """Renders the versioned files pattern with an update and confirms
+    there's a match.
+    """
+
+    pattern = templating.render_pattern(file, update)
+    content = file.rel_path.read_text()
+    if cached_compile(pattern).search(content):
+        return
+
+    raise ValidationException(
+        f"Could not find the pattern `[bright_blue]{file.pattern}[/bright_blue]` "
+        f'in "{file.rel_path}".\n\n'
+        f"Rendered pattern used when searching: `[bright_blue]{pattern}[/bright_blue]`."
+    )
+
+
+def _check_changelog(advance: Callable) -> None:
     """Validates the specified versioned files are parsable and updatable."""
     # Validate there's at least 1 version
     # Point of Failure 0
@@ -43,6 +119,7 @@ def _check_changelog() -> None:
         raise ValidationException(
             "Expected there to be at least 1 version; None found."
         )
+    advance()
 
     # Validate all release notes are parseable for all versions
     # Point of Failure 1
@@ -56,6 +133,7 @@ def _check_changelog() -> None:
             raise ValidationException(
                 f"Failed to validate notes for version {new_version}: {str(e)}."
             )
+    advance()
 
     # Validate there are links in the expected format for all versions
     # Point of Failure 2
@@ -73,59 +151,26 @@ def _check_changelog() -> None:
             raise ValidationException(
                 f"Link is incorrect for version {version}"
             )
+    advance()
 
     link = all_links.get("Unreleased")
     # Point of Failure 4
     if not link:
         raise ValidationException(
             "Could not find the link for unreleased changes."
         )
+    advance()
 
     # Point of Failure 5
     if f"{all_versions[0]}...HEAD" not in link:
         raise ValidationException(
             "Link is incorrect for the unreleased changes."
         )
+    advance()
 
     # Point of Failure 6
     if sorted_versions[0] not in all_links:
         raise ValidationException(
             f"Could not find the link for version {sorted_versions[0]}"
         )
-
-
-def _check_versioned_files() -> None:
-    """For each of the user-specified and default versioned files, check
-    that a search for the pattern over the files content results in a find.
-    """
-
-    # Contrive a fake update so we can check if the pattern would have been
-    # found.
-    old_version = changelog.get_latest_version()
-    update = ChangelogUpdate(
-        new_version=old_version.bump_minor(),
-        old_version=old_version,
-        release_notes=_unreleased_notes(),
-    )
-
-    for version_file in settings.VERSIONED_FILES:
-        _check_versioned_file(version_file, update)
-
-
-def _check_versioned_file(
-    file: VersionedFile, update: ChangelogUpdate
-) -> None:
-    """Renders the versioned files pattern with an update and confirms
-    there's a match.
-    """
-
-    pattern = templating.render_pattern(file, update)
-    content = file.rel_path.read_text()
-    if cached_compile(pattern).search(content):
-        return
-
-    raise ValidationException(
-        f"Could not find the pattern `[bright_blue]{file.pattern}[/bright_blue]` "
-        f'in the versioned file "{file.rel_path}".\n\n'
-        f"Rendered pattern used when searching: [bright_blue]{pattern}[/bright_blue]."
-    )
+    advance()

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "changelogged"
-version = "0.9.1"
+version = "0.10.0"
 description = "Automated management of your changelog and other versioned files, following the principles of Keep a Changelog and Semantic Versioning."
 license = "MIT"
 authors = ["award28 <austin.ward@klaviyo.com>"]