src/hatch/cli/check/fmt.py - master - niceSOFT/python3-hatchling

src/hatch/cli/check/fmt.py
74 строки3 KB
Cary Hawkins
Feat hatch check command with new sub command for types (#2278)
31 май 2026, 03:29
31 май 2026, 03:29818d284
from __future__ import annotations

from typing import TYPE_CHECKING

import click

if TYPE_CHECKING:
    from hatch.cli.application import Application


@click.command(short_help="Verify formatting", context_settings={"ignore_unknown_options": True})
@click.argument("args", nargs=-1)
@click.option("--fix", is_flag=True, help="Apply formatting fixes rather than just checking")
@click.option("--sync", is_flag=True, help="Sync the default config file with the current version of Hatch")
@click.pass_obj
def fmt(
    app: Application,
    *,
    args: tuple[str, ...],
    fix: bool,
    sync: bool,
):
    """
    Verify formatting, using Ruff by default.
    """
    from hatch.cli.fmt.core import StaticAnalysisEnvironment

    app.ensure_environment_plugin_dependencies()

    for context in app.runner_context(["hatch-check-fmt"]):
        sa_env = StaticAnalysisEnvironment(context.env)

        # TODO: remove in a few minor releases, this is very new but we don't want to break users on the cutting edge
        if legacy_config_path := app.project.config.config.get("format", {}).get("config-path", ""):
            app.display_warning(
                "The `tool.hatch.format.config-path` option is deprecated and will be removed in a future release. "
                "Use `tool.hatch.envs.hatch-check-fmt.config-path` instead."
            )
            sa_env.config_path = legacy_config_path

        if sync and not sa_env.config_path:
            app.abort("The --sync flag can only be used when the `tool.hatch.format.config-path` option is defined")

        script = "format-fix" if fix else "format-check"

        default_args = sa_env.get_default_args()
        arguments = list(args)
        try:
            arguments.remove("--preview")
        except ValueError:
            preview = False
        else:
            preview = True
            default_args.append("--preview")

        internal_args = context.env.join_command_args(default_args)
        if internal_args:
            internal_args = f" {internal_args}"

        formatted_args = context.env.join_command_args(arguments)
        context.add_shell_command(f"{script} {formatted_args}")

        # Check for legacy HATCH_FMT_ARGS usage in scripts and warn about deprecation
        for script_body in context.env.config.get("scripts", {}).values():
            if isinstance(script_body, str) and "HATCH_FMT_ARGS" in script_body:
                app.display_warning(
                    "The `HATCH_FMT_ARGS` environment variable is deprecated. Use `HATCH_CHECK_FMT_ARGS` instead."
                )
                break

        context.env_vars["HATCH_CHECK_FMT_ARGS"] = internal_args

        if not sa_env.config_path or sync:
            sa_env.write_config_file(preview=preview)