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
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
# When to Mock
|
|
|
|
Mock at **system boundaries** only:
|
|
|
|
- External APIs (payment, email, etc.)
|
|
- Databases (sometimes - prefer test DB)
|
|
- Time/randomness
|
|
- File system (sometimes)
|
|
|
|
Don't mock:
|
|
|
|
- Your own classes/modules
|
|
- Internal collaborators
|
|
- Anything you control
|
|
|
|
## Designing for Mockability
|
|
|
|
At system boundaries, design interfaces that are easy to mock:
|
|
|
|
**1. Use dependency injection**
|
|
|
|
Pass external dependencies in rather than creating them internally:
|
|
|
|
```typescript
|
|
// Easy to mock
|
|
function processPayment(order, paymentClient) {
|
|
return paymentClient.charge(order.total);
|
|
}
|
|
|
|
// Hard to mock
|
|
function processPayment(order) {
|
|
const client = new StripeClient(process.env.STRIPE_KEY);
|
|
return client.charge(order.total);
|
|
}
|
|
```
|
|
|
|
**2. Prefer SDK-style interfaces over generic fetchers**
|
|
|
|
Create specific functions for each external operation instead of one generic function with conditional logic:
|
|
|
|
```typescript
|
|
// GOOD: Each function is independently mockable
|
|
const api = {
|
|
getUser: (id) => fetch(`/users/${id}`),
|
|
getOrders: (userId) => fetch(`/users/${userId}/orders`),
|
|
createOrder: (data) => fetch('/orders', { method: 'POST', body: data }),
|
|
};
|
|
|
|
// BAD: Mocking requires conditional logic inside the mock
|
|
const api = {
|
|
fetch: (endpoint, options) => fetch(endpoint, options),
|
|
};
|
|
```
|
|
|
|
The SDK approach means:
|
|
- Each mock returns one specific shape
|
|
- No conditional logic in test setup
|
|
- Easier to see which endpoints a test exercises
|
|
- Type safety per endpoint
|