fix(kyberforge): bridge apm content to Claude Code's flat plugin discovery
Claude Code's (and Copilot's) native plugin installer has zero awareness of .apm/ nesting -- it convention-scans only flat skills/, agents/, commands/, hooks.json at each plugin's root. Confirmed via strings on the installed claude binary and live installs of git@holocron/gitea@holocron/kyberforge@ holocron, all reporting Skills(0) Agents(0) Hooks(0) post ADR-0015's apm conversion. Root cause (apm_cli/core/plugin_manifest.py): apm's plugin.json compiler deliberately strips skills/agents/commands keys, assuming the host already auto-discovers those convention directories -- it has no model of .apm/ being host-visible at all. Separately, apm's own bundle exporter (apm_cli/bundle/plugin_exporter.py, behind `apm pack --format plugin`) implements the correct .apm/ -> flat mapping, but only ever targeted build/<name>-<version>/, a path nothing in marketplace.json's source: points at. scripts/sync-plugin-content.sh wraps that bundle exporter and copies its agents/, skills/, commands/, instructions/, extensions/, and merged hooks.json back into each plugin's own root as a second tracked compiled-output category -- same governance status as .claude-plugin/plugin.json: generated from .apm/, never hand-edited. tests/ subdirectories are excluded from the mirror (dev fixtures, not host-visible runtime content; several hardcode a relative repo-root walk-up sized for the .apm/-nested depth, which breaks when duplicated one level shallower). Applied for real across all 6 plugins and verified two ways: `claude plugin validate --strict` passes on every real plugin directory, and a live `claude --plugin-dir <path> -p "list skills/agents"` behavioral test confirms content is now actually discovered. Also, from the same issue #90 review round: - scripts/check-manifests.sh pointed at each plugin's root-level plugin.json (checking skills/hooks/mcpServers/agents pointer fields) -- that file was a stale near-duplicate of .claude-plugin/plugin.json nothing else read or wrote, now deleted across all 6 plugins. check-manifests.sh is rewritten to validate .claude-plugin/plugin.json instead, and drops the pointer-field checks entirely (nothing to check -- those fields are correctly absent by design). Content-presence drift is now check-plugin-content-sync's job, a new pre-push hook wired in .pre-commit-config.yaml. docs/adr/0017 records the root cause and decision in full, including two rejected alternatives (patching plugin.json's path fields directly -- apm's compiler strips them on every run; pointing marketplace.json at apm pack's build/ output -- a version-suffixed non-source directory nothing can install from without an extra build step). ADR-0015 and CONTEXT.md are updated to point at it. Refs: #90
This commit is contained in:
@@ -1,8 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Validates that all paths referenced in marketplace.json and plugin.json manifests
|
||||
# resolve to existing files or directories. Run from repo root or pass REPO_ROOT as arg.
|
||||
# Validates that marketplace.json's local plugin entries resolve to a real directory
|
||||
# containing a .claude-plugin/plugin.json. Run from repo root or pass REPO_ROOT as arg.
|
||||
#
|
||||
# Per ADR-0015, apm.yml is the authoring source and .claude-plugin/plugin.json is
|
||||
# compiled output with no skills/hooks/mcpServers/agents pointer fields (apm's plugin.json
|
||||
# builder deliberately omits them -- Claude Code auto-discovers those convention
|
||||
# directories, so listing them would be redundant/invalid). This script no longer checks
|
||||
# those fields; that's now scripts/sync-plugin-content.sh --check's job (drift between
|
||||
# .apm/ and the flat plugin-root mirror), wired as its own pre-push hook.
|
||||
|
||||
REPO_ROOT="${1:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"
|
||||
FAIL=0
|
||||
@@ -39,33 +46,11 @@ for ((i = 0; i < plugin_count; i++)); do
|
||||
continue
|
||||
fi
|
||||
|
||||
manifest="$plugin_dir/plugin.json"
|
||||
manifest="$plugin_dir/.claude-plugin/plugin.json"
|
||||
if [[ ! -f "$manifest" ]]; then
|
||||
err "plugin '$name': plugin.json not found in $source"
|
||||
err "plugin '$name': .claude-plugin/plugin.json not found in $source"
|
||||
continue
|
||||
fi
|
||||
|
||||
# Check skills directories
|
||||
skill_count=$(jq '.skills | if . then length else 0 end' "$manifest")
|
||||
for ((s = 0; s < skill_count; s++)); do
|
||||
skill_path=$(jq -r ".skills[$s]" "$manifest")
|
||||
full_path="$plugin_dir/$skill_path"
|
||||
full_path="${full_path%/}"
|
||||
if [[ ! -d "$full_path" ]]; then
|
||||
err "plugin '$name': skills path not found: $skill_path"
|
||||
fi
|
||||
done
|
||||
|
||||
# Check file references (hooks, mcpServers, agents)
|
||||
for field in hooks mcpServers agents; do
|
||||
ref=$(jq -r ".${field} // empty" "$manifest")
|
||||
[[ -z "$ref" ]] && continue
|
||||
full_path="$plugin_dir/$ref"
|
||||
full_path="${full_path%/}"
|
||||
if [[ ! -e "$full_path" ]]; then
|
||||
err "plugin '$name': $field path not found: $ref"
|
||||
fi
|
||||
done
|
||||
done
|
||||
|
||||
if [[ $FAIL -gt 0 ]]; then
|
||||
|
||||
161
scripts/sync-plugin-content.sh
Executable file
161
scripts/sync-plugin-content.sh
Executable file
@@ -0,0 +1,161 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Mirrors each plugin's .apm/{agents,skills,prompts,commands,instructions,extensions,hooks}
|
||||
# into flat plugin-root directories (agents/, skills/, commands/, instructions/,
|
||||
# extensions/, hooks.json) -- Claude Code's and GitHub Copilot's plugin loaders
|
||||
# convention-scan those flat paths at the plugin root; neither has any awareness of
|
||||
# apm's .apm/ nesting (confirmed via `strings` on the installed claude binary and a
|
||||
# live `claude --plugin-dir <bundle> -p ...` discoverability test -- see issue #90).
|
||||
# `apm pack --format plugin` already implements the correct .apm/ -> plugin-convention
|
||||
# mapping (it's built for distributable bundles under build/, a directory nothing in
|
||||
# marketplace.json points at); this script reuses that mapping and copies the relevant
|
||||
# subset back into the plugin root as compiled output -- same status as
|
||||
# .claude-plugin/plugin.json, never hand-edited when .apm/ is present.
|
||||
#
|
||||
# plugin.json, apm.lock.yaml, and .mcp.json from the bundle are deliberately NOT
|
||||
# copied: .claude-plugin/plugin.json + .github/plugin/plugin.json are already
|
||||
# generated correctly by a separate apm code path (core/plugin_manifest.py, run as
|
||||
# part of the same `apm pack` invocation), and .mcp.json is hand-authored at the
|
||||
# plugin root per ADR-0015 (it is not an .apm/ primitive).
|
||||
#
|
||||
# hooks.json is only synced when .apm/hooks/ actually produces one -- a plugin with
|
||||
# no .apm/hooks/ content is left alone even if a root-level hooks.json already exists
|
||||
# (pre-existing scaffolding outside this script's concern).
|
||||
#
|
||||
# tests/ subdirectories (e.g. .apm/skills/<name>/tests/*.bats) are excluded from the
|
||||
# mirror -- they are dev-time fixtures a plugin host never needs to discover, and several
|
||||
# reference their own repo root via a hardcoded relative walk-up (e.g.
|
||||
# `../../../../../../`) sized for the .apm/-nested depth. Mirroring them verbatim would
|
||||
# duplicate each file one directory level shallower than that walk-up expects, breaking
|
||||
# the duplicate and double-running the original under any repo-wide bats/test discovery.
|
||||
|
||||
usage() {
|
||||
echo "Usage: $0 [--check] <plugin-dir> [<plugin-dir> ...]" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
CHECK=0
|
||||
if [[ "${1:-}" == "--check" ]]; then
|
||||
CHECK=1
|
||||
shift
|
||||
fi
|
||||
[[ $# -ge 1 ]] || usage
|
||||
|
||||
if ! command -v apm &>/dev/null; then
|
||||
echo "Error: apm is required but not installed (see kyberforge:apm-install)" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Convention subdirectories apm's plugin exporter can populate from .apm/.
|
||||
MIRROR_DIRS=(agents skills commands instructions extensions)
|
||||
|
||||
FAIL=0
|
||||
SCRATCH_ROOT="$(mktemp -d)"
|
||||
trap 'rm -rf "$SCRATCH_ROOT"' EXIT
|
||||
|
||||
sync_dir() {
|
||||
local plugin_dir="$1" bundle_dir="$2" d="$3"
|
||||
local src="$bundle_dir/$d" dst="$plugin_dir/$d"
|
||||
|
||||
if [[ "$CHECK" -eq 1 ]]; then
|
||||
if [[ -d "$src" ]]; then
|
||||
if [[ ! -d "$dst" ]]; then
|
||||
echo "DRIFT $dst: missing (would be created from .apm/)" >&2
|
||||
FAIL=1
|
||||
elif ! diff -rq -x tests "$src" "$dst" >/dev/null 2>&1; then
|
||||
echo "DRIFT $dst: out of sync with .apm/" >&2
|
||||
diff -rq -x tests "$src" "$dst" 2>&1 | sed 's/^/ /' >&2
|
||||
FAIL=1
|
||||
fi
|
||||
elif [[ -d "$dst" ]]; then
|
||||
echo "DRIFT $dst: stale, no longer produced from .apm/" >&2
|
||||
FAIL=1
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [[ -d "$src" ]]; then
|
||||
rm -rf "$dst"
|
||||
mkdir -p "$dst"
|
||||
cp -a "$src/." "$dst/"
|
||||
find "$dst" -type d -name tests -exec rm -rf {} +
|
||||
elif [[ -d "$dst" ]]; then
|
||||
rm -rf "$dst"
|
||||
fi
|
||||
}
|
||||
|
||||
sync_hooks_json() {
|
||||
local plugin_dir="$1" bundle_dir="$2"
|
||||
local src="$bundle_dir/hooks.json" dst="$plugin_dir/hooks.json"
|
||||
|
||||
# No .apm/hooks/ content -- hooks.json (if any) is out of scope for this script.
|
||||
[[ -f "$src" ]] || return 0
|
||||
|
||||
# apm's bundle exporter writes hooks.json without a trailing newline, which
|
||||
# end-of-file-fixer (pre-commit) would flag on every regeneration -- normalize both
|
||||
# sides of the comparison (and the real write) to exactly one trailing newline
|
||||
# instead of fighting that hook on every sync.
|
||||
if [[ "$CHECK" -eq 1 ]]; then
|
||||
local normalized_src
|
||||
normalized_src="$(mktemp)"
|
||||
printf '%s\n' "$(cat "$src")" >"$normalized_src"
|
||||
if [[ ! -f "$dst" ]] || ! diff -q "$normalized_src" "$dst" >/dev/null 2>&1; then
|
||||
echo "DRIFT $dst: out of sync with .apm/hooks/" >&2
|
||||
FAIL=1
|
||||
fi
|
||||
rm -f "$normalized_src"
|
||||
return 0
|
||||
fi
|
||||
|
||||
printf '%s\n' "$(cat "$src")" >"$dst"
|
||||
}
|
||||
|
||||
sync_one() {
|
||||
local plugin_dir="${1%/}"
|
||||
local apm_dir="$plugin_dir/.apm"
|
||||
|
||||
if [[ ! -d "$apm_dir" ]]; then
|
||||
echo "SKIP $plugin_dir: no .apm/ directory" >&2
|
||||
return 0
|
||||
fi
|
||||
|
||||
local name scratch bundle_dir pack_log
|
||||
name="$(basename "$plugin_dir")"
|
||||
scratch="$SCRATCH_ROOT/$name"
|
||||
mkdir -p "$scratch"
|
||||
pack_log="$(mktemp)"
|
||||
|
||||
if ! (cd "$plugin_dir" && apm pack --format plugin -o "$scratch") >"$pack_log" 2>&1; then
|
||||
echo "FAIL $plugin_dir: apm pack failed:" >&2
|
||||
sed 's/^/ /' "$pack_log" >&2
|
||||
rm -f "$pack_log"
|
||||
FAIL=1
|
||||
return 0
|
||||
fi
|
||||
rm -f "$pack_log"
|
||||
|
||||
bundle_dir="$(find "$scratch" -mindepth 1 -maxdepth 1 -type d | head -1)"
|
||||
if [[ -z "$bundle_dir" ]]; then
|
||||
echo "FAIL $plugin_dir: apm pack produced no bundle directory under $scratch" >&2
|
||||
FAIL=1
|
||||
return 0
|
||||
fi
|
||||
|
||||
local d
|
||||
for d in "${MIRROR_DIRS[@]}"; do
|
||||
sync_dir "$plugin_dir" "$bundle_dir" "$d"
|
||||
done
|
||||
sync_hooks_json "$plugin_dir" "$bundle_dir"
|
||||
}
|
||||
|
||||
for plugin_dir in "$@"; do
|
||||
sync_one "$plugin_dir"
|
||||
done
|
||||
|
||||
if [[ "$FAIL" -ne 0 ]]; then
|
||||
if [[ "$CHECK" -eq 1 ]]; then
|
||||
echo "Plugin content mirror is out of sync with .apm/. Fix: bash scripts/sync-plugin-content.sh $*" >&2
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
Reference in New Issue
Block a user