Plugin API Reference

interface {
  readonly name: string;    // npm package name
  readonly version: string; // npm package version
}

const disposable = api.commands.registerCommand(
  'myPlugin.doSomething',
  async (...args: unknown[]) => {
    // Handle command
    return result;
  }
);

const result = await api.commands.executeCommand<MyResult>(
  'otherPlugin.command',
  arg1,
  arg2
);

const script = `
  (function() {
    console.log('Injected script running!');
    // Modify the page, add event listeners, etc.
  })();
`;

const disposable = api.webview.registerPreloadScript(script);

const disposable = api.terminal.registerCommand('greet', async (ctx) => {
  const { args, cwd, terminalId, write } = ctx;

  // Write to terminal (supports ANSI escape codes)
  write('\x1b[32m'); // Green color
  write('Hello!\r\n');
  write('\x1b[0m');  // Reset color

  write(`Arguments: ${args.join(', ')}\r\n`);
  write(`Working directory: ${cwd}\r\n`);
});

const terminalId = await api.terminal.createTerminal({
  name: 'My Terminal',
  cwd: '/path/to/directory'
});

const disposable = api.editor.registerCompletionProvider(
  ['typescript', 'javascript', 'typescriptreact', 'javascriptreact'],
  {
    triggerCharacters: ['.', '('],

    provideCompletions(ctx) {
      // ctx.linePrefix - text before cursor
      // ctx.lineText - full line text
      // ctx.lineNumber - 1-indexed line number
      // ctx.column - 1-indexed column
      // ctx.filePath - file path
      // ctx.triggerCharacter - character that triggered completion

      if (!ctx.linePrefix.endsWith('myLib.')) {
        return [];
      }

      return [
        {
          label: 'myFunction',
          insertText: 'myFunction($1)',
          detail: 'My custom function',
          documentation: 'Does something useful',
          kind: 'function',
        },
      ];
    },
  }
);

const statusItem = api.statusBar.createItem({
  id: 'my-status',
  text: 'My Plugin',
  tooltip: 'Click for more info',
  color: '#00ff00',
  alignment: 'right', // 'left' or 'right'
  priority: 100,      // higher = more to the left
});

// Update the item
statusItem.update({
  text: 'Updated Text',
  color: '#ff0000',
});

// Remove when done
statusItem.dispose();

const disposable = api.fileDecorations.registerProvider({
  provideDecoration(filePath) {
    if (filePath.endsWith('.test.ts')) {
      return {
        badge: 'T',
        badgeColor: '#00ff00',
        tooltip: 'Test file',
      };
    }

    if (filePath.includes('/deprecated/')) {
      return {
        faded: true,
        color: '#888888',
        tooltip: 'Deprecated',
      };
    }

    return undefined; // No decoration
  },
});

const disposable = api.contextMenu.registerItem(
  {
    id: 'my-action',
    label: 'Do Something',
    context: 'both', // 'editor' | 'fileTree' | 'both'
    shortcutHint: 'Ctrl+Shift+D', // Optional hint shown in menu
  },
  async (ctx) => {
    // ctx.filePath - file path if in file tree
    // ctx.selection - selected text if in editor
    api.log.info(`Action triggered for: ${ctx.filePath || ctx.selection}`);
  }
);

const disposable = api.keybindings.register({
  key: 'ctrl+shift+m',  // Key combination
  command: 'myPlugin.myCommand', // Command to execute
  when: 'global', // 'editor' | 'terminal' | 'global'
});

const disposable = api.settings.registerSchema({
  title: 'My Plugin Settings',
  description: 'Configure My Plugin behavior',
  fields: [
    {
      key: 'enabled',
      label: 'Enable Feature',
      type: 'boolean',
      default: true,
      description: 'Enable or disable the main feature',
    },
    {
      key: 'mode',
      label: 'Operation Mode',
      type: 'select',
      default: 'auto',
      options: [
        { label: 'Automatic', value: 'auto' },
        { label: 'Manual', value: 'manual' },
        { label: 'Disabled', value: 'disabled' },
      ],
      description: 'How the plugin should operate',
    },
    {
      key: 'delay',
      label: 'Delay (ms)',
      type: 'number',
      default: 1000,
      min: 100,
      max: 5000,
      step: 100,
      description: 'Delay in milliseconds',
    },
    {
      key: 'username',
      label: 'Username',
      type: 'string',
      default: '',
      description: 'Your username for the service',
    },
    {
      key: 'highlightColor',
      label: 'Highlight Color',
      type: 'color',
      default: '#ff0000',
      description: 'Color used for highlights',
    },
  ],
});