A16nPlugin
@a16njs/models / A16nPlugin
Interface: A16nPlugin
Defined in: plugin.ts:84
The plugin interface that all a16n plugins must implement. Plugins bridge between a16n's internal model and a specific tool's format.
Properties
id
id:
string
Defined in: plugin.ts:86
Unique identifier, e.g., 'cursor', 'claude', 'codex'
name
name:
string
Defined in: plugin.ts:88
Human-readable name
supports
supports:
CustomizationType[]
Defined in: plugin.ts:90
Which customization types this plugin supports
pathPatterns?
optionalpathPatterns?:PluginPathPatterns
Defined in: plugin.ts:92
Path patterns for this plugin's file format (used by transformations)
Methods
discover()
discover(
rootOrWorkspace):Promise<DiscoveryResult>
Defined in: plugin.ts:99
Discover all agent customizations in a directory tree.
Parameters
rootOrWorkspace
string | Workspace
The root directory path or Workspace to search
Returns
Promise<DiscoveryResult>
All customizations found and any warnings
emit()
emit(
models,rootOrWorkspace,options?):Promise<EmitResult>
Defined in: plugin.ts:108
Emit customization models to disk in this plugin's format.
Parameters
models
The customizations to emit
rootOrWorkspace
string | Workspace
The root directory path or Workspace to write to
options?
Optional emit options (e.g., dryRun)
Returns
Promise<EmitResult>
Info about what was written (or would be written) and any issues