Interface TransformRule

Transform Rule - modifies code to fix issues or modernize patterns.

Transform rules are WRITE operations. They must be:

Idempotent: Running twice should be safe
Atomic: Either fully succeed or fully fail
Reversible: Should not cause data loss

interface TransformRule {
    category: string;
    description: string;
    id: string;
    name: string;
    tags?: string[];
    transform(context: TransformContext): Promise<TransformResult>;
}

Implemented by

Index

Properties

category description id name tags?

Methods

Properties

`Readonly`category

category: string

Rule category for grouping.

`Readonly`description

description: string

Rule description explaining what it does.

`Readonly`id

id: string

Unique rule identifier (scoped to plugin).

`Readonly`name

name: string

Human-readable rule name.

`Optional` `Readonly`tags

tags?: string[]

Tags for filtering and search.

Methods

transform

transform(context: TransformContext): Promise<TransformResult>
Transform a source file.
Parameters
- context: TransformContext
  Transform context with file, project, and API access
Returns Promise<TransformResult>
Promise resolving to transform result