ts-backend-check 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

ts_backend_check/checker.py

@@ -29,7 +29,7 @@ class TypeChecker:
         self.model_fields = extract_model_fields(models_file)
         self.ts_parser = TypeScriptParser(types_file)
         self.ts_interfaces = self.ts_parser.parse_interfaces()
-        self.backend_only = self.ts_parser.get_backend_only_fields()
+        self.backend_only = self.ts_parser.get_ignored_fields()
 
     def check(self) -> List[str]:
         """
@@ -149,8 +149,8 @@ class TypeChecker:
         """
         potential_names = TypeChecker._generate_potential_names(model_name)
         return (
-            f"\nNo matching TypeScript interface found for model: {model_name}\n"
-            f"Searched for interfaces: {', '.join(potential_names)}"
+            f"\nNo matching TypeScript interface found for model: {model_name}"
+            f"\nSearched for interfaces: {', '.join(potential_names)}"
         )
 
     @staticmethod
@@ -177,9 +177,12 @@ class TypeChecker:
             The message displayed to the user when missing fields are found.
         """
         camel_field = snake_to_camel(input_str=field)
+        interface_of_interfaces = (
+            "interface" if len(interfaces.keys()) == 1 else "interfaces"
+        )
+
         return (
-            f"\nField '{field}' (camelCase: '{camel_field}') from model '{model_name}' "
-            f"is missing in TypeScript types.\n"
-            f"Expected to find in interface(s): {', '.join(interfaces.keys())}\n"
-            f"To ignore this field, add a comment that references it like: '// Note: {camel_field} is backend only'"
+            f"\nField '{field}' (camelCase: '{camel_field}') from model '{model_name}' is missing in the TypeScript interfaces."
+            f"\nExpected to find this field in the frontend {interface_of_interfaces}: {', '.join(interfaces.keys())}"
+            f"\nTo ignore this field, add the following comment to the TypeScript file: '// ts-backend-check: ignore field {camel_field}'"
         )

ts_backend_check/cli/check_blank.py

@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Functionality to check TypeScript interfaces for fields that should be optional based on Django models.
+"""
+
+import ast
+from pathlib import Path
+from typing import Dict, Set
+
+from rich.console import Console
+
+from ts_backend_check.parsers.django_parser import DjangoModelVisitor
+
+ROOT_DIR = Path.cwd()
+console = Console()
+
+
+class BlankParser(DjangoModelVisitor):
+    """
+    AST visitor to extract blank fields from Django models based on DjangoModelVisitor.
+    """
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.blank_models: Dict[str, Set[str]] = {}
+
+    def visit_Assign(self, node: ast.Assign) -> None:
+        """
+        Check assignment statements within a class which accepts blank fields.
+
+        Parameters
+        ----------
+        node : ast.Assign
+            An assignment definition from Python AST (Abstract Syntax Tree).
+            It represents an assignment statement (e.g., x = 42).
+        """
+        if not self.current_model:
+            return
+
+        for target in node.targets:
+            if (
+                (
+                    isinstance(target, ast.Name)
+                    and not target.id.startswith("_")
+                    and isinstance(node.value, ast.Call)
+                    and hasattr(node.value.func, "attr")
+                )
+                and any(
+                    field_type in node.value.func.attr
+                    for field_type in self.DJANGO_FIELD_TYPES
+                )
+                and any(
+                    kw.arg == "blank"
+                    and isinstance(kw.value, ast.Constant)
+                    and kw.value.value is True
+                    for kw in node.value.keywords
+                )
+            ):
+                if self.current_model not in self.blank_models:
+                    self.blank_models[self.current_model] = set()
+
+                self.blank_models[self.current_model].add(target.id)
+
+
+def check_blank(file_path: str) -> Dict[str, Set[str]]:
+    """
+    Function to extract fields from Django models file which accepts blank values.
+
+    Parameters
+    ----------
+    file_path : str
+        A models.py file that defines Django models.
+
+    Returns
+    -------
+    Dict[str, Set[str]]
+        The fields from the models file extracted into a dictionary for future processing.
+    """
+    model_path = ROOT_DIR / file_path
+
+    if model_path.is_file():
+        with open(model_path, "r", encoding="utf-8") as f:
+            content = f.read().strip()
+            # Skip any empty lines at the beginning.
+            while content.startswith("\n"):
+                content = content[1:]
+
+        try:
+            tree = ast.parse(content)
+
+        except SyntaxError as e:
+            raise SyntaxError(
+                f"Failed to parse {model_path}. Make sure it's a valid Python file. Error: {str(e)}"
+            ) from e
+
+        parser = BlankParser()
+        parser.visit(tree)
+
+        if len(parser.blank_models) == 0:
+            console.print("[green]No models have any blank fields specified.[green]")
+
+        else:
+            for k, v in parser.blank_models.items():
+                console.print(
+                    f"[yellow]Model {k} has fields {sorted(v)} set as optional."
+                )
+
+    else:
+        print("Check the path entered.")
+
+    return parser.blank_models

ts_backend_check/cli/config.py

@@ -0,0 +1,164 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Configure cli to run based on a YAML configuration file.
+"""
+
+from pathlib import Path
+
+from yaml import dump
+
+YAML_CONFIG_FILE_PATH = (
+    Path(__file__).parent.parent.parent.parent / ".ts-backend-check.yaml"
+)
+
+PROJECT_ROOT_PATH = Path(__file__).parent.parent.parent.parent
+
+
+def configure_paths() -> None:
+    """
+    Function to receive paths from user.
+    """
+    config_options = {}
+    while True:
+        print("\n--- Adding new model/interface configuration ---")
+
+        key = input(
+            "Enter the model-interface type (eg: 'auth', 'orgs', 'groups'): "
+        ).strip()
+        if not key:
+            print("Key cannot be empty. Please try again.")
+            continue
+
+        # Get backend path.
+        while True:
+            backend_path = input("Enter the path for Django models.py file: ").strip()
+            if not backend_path:
+                print("Path cannot be empty.")
+                continue
+
+            if path_exists(backend_path):
+                break
+
+            print(f"File not found: {PROJECT_ROOT_PATH / backend_path}")
+            print("Please check the path and try again.")
+
+        # Get frontend path.
+        while True:
+            frontend_path = input("Enter path to TypeScript interface file: ").strip()
+            if not frontend_path:
+                print("Path cannot be empty. Please try again.")
+                continue
+
+            if path_exists(frontend_path):
+                break
+
+            print(f"File not found: {PROJECT_ROOT_PATH / frontend_path}")
+            print("Please check the path and try again.")
+
+        config_options[key] = {
+            "backend_model_path": backend_path,
+            "frontend_interface_path": frontend_path,
+        }
+
+        print(f"✓ Added configuration for '{key}'")
+
+        continue_config = input(
+            "Do you wish to add another model/interface configuration? (y/[n])"
+        ).strip()
+
+        if continue_config.lower() in ["n", ""]:
+            if config_options:
+                write_config(config_options)
+                print(
+                    f"\n✓ Configuration complete! Added {len(config_options)} configuration(s)."
+                )
+            break
+
+        if config_options:
+            write_config(config_options)
+            print(
+                f"\n✓ Configuration complete! Added {len(config_options)} configuration(s)."
+            )
+
+        else:
+            print("\nNo configurations added.")
+
+
+def path_exists(path: str) -> bool:
+    """
+    Check if path entered by the user exists withing the filesystem.
+
+    Parameters
+    ----------
+    path : str
+        Path should be entered as a string from the user.
+
+    Returns
+    -------
+    bool
+        Return true or false based on if path exists.
+    """
+    full_path = Path(__file__).parent.parent.parent.parent / path
+    if Path(full_path).is_file():
+        return True
+
+    return False
+
+
+def write_config(config: dict[str, dict[str, str]]) -> None:
+    """
+    Function to write into .ts-backend-check.yaml file.
+
+    Parameters
+    ----------
+    config : dict[str, dict[str, str]]
+        Passing a dictionary as key str with another dict as value.
+    """
+    try:
+        options = f"""# Configuration file for ts-backend-check validation.
+# See https://github.com/activist-org/ts-backend-check for details.
+
+# Paths:
+{dump(config)}
+
+"""
+        with open(YAML_CONFIG_FILE_PATH, "w") as file:
+            file.write(options)
+
+    except IOError as e:
+        print(f"Error while writing config file: {e}")
+
+
+def create_config() -> None:
+    """
+    Main function to create or update configuration.
+    """
+    print("ts-backend-check Configuration Setup")
+    print("=" * 40)
+
+    if YAML_CONFIG_FILE_PATH.is_file():
+        reconfig_choice = input(
+            "Configuration file exists. Do you want to re-configure your .ts-backend-check.yaml file? (y/[n]) "
+        )
+        if reconfig_choice.lower() in ["n", ""]:
+            print("Exiting without changes.")
+            return
+
+        print("Reconfiguring...")
+
+    else:
+        print("Creating new configuration file...")
+
+    try:
+        configure_paths()
+
+    except KeyboardInterrupt:
+        print("\n\nConfiguration cancelled by user.")
+
+    except Exception as e:
+        print(f"\nError during configuration: {e}")
+        print("Configuration cancelled.")
+
+
+if __name__ == "__main__":
+    create_config()

ts_backend_check/cli/main.py

@@ -5,9 +5,19 @@ Setup and commands for the ts-backend-check command line interface.
 
 import argparse
 import sys
+from argparse import ArgumentParser
 from pathlib import Path
 
+from rich import print as rprint
+from rich.text import Text
+
 from ts_backend_check.checker import TypeChecker
+from ts_backend_check.cli.check_blank import check_blank
+from ts_backend_check.cli.config import create_config
+from ts_backend_check.cli.upgrade import upgrade_cli
+from ts_backend_check.cli.version import get_version_message
+
+ROOT_DIR = Path.cwd()
 
 
 def main() -> None:
@@ -26,8 +36,7 @@ def main() -> None:
     """
     # MARK: CLI Base
 
-    ROOT_DIR = Path(__file__).cwd()
-    parser = argparse.ArgumentParser(
+    parser = ArgumentParser(
         prog="ts-backend-check",
         description="Checks the types in TypeScript files against the corresponding backend models.",
         epilog="Visit the codebase at https://github.com/activist-org/ts-backend-check to learn more!",
@@ -36,31 +45,75 @@ def main() -> None:
 
     parser._actions[0].help = "Show this help message and exit."
 
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"{get_version_message()}",
+        help="Show the version of the ts-backend-check CLI.",
+    )
+
+    parser.add_argument(
+        "-u",
+        "--upgrade",
+        action="store_true",
+        help="Upgrade the ts-backend-check CLI to the latest version.",
+    )
+
     parser.add_argument(
         "-bmf",
         "--backend-model-file",
         help="Path to the backend model file (e.g. Python class).",
     )
+
     parser.add_argument(
         "-tsf",
         "--typescript-file",
         help="Path to the TypeScript interface/type file.",
     )
 
+    parser.add_argument(
+        "-c",
+        "--configure",
+        action="store_true",
+        help="Configure a YAML file to simplify your checks.",
+    )
+
+    parser.add_argument(
+        "-cb",
+        "--check-blank",
+        help="Check for fields marked blank=True within Django models.",
+    )
+
     # MARK: Setup CLI
 
-    args = parser.parse_args()
+    args = parser.parse_args(args=None if sys.argv[1:] else ["--help"])
+
+    if args.upgrade:
+        upgrade_cli()
+        return
+
+    if args.configure:
+        create_config()
+        return
+
+    if args.check_blank:
+        check_blank(args.check_blank)
+        return
+
+    # MARK: Run Check
+
     backend_model_file_path = ROOT_DIR / args.backend_model_file
     ts_file_path = ROOT_DIR / args.typescript_file
 
     if not backend_model_file_path.is_file():
-        print(
-            f"{args.backend_model_file} that should contain the backend models does not exist. Please check and try again."
+        rprint(
+            f"[red]{args.backend_model_file} that should contain the backend models does not exist. Please check and try again.[/red]"
         )
 
     elif not ts_file_path.is_file():
-        print(
-            f"{args.typescript_file} file that should contain the TypeScript types does not exist. Please check and try again."
+        rprint(
+            f"[red]{args.typescript_file} file that should contain the TypeScript types does not exist. Please check and try again.[/red]"
         )
 
     else:
@@ -70,16 +123,23 @@ def main() -> None:
         )
 
         if missing := checker.check():
-            print("Missing typescript fields found: ")
-            print("\n".join(missing))
+            rprint(
+                "\n[red]❌ ts-backend-check error: There are inconsistencies between the provided backend models and TypeScript interfaces. Please see the output below for details.[/red]\n"
+            )
+
+            # Print each error message in red.
+            for msg in missing:
+                rprint(Text.from_markup(f"[red]{msg}[/red]"))
 
             field_or_fields = "fields" if len(missing) > 1 else "field"
-            print(
-                f"\nPlease fix the {len(missing)} {field_or_fields} to have the backend models synced with the typescript interfaces."
+            rprint(
+                f"[red]Please fix the {len(missing)} {field_or_fields} above to have the backend models of {args.backend_model_file} synced with the typescript interfaces of {(args.typescript_file)}.[/red]"
             )
             sys.exit(1)
 
-        print("All models are synced with their corresponding TypeScript interfaces.")
+        rprint(
+            "[green]✅ Success: All backend models are synced with their corresponding TypeScript interfaces for the provided files.[/green]"
+        )
 
 
 if __name__ == "__main__":

ts_backend_check/cli/upgrade.py

@@ -0,0 +1,91 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Functions to update the ts-backend-check CLI based on install method.
+"""
+
+import subprocess
+import sys
+
+from packaging import version
+from packaging.version import InvalidVersion
+
+from ts_backend_check.cli.version import (
+    UNKNOWN_VERSION_NOT_FETCHED,
+    get_latest_version,
+    get_local_version,
+)
+
+
+def upgrade_cli() -> None:
+    """
+    Upgrade the CLI tool to the latest available version on PyPI.
+
+    Raises
+    ------
+    subprocess.CalledProcessError
+        If the installation of the latest version fails.
+    """
+    local_version = get_local_version()
+    latest_version_message = get_latest_version()
+
+    if latest_version_message == UNKNOWN_VERSION_NOT_FETCHED:
+        print(
+            "Unable to fetch the latest version from GitHub. Please check the GitHub repository or your internet connection."
+        )
+        return
+
+    latest_version = latest_version_message.split("v")[-1]
+    local_version_clean = local_version.strip()
+    latest_version_clean = latest_version.replace("ts-backend-check", "").strip()
+
+    # Handle empty or invalid version strings.
+    try:
+        local_ver = (
+            version.parse(local_version_clean)
+            if local_version_clean
+            else version.parse("0.0.0")
+        )
+
+    except InvalidVersion:
+        # If local version is invalid, treat it as 0.0.0 to force upgrade.
+        local_ver = version.parse("0.0.0")
+
+    try:
+        latest_ver = version.parse(latest_version_clean)
+
+    except InvalidVersion:
+        print("Unable to parse the latest version. Please check the GitHub repository.")
+        return
+
+    if local_ver == latest_ver:
+        print("You already have the latest version of ts-backend-check.")
+
+    elif local_ver > latest_ver:
+        print(
+            f"ts-backend-check v{local_version_clean} is higher than the currently released version ts-backend-check v{latest_version_clean}. Hopefully this is a development build, and if so, thanks for your work on ts-backend-check! If not, please report this to the team at https://github.com/activist-org/ts-backend-check/issues."
+        )
+
+    else:
+        print(f"Current version: {local_version}")
+        print(f"Latest version: {latest_version}")
+        print("Updating ts-backend-check with pip...")
+        try:
+            subprocess.check_call(
+                [
+                    sys.executable,
+                    "-m",
+                    "pip",
+                    "install",
+                    "--upgrade",
+                    "ts-backend-check",
+                ]
+            )
+
+        except subprocess.CalledProcessError as e:
+            print(
+                f"Failed to install the latest version of ts-backend-check with error {e}. Please check the error message and report any issues to the team at https://github.com/activist-org/ts-backend-check/issues."
+            )
+
+
+if __name__ == "__main__":
+    upgrade_cli()

ts_backend_check/cli/version.py

@@ -0,0 +1,87 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Functions for checking current version of the ts-backend-check CLI.
+"""
+
+import importlib.metadata
+from typing import Any, Dict
+
+import requests
+
+UNKNOWN_VERSION = "Unknown ts-backend-check version"
+UNKNOWN_VERSION_NOT_PIP = f"{UNKNOWN_VERSION} (Not installed via pip)"
+UNKNOWN_VERSION_NOT_FETCHED = f"{UNKNOWN_VERSION} (Unable to fetch version)"
+
+
+def get_local_version() -> str:
+    """
+    Get the local version of the ts-backend-check package.
+
+    Returns
+    -------
+    str
+        The version of the installed ts-backend-check package, or a message indicating
+        that the package is not installed via pip.
+    """
+    try:
+        return importlib.metadata.version("ts-backend-check")
+
+    except importlib.metadata.PackageNotFoundError:
+        return UNKNOWN_VERSION_NOT_PIP
+
+
+def get_latest_version() -> Any:
+    """
+    Get the latest version of the ts-backend-check package from GitHub.
+
+    Returns
+    -------
+    Any
+        The latest version of the ts-backend-check package, or a message indicating
+        that the version could not be fetched.
+    """
+    try:
+        response = requests.get(
+            "https://api.github.com/repos/activist-org/ts-backend-check/releases/latest"
+        )
+        response_data: Dict[str, Any] = response.json()
+        return response_data["name"]
+
+    except Exception:
+        return UNKNOWN_VERSION_NOT_FETCHED
+
+
+def get_version_message() -> str:
+    """
+    Get a message indicating the local and latest versions of the ts-backend-check package.
+
+    Returns
+    -------
+    str
+        A message indicating the local version, the latest version, and whether
+        an upgrade is available.
+    """
+    local_version = get_local_version()
+    latest_version = get_latest_version()
+
+    if local_version == UNKNOWN_VERSION_NOT_PIP:
+        return UNKNOWN_VERSION_NOT_PIP
+
+    elif latest_version == UNKNOWN_VERSION_NOT_FETCHED:
+        return UNKNOWN_VERSION_NOT_FETCHED
+
+    local_version_clean = local_version.strip()
+    latest_version_clean = latest_version.replace("ts-backend-check", "").strip()
+
+    if local_version_clean == latest_version_clean:
+        return f"ts-backend-check v{local_version_clean}"
+
+    elif local_version_clean > latest_version_clean:
+        return f"ts-backend-check v{local_version_clean} is higher than the currently released version ts-backend-check v{latest_version_clean}. Hopefully this is a development build, and if so, thanks for your work on ts-backend-check! If not, please report this to the team at https://github.com/activist-org/ts-backend-check/issues."
+
+    else:
+        return f"ts-backend-check v{local_version_clean} (Upgrade available: ts-backend-check v{latest_version_clean}). To upgrade: ts-backend-check -u"
+
+
+if __name__ == "__main__":
+    print(get_version_message())

ts_backend_check/parsers/django_parser.py

@@ -96,7 +96,7 @@ def extract_model_fields(models_file: str) -> Dict[str, Set[str]]:
     """
     with open(models_file, "r", encoding="utf-8") as f:
         content = f.read().strip()
-        # Skip any empty lines at the beginning
+        # Skip any empty lines at the beginning.
         while content.startswith("\n"):
             content = content[1:]
 

ts_backend_check/parsers/typescript_parser.py

@@ -60,24 +60,17 @@ class TypeScriptParser:
 
         return interfaces
 
-    def get_backend_only_fields(self) -> Set[str]:
+    def get_ignored_fields(self) -> Set[str]:
         """
-        Extract fields marked as backend-only in comments.
+        Extract fields marked as ignored in comments.
 
         Returns
         -------
         Set[str]
-            The field names that are marked with a backend-only identifier to ignore them.
+            The field names that are marked with a ts-backend-check-ignore identifier to ignore them.
         """
-        patterns = [
-            r"//.*?Note:\s*(\w+)\s+is\s+backend\s+only",
-            r"//.*?(\w+)\s+is\s+backend\s+only",
-            r"//\s*@backend-only\s+(\w+)",
-            r"//.*?backend-only:\s*(\w+)",
-        ]
-        return {
-            match for pattern in patterns for match in re.findall(pattern, self.content)
-        }
+        ignore_pattern = r"//.*?ts-backend-check: ignore field\s+(\w+)"
+        return set(re.findall(ignore_pattern, self.content))
 
     @staticmethod
     def _extract_fields(interface_body: str) -> Set[str]:

ts_backend_check-1.2.1.data/data/requirements.txt

@@ -0,0 +1,26 @@
+#
+# This file is autogenerated by pip-compile with Python 3.13
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+certifi>=2025.11.12
+    # via requests
+charset-normalizer>=3.4.4
+    # via requests
+idna>=3.11
+    # via requests
+markdown-it-py>=4.0.0
+    # via rich
+mdurl>=0.1.2
+    # via markdown-it-py
+pygments>=2.19.2
+    # via rich
+pyyaml>=6.0.3
+    # via -r requirements.in
+requests>=2.32.5
+    # via -r requirements.in
+rich>=14.2.0
+    # via -r requirements.in
+urllib3>=2.6.2
+    # via requests

{ts_backend_check-1.1.0.dist-info → ts_backend_check-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ts-backend-check
-Version: 1.1.0
+Version: 1.2.1
 Summary: Check TypeScript types against their corresponding backend models to assure that all fields have been accounted for.
 Home-page: https://github.com/activist-org/ts-backend-check
 Author: ts-backend-check developers
@@ -12,16 +12,25 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: certifi>=2025.11.12
+Requires-Dist: charset-normalizer>=3.4.4
+Requires-Dist: idna>=3.11
+Requires-Dist: markdown-it-py>=4.0.0
+Requires-Dist: mdurl>=0.1.2
+Requires-Dist: pygments>=2.19.2
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.32.5
+Requires-Dist: rich>=14.2.0
+Requires-Dist: urllib3>=2.6.2
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -29,6 +38,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
+Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
@@ -37,7 +47,8 @@ Dynamic: summary
 </div>
 
 [![rtd](https://img.shields.io/readthedocs/ts-backend-check.svg?label=%20&logo=read-the-docs&logoColor=ffffff)](http://ts-backend-check.readthedocs.io/en/latest/)
-[![ci_backend](https://img.shields.io/github/actions/workflow/status/activist-org/ts-backend-check/pr_ci.yaml?branch=main&label=%20&logo=pytest&logoColor=ffffff)](https://github.com/activist-org/ts-backend-check/actions/workflows/pr_ci_backend.yaml)
+[![pr_ci](https://img.shields.io/github/actions/workflow/status/activist-org/ts-backend-check/pr_ci.yaml?branch=main&label=%20&logo=ruff&logoColor=ffffff)](https://github.com/activist-org/ts-backend-check/actions/workflows/pr_ci.yaml)
+[![python_package_ci](https://img.shields.io/github/actions/workflow/status/activist-org/ts-backend-check/python_package_ci.yaml?branch=main&label=%20&logo=pytest&logoColor=ffffff)](https://github.com/activist-org/ts-backend-check/actions/workflows/python_package_ci.yaml)
 [![issues](https://img.shields.io/github/issues/activist-org/ts-backend-check?label=%20&logo=github)](https://github.com/activist-org/ts-backend-check/issues)
 [![python](https://img.shields.io/badge/Python-4B8BBE.svg?logo=python&logoColor=ffffff)](https://github.com/activist-org/ts-backend-check/blob/main/CONTRIBUTING.md)
 [![pypi](https://img.shields.io/pypi/v/ts-backend-check.svg?label=%20&color=4B8BBE)](https://pypi.org/project/ts-backend-check/)
@@ -56,10 +67,10 @@ Dynamic: summary
 
 - [Usage](#usage-)
 - [Contributing](#contributing-)
-- [Environment setup](#environment-setup)
+- [Environment setup](#environment-setup-)
 - [Contributors](#contributors-)
 
-<a id="usage"></a>
+<a id="usage-"></a>
 
 ## Usage [`⇧`](#contents)
 
@@ -84,18 +95,35 @@ ts-backend-check --help
 
 # Check a TypeScript type against a backend model:
 ts-backend-check -bmf <backend-model-file> -tsf <typescript-file>
+```
+
+Example success and error outputs for the CLI are:
+
+```
+ts-backend-check -bmf backend/models/user.py -tsf frontend/types/user.ts
+
+✅ Success: All backend models are synced with their corresponding TypeScript interfaces for the provided files.
+```
+
+```
+ts-backend-check -bmf backend/models/user.py -tsf frontend/types/user.ts
+
+❌ ts-backend-check error: There are inconsistencies between the provided backend models and TypeScript interfaces. Please see the output below for details.
+
+Field 'user_name' (camelCase: 'userName') from model 'UserModel' is missing in the TypeScript interfaces.
+Expected to find this field in the frontend interface: User
+To ignore this field, add the following comment to the TypeScript interface: '// ts-backend-check: ignore field userName'
 
-# Example command:
-ts-backend-check -bmf src/models/user.py -tsf src/types/user.ts
+Please fix the 1 field above to have the backend models of backend/models/user.py synced with the typescript interfaces of frontend/types/user.ts.
 ```
 
-<a id="contributing"></a>
+<a id="contributing-"></a>
 
 # Contributing [`⇧`](#contents)
 
 <a href="https://matrix.to/#/#activist_community:matrix.org"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/MatrixLogoGrey.png" width="175" alt="Public Matrix Chat" align="right"></a>
 
-activist uses [Matrix](https://matrix.org/) for internal communication. You're more than welcome to [join us in our public chat rooms](https://matrix.to/#/#activist_community:matrix.org) to share ideas, ask questions or just say hi to the team :)
+activist uses [Matrix](https://matrix.org/) for internal communication. You're more than welcome to [join us in our public chat rooms](https://matrix.to/#/#activist_community:matrix.org) to share ideas, ask questions or just say hi to the team :) We'd suggest that you use the [Element](https://element.io/) client and [Element X](https://element.io/app) for a mobile app.
 
 Please see the [contribution guidelines](CONTRIBUTING.md) if you are interested in contributing. Work that is in progress or could be implemented is tracked in the [issues](https://github.com/activist-org/ts-backend-check/issues) and [projects](https://github.com/activist-org/ts-backend-check/projects).
 
@@ -106,7 +134,7 @@ Also check the [`-next release-`](https://github.com/activist-org/ts-backend-che
 
 We would be happy to discuss granting you further rights as a contributor after your first pull requests, with a maintainer role then being possible after continued interest in the project. activist seeks to be an inclusive, diverse and supportive organization. We'd love to have you on the team!
 
-<a id="how-you-can-help"></a>
+<a id="how-you-can-help-"></a>
 
 ## How you can help [`⇧`](#contents)
 
@@ -114,7 +142,7 @@ We would be happy to discuss granting you further rights as a contributor after
 - Working with us on [new features](https://github.com/activist-org/ts-backend-check/issues?q=is%3Aissue+is%3Aopen+label%3Afeature) ✨
 - [Documentation](https://github.com/activist-org/ts-backend-check/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) for onboarding and project cohesion 📝
 
-<a id="environment-setup"></a>
+<a id="environment-setup-"></a>
 
 # Environment setup [`⇧`](#contents)
 

ts_backend_check-1.2.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+ts_backend_check/__init__.py,sha256=HSiEqWvU3Q4a6D7tYsoq3-B-g1HdUOGngEeGV45j8ak,172
+ts_backend_check/checker.py,sha256=4QtPdiEnpRVIO4BpcHeCz-sjG2bqTg43M4gfntRnHj4,5956
+ts_backend_check/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
+ts_backend_check/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
+ts_backend_check/utils.py,sha256=N9_25_wW2g3dkmGGLWHQj_AHsXI9Rx2XqRnYxT5i2Rk,897
+ts_backend_check/cli/__init__.py,sha256=wJK9tO9MtI10L0xRjrk7WP_qZZRBjbFw1U9jJbIbX7I,108
+ts_backend_check/cli/check_blank.py,sha256=gg6v01UYNmzs8eLasxauCaBCfN9esUtiAwqhqNTzE3w,3377
+ts_backend_check/cli/config.py,sha256=AgzjY3qbgW4ya5JJEdKaBQ9J8h0Ip-39xJNbAjFpA6s,4463
+ts_backend_check/cli/main.py,sha256=uDG-Tzc0avs_2Rug-XkUvRf3OFZO1clr7QSrAPqXVos,4405
+ts_backend_check/cli/upgrade.py,sha256=P2LdIDCLdOFs-fOMuKLQoUMijQIyKEIA5PFZVsAUwDg,2952
+ts_backend_check/cli/version.py,sha256=lsocMaxAfF-FHW9O-NGH1sAo6svjuLgdGFxaC-XVoZc,2845
+ts_backend_check/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ts_backend_check/parsers/django_parser.py,sha256=U5OP6IyrSdwI9rDUGU4GbWTDfozwhretWg7lmF6QGB8,3242
+ts_backend_check/parsers/typescript_parser.py,sha256=UAExnEKxuFREFY6bJgQreG0b7SyVhWRaHw5TjN0CSU4,2680
+ts_backend_check-1.2.1.data/data/requirements.txt,sha256=ixdwNPm86WRSX0oBBaNegCQL7HQP8evsCRAdEFHLxGk,540
+ts_backend_check-1.2.1.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ts_backend_check-1.2.1.dist-info/METADATA,sha256=q5Mm6sTE9Ga3EJEJ65VdSaED1leRiOGTxxEplGKUbxs,11259
+ts_backend_check-1.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ts_backend_check-1.2.1.dist-info/entry_points.txt,sha256=QeY7RJu20otBnQlhMMZxPL8nB3mP3M3U3h3nOlSFWSU,68
+ts_backend_check-1.2.1.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
+ts_backend_check-1.2.1.dist-info/RECORD,,

ts_backend_check-1.1.0.data/data/requirements.txt

@@ -1,6 +0,0 @@
-#
-# This file is autogenerated by pip-compile with Python 3.13
-# by the following command:
-#
-#    pip-compile requirements.in
-#

ts_backend_check-1.1.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-ts_backend_check/__init__.py,sha256=HSiEqWvU3Q4a6D7tYsoq3-B-g1HdUOGngEeGV45j8ak,172
-ts_backend_check/checker.py,sha256=svfIJ9lNaSSy-zSGsM4wYD9Z9JK_xL5l6JA-w9pdf_o,5791
-ts_backend_check/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
-ts_backend_check/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
-ts_backend_check/utils.py,sha256=N9_25_wW2g3dkmGGLWHQj_AHsXI9Rx2XqRnYxT5i2Rk,897
-ts_backend_check/cli/__init__.py,sha256=wJK9tO9MtI10L0xRjrk7WP_qZZRBjbFw1U9jJbIbX7I,108
-ts_backend_check/cli/main.py,sha256=C3JCGv4QNo-xlp-MlCK49nzGAzuwWYDYLBi-OS7bvXQ,2712
-ts_backend_check/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ts_backend_check/parsers/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
-ts_backend_check/parsers/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
-ts_backend_check-1.1.0.data/data/requirements.txt,sha256=0FbFr7FTG31FEs_FMsN3MrAIFJIeGdDC6POOOb2FeA0,134
-ts_backend_check-1.1.0.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ts_backend_check-1.1.0.dist-info/METADATA,sha256=XSvF56GNwNfAJa1e8l1pa42Jz_n_9hG8TmR6yDx-N_A,9734
-ts_backend_check-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ts_backend_check-1.1.0.dist-info/entry_points.txt,sha256=QeY7RJu20otBnQlhMMZxPL8nB3mP3M3U3h3nOlSFWSU,68
-ts_backend_check-1.1.0.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
-ts_backend_check-1.1.0.dist-info/RECORD,,