@macroforge/mcp-server 0.1.42 → 0.1.50

package/docs/getting-started/first-macro.md

@@ -1,141 +1,168 @@
 # Your First Macro
- *Let's create a class that uses Macroforge's derive macros to automatically generate useful methods.*
- ## Creating a Class with Derive Macros
- Start by creating a simple <code class="shiki-inline"><span class="line"><span style="--shiki-dark:#E1E4E8;--shiki-light:#24292E">User</code> class. We'll use the <code class="shiki-inline"><span class="line"><span style="--shiki-dark:#E1E4E8;--shiki-light:#24292E">@derive</code> decorator to automatically generate methods.
- <div><div class="flex items-center justify-between gap-2 px-4 py-2 bg-muted rounded-t-lg border border-b-0 border-border"> 
-**Before:**
+
+Let's create a class that uses Macroforge's derive macros to automatically generate useful methods.
+
+## Creating a Class with Derive Macros
+
+Start by creating a simple `User` class. We'll use the `@derive` decorator to automatically generate methods.
+
+Before (Your Code)
+
 ```
 /** @derive(Debug, Clone, PartialEq) */
-export class User &#123;
+export class User {
     name: string;
     age: number;
     email: string;
 
-    constructor(name: string, age: number, email: string) &#123;
+    constructor(name: string, age: number, email: string) {
         this.name = name;
         this.age = age;
         this.email = email;
-    &#125;
-&#125;
-``` <div class="flex items-center justify-between gap-2 px-4 py-2 bg-muted rounded-t-lg border border-b-0 border-border"> 
-**After:**
+    }
+}
+```
+
+After (Generated)
+
 ```
-export class User &#123;
+export class User {
     name: string;
     age: number;
     email: string;
 
-    constructor(name: string, age: number, email: string) &#123;
+    constructor(name: string, age: number, email: string) {
         this.name = name;
         this.age = age;
         this.email = email;
-    &#125;
+    }
 
-    static toString(value: User): string &#123;
+    static toString(value: User): string {
         return userToString(value);
-    &#125;
+    }
 
-    static clone(value: User): User &#123;
+    static clone(value: User): User {
         return userClone(value);
-    &#125;
+    }
 
-    static equals(a: User, b: User): boolean &#123;
+    static equals(a: User, b: User): boolean {
         return userEquals(a, b);
-    &#125;
-&#125;
+    }
+}
 
-export function userToString(value: User): string &#123;
+export function userToString(value: User): string {
     const parts: string[] = [];
     parts.push('name: ' + value.name);
     parts.push('age: ' + value.age);
     parts.push('email: ' + value.email);
-    return 'User &#123; ' + parts.join(', ') + ' &#125;';
-&#125;
+    return 'User { ' + parts.join(', ') + ' }';
+}
 
-export function userClone(value: User): User &#123;
+export function userClone(value: User): User {
     const cloned = Object.create(Object.getPrototypeOf(value));
     cloned.name = value.name;
     cloned.age = value.age;
     cloned.email = value.email;
     return cloned;
-&#125;
+}
 
-export function userEquals(a: User, b: User): boolean &#123;
+export function userEquals(a: User, b: User): boolean {
     if (a === b) return true;
-    return a.name === b.name &#x26;&#x26; a.age === b.age &#x26;&#x26; a.email === b.email;
-&#125;
-``` ## Using the Generated Methods
- ```
-const&nbsp;user&nbsp;=&nbsp;new&nbsp;User("Alice",&nbsp;30,&nbsp;"alice@example.com");
+    return a.name === b.name && a.age === b.age && a.email === b.email;
+}
+```
+
+## Using the Generated Methods
 
-//&nbsp;Debug:&nbsp;toString()
+TypeScript
+
+```
+const user = new User("Alice", 30, "alice@example.com");
+
+// Debug: toString()
 console.log(user.toString());
-//&nbsp;Output:&nbsp;User&nbsp;&#123;&nbsp;name:&nbsp;Alice,&nbsp;age:&nbsp;30,&nbsp;email:&nbsp;alice@example.com&nbsp;&#125;
+// Output: User { name: Alice, age: 30, email: alice@example.com }
+
+// Clone: clone()
+const copy = user.clone();
+console.log(copy.name); // "Alice"
+
+// Eq: equals()
+console.log(user.equals(copy)); // true
 
-//&nbsp;Clone:&nbsp;clone()
-const&nbsp;copy&nbsp;=&nbsp;user.clone();
-console.log(copy.name);&nbsp;//&nbsp;"Alice"
+const different = new User("Bob", 25, "bob@example.com");
+console.log(user.equals(different)); // false
+```
+
+## Customizing Behavior
 
-//&nbsp;Eq:&nbsp;equals()
-console.log(user.equals(copy));&nbsp;//&nbsp;true
+You can customize how macros work using field-level decorators. For example, with the Debug macro:
+
+Before (Your Code)
 
-const&nbsp;different&nbsp;=&nbsp;new&nbsp;User("Bob",&nbsp;25,&nbsp;"bob@example.com");
-console.log(user.equals(different));&nbsp;//&nbsp;false
-``` ## Customizing Behavior
- You can customize how macros work using field-level decorators. For example, with the Debug macro:
- <div><div class="flex items-center justify-between gap-2 px-4 py-2 bg-muted rounded-t-lg border border-b-0 border-border"> 
-**Before:**
 ```
 /** @derive(Debug) */
-export class User &#123;
-    /** @debug(&#123; rename: "userId" &#125;) */
+export class User {
+    /** @debug({ rename: "userId" }) */
     id: number;
 
     name: string;
 
-    /** @debug(&#123; skip: true &#125;) */
+    /** @debug({ skip: true }) */
     password: string;
 
-    constructor(id: number, name: string, password: string) &#123;
+    constructor(id: number, name: string, password: string) {
         this.id = id;
         this.name = name;
         this.password = password;
-    &#125;
-&#125;
-``` <div class="flex items-center justify-between gap-2 px-4 py-2 bg-muted rounded-t-lg border border-b-0 border-border"> 
-**After:**
+    }
+}
+```
+
+After (Generated)
+
 ```
-export class User &#123;
+export class User {
     id: number;
 
     name: string;
 
     password: string;
 
-    constructor(id: number, name: string, password: string) &#123;
+    constructor(id: number, name: string, password: string) {
         this.id = id;
         this.name = name;
         this.password = password;
-    &#125;
+    }
 
-    static toString(value: User): string &#123;
+    static toString(value: User): string {
         return userToString(value);
-    &#125;
-&#125;
+    }
+}
 
-export function userToString(value: User): string &#123;
+export function userToString(value: User): string {
     const parts: string[] = [];
     parts.push('userId: ' + value.id);
     parts.push('name: ' + value.name);
-    return 'User &#123; ' + parts.join(', ') + ' &#125;';
-&#125;
-``` ```
-const&nbsp;user&nbsp;=&nbsp;new&nbsp;User(42,&nbsp;"Alice",&nbsp;"secret123");
+    return 'User { ' + parts.join(', ') + ' }';
+}
+```
+
+TypeScript
+
+```
+const user = new User(42, "Alice", "secret123");
 console.log(user.toString());
-//&nbsp;Output:&nbsp;User&nbsp;&#123;&nbsp;userId:&nbsp;42,&nbsp;name:&nbsp;Alice&nbsp;&#125;
-//&nbsp;Note:&nbsp;'id'&nbsp;is&nbsp;renamed&nbsp;to&nbsp;'userId',&nbsp;'password'&nbsp;is&nbsp;skipped
-```  **Field-level decorators Field-level decorators let you control exactly how each field is handled by the macro. ## Next Steps
- - [Learn how macros work under the hood](../../docs/concepts)
- - [Explore all Debug options](../../docs/builtin-macros/debug)
- - [Create your own custom macros](../../docs/custom-macros)
-**
+// Output: User { userId: 42, name: Alice }
+// Note: 'id' is renamed to 'userId', 'password' is skipped
+```
+
+Field-level decorators
+
+Field-level decorators let you control exactly how each field is handled by the macro.
+
+## Next Steps
+
+*   [Learn how macros work under the hood](../../docs/concepts)
+*   [Explore all Debug options](../../docs/builtin-macros/debug)
+*   [Create your own custom macros](../../docs/custom-macros)

package/docs/getting-started/installation.md

@@ -1,66 +1,110 @@
 # Installation
- *Get started with Macroforge in just a few minutes. Install the package and configure your project to start using TypeScript macros.*
- ## Requirements
- - Node.js 24.0 or later
- - TypeScript 5.9 or later
- ## Install the Package
- Install Macroforge using your preferred package manager:
- ```
-npm install macroforge
-``` ```
-bun add macroforge
-``` ```
-pnpm add macroforge
-```  **Info Macroforge includes pre-built native binaries for macOS (x64, arm64), Linux (x64, arm64), and Windows (x64, arm64). ## Basic Usage
- The simplest way to use Macroforge is with the built-in derive macros. Add a **<code class="shiki-inline"><span class="line"><span style="--shiki-dark:#E1E4E8;--shiki-light:#24292E">@derive</code> comment decorator to your class:
- ```
-/**&nbsp;@derive(Debug,&nbsp;Clone,&nbsp;PartialEq)&nbsp;*/
-class&nbsp;User&nbsp;&#123;
-&nbsp;&nbsp;name:&nbsp;string;
-&nbsp;&nbsp;age:&nbsp;number;
-
-&nbsp;&nbsp;constructor(name:&nbsp;string,&nbsp;age:&nbsp;number)&nbsp;&#123;
-&nbsp;&nbsp;&nbsp;&nbsp;this.name&nbsp;=&nbsp;name;
-&nbsp;&nbsp;&nbsp;&nbsp;this.age&nbsp;=&nbsp;age;
-&nbsp;&nbsp;&#125;
-&#125;
-
-//&nbsp;After&nbsp;macro&nbsp;expansion,&nbsp;User&nbsp;has:
-//&nbsp;-&nbsp;toString():&nbsp;string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(from&nbsp;Debug)
-//&nbsp;-&nbsp;clone():&nbsp;User&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(from&nbsp;Clone)
-//&nbsp;-&nbsp;equals(other:&nbsp;unknown):&nbsp;boolean&nbsp;(from&nbsp;PartialEq)
-``` ## IDE Integration
- For the best development experience, add the TypeScript plugin to your <code class="shiki-inline"><span class="line"><span style="--shiki-dark:#E1E4E8;--shiki-light:#24292E">tsconfig.json</code>:
- ```
-&#123;
-&nbsp;&nbsp;"compilerOptions":&nbsp;&#123;
-&nbsp;&nbsp;&nbsp;&nbsp;"plugins":&nbsp;[
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#123;
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"@macroforge/typescript-plugin"
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#125;
-&nbsp;&nbsp;&nbsp;&nbsp;]
-&nbsp;&nbsp;&#125;
-&#125;
-``` This enables features like:
- - Accurate error positions in your source code
- - Autocompletion for generated methods
- - Type checking for expanded code
- ## Build Integration (Vite)
- If you're using Vite, add the plugin to your config for automatic macro expansion during build:
- ```
-import&nbsp;macroforge&nbsp;from&nbsp;"@macroforge/vite-plugin";
-import&nbsp;&#123;&nbsp;defineConfig&nbsp;&#125;&nbsp;from&nbsp;"vite";
-
-export&nbsp;default&nbsp;defineConfig(&#123;
-&nbsp;&nbsp;plugins:&nbsp;[
-&nbsp;&nbsp;&nbsp;&nbsp;macroforge(&#123;
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;generateTypes:&nbsp;true,
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;typesOutputDir:&nbsp;".macroforge/types"
-&nbsp;&nbsp;&nbsp;&nbsp;&#125;)
-&nbsp;&nbsp;]
-&#125;);
-``` ## Next Steps
- Now that you have Macroforge installed, learn how to use it:
- - [Create your first macro](../docs/getting-started/first-macro)
- - [Understand how macros work](../docs/concepts)
- - [Explore built-in macros](../docs/builtin-macros)
+
+Get started with Macroforge in just a few minutes. Install the package and configure your project to start using TypeScript macros.
+
+## Requirements
+
+*   Node.js 24.0 or later
+*   TypeScript 5.9 or later
+
+## Install the Package
+
+Install Macroforge using your preferred package manager:
+
+npm 
+
+```
+npm install macroforge
+```
+
+bun 
+
+```
+bun add macroforge
+```
+
+pnpm 
+
+```
+pnpm add macroforge
+```
+
+Info
+
+Macroforge includes pre-built native binaries for macOS (x64, arm64), Linux (x64, arm64), and Windows (x64, arm64).
+
+## Basic Usage
+
+The simplest way to use Macroforge is with the built-in derive macros. Add a `@derive` comment decorator to your class:
+
+user.ts 
+
+```
+/** @derive(Debug, Clone, PartialEq) */
+class User {
+  name: string;
+  age: number;
+
+  constructor(name: string, age: number) {
+    this.name = name;
+    this.age = age;
+  }
+}
+
+// After macro expansion, User has:
+// - toString(): string              (from Debug)
+// - clone(): User                   (from Clone)
+// - equals(other: unknown): boolean (from PartialEq)
+```
+
+## IDE Integration
+
+For the best development experience, add the TypeScript plugin to your `tsconfig.json`:
+
+tsconfig.json 
+
+```
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@macroforge/typescript-plugin"
+      }
+    ]
+  }
+}
+```
+
+This enables features like:
+
+*   Accurate error positions in your source code
+*   Autocompletion for generated methods
+*   Type checking for expanded code
+
+## Build Integration (Vite)
+
+If you're using Vite, add the plugin to your config for automatic macro expansion during build:
+
+vite.config.ts 
+
+```
+import macroforge from "@macroforge/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  plugins: [
+    macroforge({
+      generateTypes: true,
+      typesOutputDir: ".macroforge/types"
+    })
+  ]
+});
+```
+
+## Next Steps
+
+Now that you have Macroforge installed, learn how to use it:
+
+*   [Create your first macro](../docs/getting-started/first-macro)
+*   [Understand how macros work](../docs/concepts)
+*   [Explore built-in macros](../docs/builtin-macros)