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

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(...).

For short project-scoped external tools, use ctx.services.workspace.execTool() with an explicit manifest permissions.workspaceExec allow rule. See Services and Manifest. The primitive is generic and does not expose a native Git/SCM API.

Menu commands that open or focus a plugin view return status: "opened" (including alreadyOpen: true) and remain UI-silent on success. Keep diagnostic views accessible when optional tools are missing, and use the structured skipped/failed feedback contract for genuinely impossible actions; see Commands And Feedback and Menus.

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
Description
No description provided
Readme 242 MiB
Languages
TypeScript 72%
JavaScript 28%