[Feature]: Add --json output to preset info and extension info with fully-expanded per-contribution detail (per-pack detail view; complements list --json summary counts)
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 45/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- javascript, python
- Domaine
- cli, documentation, testing
Piste de recherche
Commencez par les points d’entrée CLI preset info --json et extension info --json, puis suivez la normalisation existante dans composition/collect.mjs::parseProvidesEntries et ::parseHookDeclarations ; examinez extensions/__init__.py:622-626 pour le comportement qui autorise uniquement les remplacements. Comparez la sortie avec les contrats correspondants de list --json et artifact info --json. Le travail est considéré comme terminé lorsque les schémas étendus spécifiés, les identifiants stables, la normalisation, les erreurs, les tests et la documentation de référence CLI sont complets.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Problem Statement
Today specify preset info <id> and specify extension info <id> emit only text. speckit-wizard-canvas reads the raw preset.yml / extension.yml files with js-yaml and re-normalizes the shape itself in composition/collect.mjs::parseProvidesEntries and ::parseHookDeclarations — including strategy inference from shorthand keys (replaces vs. wraps vs. prepends vs. appends), hook-phase normalization (phase vs. trigger, command vs. targetCommand), and script-runtime inference by globbing scripts/{bash,powershell,python}/*.{sh,ps1,py}. All of this is server-side data being reconstructed on the client.
Downstream consumers need the structured shape returned by the CLI itself so they can stop reconstructing it.
How this differs from the companion preset list --json / extension list --json issue. The list variant operates on the collection of installed packs and returns a JSON array, one row per pack, where provides is just integer counts ({ commands: 4, templates: 2, scripts: 1, hooks: 3 }) — a summary/catalog view suitable for "here's every preset the project has". info operates on one pack, addressed by id, and returns a single JSON object where provides is fully expanded — every command, template, script, and hook enumerated with its full per-contribution schema (id, name, description, artifact, optional, handoffs, strategy, sourcePath, runtimes, etc.). A wizard rendering "here's what speckit.git contributes to my project" needs the info detail; list's counts are not enough. Both surfaces are required; neither is a subset of the other.
Proposed Solution
Add --json to both info commands. Output shape:
{
"id": "…", "name": "…", "description": "…", "version": "…",
"author": "…", "priority": 100, "enabled": true, "source": { "…": "…" },
"commands": [
{ "id": "…", "name": "speckit.plan", "description": "…",
"artifact": "specs/{feature}/plan.md", "optional": false,
"handoffs": [ { "to": "speckit.tasks", "when": "…", "message": "…" } ],
"strategy": "wrap",
"source": { "layer": "preset", "presetId": "…" },
"sourcePath": "commands/speckit.plan.md" }
],
"templates": [
{ "id": "…", "name": "…", "description": "…",
"strategy": "replace",
"source": { "…": "…" }, "sourcePath": "templates/…" }
],
"scripts": [
{ "id": "…", "name": "…", "description": "…",
"strategy": "replace",
"source": { "…": "…" }, "sourcePath": "scripts/bash/…",
"runtimes": ["bash", "powershell", "python"] }
],
"hooks": [
{ "id": "…", "name": "…", "description": "…",
"trigger": "before_speckit.plan", "targetCommand": "speckit.git.checklist",
"sourcePath": "commands/speckit.git.checklist.md",
"optional": false, "priority": 10 }
]
}
Notes:
- Preset objects omit
hooks. - Extension
commands/templates/scriptsentries omitstrategy(they are alwaysreplace, per the replace-only rule enforced atextensions/__init__.py:622-626). idvalues use the stable-id scheme from the companion "stable id / lookupId" issue; theidon a per-contribution entry is what the companionspecify artifact info --jsonstack'slookupIdpoints at.artifact,optional,handoffson commands come from the companion "artifact/optional/handoffs" issue.runtimeson scripts comes directly from the manifest (extensions post-#4010; add the same field to preset script entries for parity).- All shorthand-key normalization (
replaces/wraps/prepends/appends→strategy: "replace"|"wrap"|"prepend"|"append") is done server-side.
Alternatives Considered
- Fold everything into the companion
specify artifact info --jsoncommand. Rejected —artifact infois per-artifact (walks one composition stack across all installed packs);info --jsonis per-source (walks one preset/extension across all its contributions). Both are needed and neither is a subset of the other. - Fold everything into the companion
preset list --json/extension list --json. Rejected — that surface is per-collection with summary counts;infois per-pack with full expansion. Different shape, different call pattern, different use cases (see Problem Statement). - Emit YAML. Rejected — the whole point is to let the wizard drop
js-yaml. - Leave hook-phase / strategy shorthand un-normalized. Rejected — every consumer would reproduce the client-side logic from
composition/collect.mjsand drift over time.
Component
Specify CLI (initialization, commands)
AI Agent (if applicable)
Not applicable
Use Cases
speckit-wizard-canvasdeletescomposition/collect.mjs::parseProvidesEntriesand::parseHookDeclarations, replacing them withJSON.parse(execFileSync("specify", ["preset", "info", "<id>", "--json"]))/specify extension info <id> --json. This is the change that removes thejs-yamldependency.- An IDE plugin renders hover-cards on command names by looking up the
commands[]entry (description,artifact,handoffs). - A pre-commit check walks
extension info --json'shooks[]to warn when two extensions register the sametriggerat the samepriority.
Acceptance Criteria
-
specify preset info <id> --jsonandspecify extension info <id> --jsonemit a single JSON object with top-level fields matching the companionlist --jsonissue (id,name,description,version,author,priority,enabled,source) plus fully-expandedcommands,templates,scriptsarrays (andhooksfor extensions) — not integer counts. - Command entries include
artifact,optional,handoffs(from the companion command-fields issue). - Script entries include
runtimesfor both presets and extensions. - Preset command/template/script entries include
strategy; extension entries omit it (or set to"replace"for informational purposes). - Shorthand keys (
replaces/wraps/prepends/appends) are normalized server-side intostrategy. - Hook entries include
trigger,targetCommand,sourcePath,optional,priority—phase/commandshorthand normalized. - All
idvalues follow the stable-id scheme and are stable across reinstalls, matching thelookupIdvalues emitted byspecify artifact info --json. - Unknown id → non-zero exit + stderr JSON error.
- Tests: schema round-trip, strategy normalization (all four shorthand forms), hook shorthand normalization, extension replace-only enforcement, handoffs frontmatter-merge, and
idcross-reference withspecify artifact info --jsonoutput. - Docs:
preset info/extension infosections in the CLI reference show the--jsonshape and normalization rules, plus a note contrastinginfo --json(per-pack, full expansion) withlist --json(per-collection, count summary).
Additional Context
Direct replacement for plugins/spec-kit-copilot-wizard/extensions/speckit-wizard-canvas/composition/collect.mjs::parseProvidesEntries and ::parseHookDeclarations in github/spec-kit-copilot. Depends on the companion "artifact/optional/handoffs" and "stable id / lookupId" issues; benefits from the companion "structured source provenance" issue.
- Langage dominant
- Python
- Étoiles
- 138k
- Forks
- 12.4k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 161
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/spec-kit
-
enhancement needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Les mainteneurs répondent en général sous 1 jour
-
triage-nice-to-have
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Windows: Copilot integration hardcodes `copilot.cmd`, breaking installs that ship `copilot.exe`Ouvertebug-assess severity-medium triage-nice-to-have
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
github/spec-kit#4755 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
triage-nice-to-have
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
[Feature]: 给 slug 添加默认值Ouverteenhancement needs-triage triage-can-wait
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
github/spec-kit#4627 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de github/spec-kit
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-2 jours Accessibilité débutants 70/100
-
FingerprintSplitter raises ZeroDivisionError when int(frac_train * len(dataset)) floors to zeroOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 7 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
lmstudio-ai/mlx-engine#376 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
pyiron/bagofholding#166 ·