TypeScript Plugin

The TypeScript plugin provides IDE integration for Macroforge, including error reporting, completions, and type checking for generated code.

Installation

Bash

npm install -D @macroforge/typescript-plugin

Add the plugin to your tsconfig.json:

tsconfig.json

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "@macroforge/typescript-plugin"
      }
    ]
  }
}

VS Code uses its own TypeScript version by default. To use the workspace version (which includes plugins):

Tip

Add this setting to your .vscode/settings.json to make it permanent:

.vscode/settings.json

{
  "typescript.tsdk": "node_modules/typescript/lib"
}

Errors in macro-generated code are reported at the @derive decorator position:

TypeScript

/** @derive(Debug) */  // <- Errors appear here
class User {
  name: string;
}

The plugin provides completions for generated methods:

TypeScript

const user = new User("Alice");
user.to  // Suggests: toString(), toJSON(), etc.

Hover over generated methods to see their types:

TypeScript

// Hover over 'clone' shows:
// (method) User.clone(): User
const copy = user.clone();

Ensure you're using the workspace TypeScript version
Restart the TypeScript server (Command Palette → "TypeScript: Restart TS Server")
Check that the plugin is listed in tsconfig.json

If errors from macros aren't appearing: