andreoliwa/nitpick

"""Nitpick exceptions."""

from __future__ import annotations

import warnings
from typing import TYPE_CHECKING, Any

from more_itertools import always_iterable

from nitpick.constants import PRE_COMMIT_CONFIG_YAML, PROJECT_NAME

if TYPE_CHECKING:
    from nitpick.violations import Fuss


class QuitComplainingError(Exception):
    """Quit complaining and exit the application."""

    def __init__(self, violations: Fuss | list[Fuss]) -> None:
        super().__init__()
        self.violations: list[Fuss] = list(always_iterable(violations))


class Deprecation:
    """All deprecation messages in a single class.

    When it's time to break compatibility, remove a method/warning below,
    and older config files will trigger validation errors on Nitpick.
    """

    @staticmethod
    def pre_commit_without_dash(path_from_root: str) -> bool:
        """The pre-commit config should start with a dot on the config file."""
        if path_from_root == PRE_COMMIT_CONFIG_YAML[1:]:
            warnings.warn(
                f'The section name for dotfiles should start with a dot: [".{path_from_root}"]',
                DeprecationWarning,
                stacklevel=2,
            )
            return True

        return False

    @staticmethod
    def jsonfile_section(style_errors: dict[str, Any]) -> bool:
        """The [nitpick.JSONFile] is not needed anymore; JSON files are now detected by the extension."""
        has_nitpick_jsonfile_section = style_errors.get(PROJECT_NAME, {}).pop("JSONFile", None)
        if has_nitpick_jsonfile_section:
            style_errors.pop(PROJECT_NAME)
            warnings.warn(
                "The [nitpick.JSONFile] section is not needed anymore; just declare your JSON files directly",
                DeprecationWarning,
                stacklevel=2,
            )
            return True
        return False

    @staticmethod
    def pre_commit_repos_with_yaml_key() -> bool:
        """The pre-commit config should not have the "repos.yaml" key anymore; this is the old style.

        Slight breaking change in the TOML config format: ditching the old TOML config.
        """
        from nitpick.plugins.yaml import KEY_REPOS, KEY_YAML  # pylint: disable=import-outside-toplevel

        warnings.warn(
            f"The {KEY_REPOS}.{KEY_YAML} key is not supported anymore."
            " Check the documentation and please update your YAML styles",
            DeprecationWarning,
            stacklevel=2,
        )
        return True


def pretty_exception(err: Exception, message: str = ""):
    """Return a pretty error message with the full path of the Exception."""
    return f"{message} ({err.__module__}.{err.__class__.__name__}: {err!s})"