Manfred Riem
40037b1aca
* feat(init): scaffold managed .specify/.gitignore Write a manifest-tracked `.specify/.gitignore` during shared-infra install so machine-local Spec Kit state stays out of version control while everything else under `.specify/` remains shareable: - `feature.json` — the current-feature pointer, rewritten on every feature switch (per-checkout state, not something to share). - `extensions/*/local-config.yml` — per-machine extension config overrides. The file is routed through the same overwrite/skip/preserve policy as shared templates: `--force` refreshes it, user edits are preserved on re-init, and uninstall removes it via the manifest. Addresses github/spec-kit#2304. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98faefd1-9fc8-48fc-bd25-d4f3ccbb2ab9 * docs: correct .specify/.gitignore uninstall claim The file is tracked in the shared-infra manifest (speckit.manifest.json), not the per-integration manifest that `specify integration uninstall` loads. Shared infrastructure is deliberately preserved on uninstall (see test_uninstall_preserves_shared_infra), so `.specify/.gitignore` is left in place rather than removed. Reword the code comment and core.md note to state the actual behavior; keep the true benefits (force-refresh and preserve-on-edit). Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98faefd1-9fc8-48fc-bd25-d4f3ccbb2ab9 * revert: drop manual CHANGELOG.md edit CHANGELOG.md is auto-generated; do not hand-edit it. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98faefd1-9fc8-48fc-bd25-d4f3ccbb2ab9 * test: add .specify/.gitignore to integration file inventories The complete-file-inventory tests assert an exact match of every file produced by `specify init`. Now that shared infra scaffolds a managed `.specify/.gitignore`, add it to the expected inventories so the exact-match assertions pass on both sh and ps script types. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98faefd1-9fc8-48fc-bd25-d4f3ccbb2ab9
104 lines
3.4 KiB
Python
104 lines
3.4 KiB
Python
"""Tests for the managed ``.specify/.gitignore`` written by shared-infra install.
|
|
|
|
The Specify CLI scaffolds a ``.specify/.gitignore`` so machine-local Spec Kit
|
|
state (the ``feature.json`` current-feature pointer and per-machine extension
|
|
``local-config.yml`` overrides) stays out of version control while everything
|
|
else under ``.specify/`` remains shareable. These tests pin that behaviour:
|
|
the file is created and manifest-tracked, its patterns actually make git ignore
|
|
the intended paths, user edits are preserved on a plain re-run, and ``--force``
|
|
restores the managed content.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import shutil
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from specify_cli import _install_shared_infra
|
|
from specify_cli.shared_infra import SPECIFY_GITIGNORE_CONTENT
|
|
|
|
|
|
def _install(project: Path, **kwargs) -> None:
|
|
(project / ".specify").mkdir(parents=True, exist_ok=True)
|
|
_install_shared_infra(project, "sh", **kwargs)
|
|
|
|
|
|
def test_gitignore_is_written_and_tracked(tmp_path: Path) -> None:
|
|
project = tmp_path / "proj"
|
|
_install(project)
|
|
|
|
gitignore = project / ".specify" / ".gitignore"
|
|
assert gitignore.is_file()
|
|
|
|
content = gitignore.read_text(encoding="utf-8")
|
|
assert "feature.json" in content
|
|
assert "extensions/*/local-config.yml" in content
|
|
|
|
manifest = json.loads(
|
|
(project / ".specify" / "integrations" / "speckit.manifest.json").read_text(
|
|
encoding="utf-8"
|
|
)
|
|
)
|
|
assert ".specify/.gitignore" in manifest.get("files", {})
|
|
|
|
|
|
@pytest.mark.skipif(shutil.which("git") is None, reason="git not available")
|
|
def test_git_ignores_the_intended_paths(tmp_path: Path) -> None:
|
|
project = tmp_path / "proj"
|
|
project.mkdir()
|
|
subprocess.run(["git", "init", "-q"], cwd=project, check=True)
|
|
|
|
_install(project)
|
|
|
|
(project / ".specify" / "feature.json").write_text("{}", encoding="utf-8")
|
|
ext_local = project / ".specify" / "extensions" / "git" / "local-config.yml"
|
|
ext_local.parent.mkdir(parents=True, exist_ok=True)
|
|
ext_local.write_text("x\n", encoding="utf-8")
|
|
|
|
for rel in (
|
|
".specify/feature.json",
|
|
".specify/extensions/git/local-config.yml",
|
|
):
|
|
result = subprocess.run(
|
|
["git", "check-ignore", rel],
|
|
cwd=project,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
assert result.returncode == 0, f"{rel} was not ignored"
|
|
|
|
# A shareable file under .specify/ must NOT be ignored.
|
|
tracked = subprocess.run(
|
|
["git", "check-ignore", ".specify/memory/constitution.md"],
|
|
cwd=project,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
assert tracked.returncode == 1
|
|
|
|
|
|
def test_user_edits_preserved_by_default(tmp_path: Path) -> None:
|
|
project = tmp_path / "proj"
|
|
_install(project)
|
|
|
|
gitignore = project / ".specify" / ".gitignore"
|
|
gitignore.write_text("# my customization\n", encoding="utf-8")
|
|
|
|
_install(project) # plain re-run must not clobber user edits
|
|
assert gitignore.read_text(encoding="utf-8") == "# my customization\n"
|
|
|
|
|
|
def test_force_restores_managed_content(tmp_path: Path) -> None:
|
|
project = tmp_path / "proj"
|
|
_install(project)
|
|
|
|
gitignore = project / ".specify" / ".gitignore"
|
|
gitignore.write_text("# my customization\n", encoding="utf-8")
|
|
|
|
_install(project, force=True)
|
|
assert gitignore.read_text(encoding="utf-8") == SPECIFY_GITIGNORE_CONTENT
|