1.6 KiB
1.6 KiB
IdeA Plugin SDK
Public TypeScript SDK for IdeA plugins.
The SDK defines the stable manifest and runtime types used by plugins loaded by
IdeA. A plugin ships an idea-plugin.json manifest plus an ESM entrypoint that
exports activate(ctx).
Start Here
- Manifest: required fields, capabilities and contribution ids.
- Activation And Context:
activate(ctx), lifecycle, logging, storage and subscriptions. - Menus: top-level menus, native menu insertion and command registration.
- Commands And Feedback: command return values, skipped work and background tasks.
- Layouts With React: React/JSX/hooks layout authoring with host-provided React.
- Windows: opening plugin layouts in detached OS windows.
- Services: workspace, tasks, tooling, events, config, terminal and windows facades.
- Packaging And Distribution: build output, archive layout, hot reload and dependency rules.
- Codex Skills And IdeA Plugins: separate runtime install from Codex skill discovery.
The installable example lives in examples/hello-plugin.
It demonstrates a menu command, storage, background-task feedback, a React layout
component and services.windows.open(...).
Install
npm install
Build
npm run build
Validate The Example
npm run typecheck:examples
npm run package:hello-plugin
The example archive is written to:
examples/hello-plugin/build/hello-plugin-0.1.0.zip