@tooldeck/plugin-tools

Development tools for Tooldeck plugin projects.

This package is intended for plugin authors. It validates a plugin project, generates command input types from manifest.json, coordinates builds, prints diagnostics, and provides test helpers.

Install

pnpm add -D @tooldeck/plugin-tools

CLI

The package exposes tooldeck-plugin:

tooldeck-plugin generate
tooldeck-plugin generate types --manifest manifest.json --out src/generated/commands.ts
tooldeck-plugin check
tooldeck-plugin build --bundler vite
tooldeck-plugin check --built
tooldeck-plugin inspect

Recommended plugin package.json scripts:

{
  "scripts": {
    "generate": "tooldeck-plugin generate",
    "check": "tooldeck-plugin check",
    "build": "tooldeck-plugin build --bundler vite",
    "inspect": "tooldeck-plugin inspect"
  }
}

Commands

tooldeck-plugin generate generates project files. Today this defaults to command input types generated from manifest.json.

tooldeck-plugin check validates the plugin project structure, manifest, generated command types, and optionally the built runtime entry:

tooldeck-plugin check --manifest manifest.json --generated src/generated/commands.ts
tooldeck-plugin check --built

tooldeck-plugin build --bundler vite runs the supported build path for Node plugins. Only vite is supported in V1.2.

tooldeck-plugin inspect prints project diagnostics suitable for local debugging or issue reports.

Testing Helpers

The @tooldeck/plugin-tools/testing export provides helpers for testing plugin command handlers without launching the Tooldeck desktop app or CLI.

import { describe, expect, it } from "vitest";
import { createPluginTestHost } from "@tooldeck/plugin-tools/testing";

import plugin from "../src";

describe("plugin", () => {
  it("runs a command", async () => {
    const host = await createPluginTestHost(plugin);
    const result = await host.runCommand("hello.world", { text: "Tooldeck" });

    expect(result.status).toBe("success");

    await host.dispose();
  });
});

API Stability

The CLI commands and @tooldeck/plugin-tools/testing are the supported plugin-authoring surface for V1.2. Lower-level project inspection, build, and generation APIs are exported for Tooldeck's own packages and may change while the external plugin workflow is still settling.

Related Packages

• @tooldeck/sdk-node provides runtime SDK APIs used by plugin code.
• @tooldeck/vite-plugin provides the default Vite build integration.
• @tooldeck/create-plugin scaffolds a complete plugin project.