Interface TransformRule

Transformation rule as seen by the TransformationCoordinator.

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

Index

Properties

category? description id name

Methods

Properties

`Optional` `Readonly`category

category?: string

Optional grouping category.

`Readonly`description

description: string

Short description of what the rule changes.

`Readonly`id

id: string

Unique rule identifier.

`Readonly`name

name: string

Human-readable rule name.

Methods

transform

transform(context: TransformContext): Promise<TransformResult>
Applies the rule to context.sourceFile.
Parameters
- context: TransformContext
  File, project and options for this run
Returns Promise<TransformResult>
The rule's result