feat(dev): add integration scaffolder (#2685)

* feat(dev): add integration scaffolder

* fix(dev): address integration scaffold review feedback

* fix(dev): address scaffold follow-up review

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix(dev): default scaffolded integrations to multi_install_safe = False

The scaffold template emitted `multi_install_safe = True` alongside a
placeholder `context_file = "AGENTS.md"`. Registered as-is, that violates the
registry contract (test_safe_integrations_have_distinct_context_files): codex
already pairs AGENTS.md with multi_install_safe = True, so the generated
boilerplate would collide on first registration.

Default the scaffold to False (matching IntegrationBase) so generated code is
registry-test-friendly out of the box; contributors opt in once they pick a
unique context_file. Aligns the generated test skeleton and both scaffold
tests, which previously contradicted each other (one expected True, one False).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(dev): harden scaffold writes and accept case-insensitive --type

- Guard scaffold_integration() against symlinked target directories: walk
  each path component under the repo root and refuse symlinked dirs, then
  confirm the write destination resolves inside the repo (mirrors the
  manifest directory guard). Prevents scaffolding outside the repo when a
  contributor's integrations/tests path is symlinked.
- Make the `--type` click.Choice case-insensitive so `--type YAML` is
  accepted, matching scaffold_integration()'s strip()/lower() normalization
  instead of rejecting at the CLI layer.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(dev): report scaffold filesystem failures as a clean CLI error

The `dev integration scaffold` command only caught FileExistsError/ValueError,
so an OSError raised during mkdir()/write_text() (permission denied, read-only
checkout, a path component that is a file, ...) bubbled up as a traceback
instead of a clean error + exit code. Broaden the handler to OSError (which
also covers FileExistsError) and add coverage for the filesystem-error path.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(dev): move scaffold command under integration

* fix(dev): roll back partial scaffold writes

* fix(dev): correct lint docs and generated test docstring

- local-development.md: ruff check src/ is enforced in CI, not absent
- scaffolded test docstring: drop misleading 'scaffold' wording

* fix(scaffold): create only leaf integration directory

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Pascal THUET
2026-06-17 00:48:40 +02:00
committed by GitHub
parent 497ca074ed
commit 9cd20c6c25
5 changed files with 613 additions and 9 deletions

View File

@@ -31,4 +31,5 @@ def register(app: typer.Typer) -> None:
from . import _install_commands # noqa: F401 — registers handlers via decorators
from . import _migrate_commands # noqa: F401
from . import _query_commands # noqa: F401
from . import _scaffold_commands # noqa: F401
app.add_typer(integration_app, name="integration")

View File

@@ -0,0 +1,52 @@
"""specify integration scaffold command handler."""
from __future__ import annotations
from enum import Enum
from pathlib import Path
import typer
from .._console import console
from ..integration_scaffold import supported_integration_scaffold_types
from ._commands import integration_app
INTEGRATION_SCAFFOLD_TYPES = supported_integration_scaffold_types()
_IntegrationScaffoldType = Enum(
"_IntegrationScaffoldType",
{name: name for name in INTEGRATION_SCAFFOLD_TYPES},
type=str,
)
@integration_app.command("scaffold")
def integration_scaffold(
key: str = typer.Argument(help="Integration key in lowercase kebab-case, e.g. my-agent"),
integration_type: _IntegrationScaffoldType = typer.Option(
_IntegrationScaffoldType.markdown,
"--type",
case_sensitive=False,
help=f"Scaffold type: {', '.join(INTEGRATION_SCAFFOLD_TYPES)}",
),
):
"""Create a minimal built-in integration package and test skeleton."""
from ..integration_scaffold import scaffold_integration
project_root = Path.cwd()
try:
result = scaffold_integration(project_root, key, integration_type.value)
except (OSError, ValueError) as exc:
# OSError covers filesystem failures during mkdir()/write_text()
# (permission denied, read-only checkout, a path component that is a
# file, ...) as well as FileExistsError; surface them as a clean CLI
# error instead of a traceback.
console.print(f"[red]Error:[/red] {exc}")
raise typer.Exit(1)
console.print(f"[green]Created integration scaffold:[/green] {result.key}")
console.print(f" {result.integration_file.relative_to(project_root).as_posix()}")
console.print(f" {result.test_file.relative_to(project_root).as_posix()}")
console.print()
console.print("[bold]Next steps:[/bold]")
for index, step in enumerate(result.next_steps, start=1):
console.print(f"{index}. {step}")