Add commands to hatch cli from plugins

backend/src/hatchling/plugin/specs.py

@@ -1,6 +1,6 @@
 import pluggy
 
-hookspec = pluggy.HookspecMarker('hatch')
+hookspec = pluggy.HookspecMarker("hatch")
 
 
 @hookspec
@@ -21,3 +21,8 @@ def hatch_register_build_hook() -> None:
 @hookspec
 def hatch_register_metadata_hook() -> None:
  """Register new classes that adhere to the metadata hook interface."""
+
+
+@hookspec
+def hatch_register_commands() -> None:
+ """Register new commands to cli"""

hatch.toml

@@ -2,6 +2,7 @@
 dependencies = [
  "coverage[toml]>=6.2",
  "filelock>=3.7.1",
+ "importlib-resources",
  "pytest",
  "pytest-cov",
  "pytest-mock",

src/hatch/cli/__init__.py

@@ -11,6 +11,7 @@
 from hatch.cli.dep import dep
 from hatch.cli.env import env
 from hatch.cli.new import new
+from hatch.cli.plugin import load_plugins
 from hatch.cli.project import project
 from hatch.cli.publish import publish
 from hatch.cli.run import run
@@ -200,6 +201,8 @@ def hatch(ctx: click.Context, env_name, project, color, interactive, verbose, qu
 hatch.add_command(status)
 hatch.add_command(version)
 
+load_plugins(hatch)
+
 
 def main(): # no cov
  try:

src/hatch/cli/plugin.py

@@ -0,0 +1,16 @@
+from itertools import chain
+
+import pluggy
+from click import Group
+from hatchling.plugin import specs
+
+
+def load_plugins(hatch: Group):
+ pm = pluggy.PluginManager("hatch")
+
+ pm.add_hookspecs(specs)
+ pm.load_setuptools_entrypoints("hatch")
+
+ plugins = pm.hook.hatch_register_commands()
+ for plugin in chain.from_iterable(plugins):
+ hatch.add_command(plugin)

tests/cli/plugin/cli-plugin/hatch_cli/hooks.py

@@ -0,0 +1,13 @@
+import click
+from hatchling.plugin import hookimpl
+
+
+@click.command(short_help="Execute a custom command")
+def random():
+ """Execute a custom command"""
+ click.echo("random")
+
+
+@hookimpl
+def hatch_register_commands():
+ return [random]

tests/cli/plugin/cli-plugin/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "hatch-test-cli"
+version = "0.0.1"
+description = ""
+requires-python = ">=3.7"
+authors = [
+ { name = "Thomas Denoréaz", email = "[email protected]" },
+]
+dependencies = [
+ "hatch>=1.2.0",
+]
+
+[project.entry-points.hatch]
+cli = "hatch_cli.hooks"

tests/cli/plugin/test_command.py

@@ -0,0 +1,15 @@
+import shutil
+
+import importlib_resources
+
+
+def test_run_command(hatch, temp_dir, helpers):
+ project_dir = temp_dir / "cli-plugin"
+ shutil.copytree(importlib_resources.files(__package__) / "cli-plugin", project_dir)
+
+ with project_dir.as_cwd():
+ result1 = hatch("new", "--init")
+ result = hatch("random")
+
+ assert result.exit_code == 0, result.output
+ assert result.output == 'random\n'