Angular Modernizer
    Preparing search index...

    Interface Plugin

    Core plugin interface. Every plugin must implement this interface to integrate with the platform.

    A plugin only groups rules. The rules get their capabilities through the context objects (AnalysisContext, TransformContext, ValidationContext), which carry the public API.

    interface Plugin {
        author?: string;
        description?: string;
        name: string;
        version: string;
        getAnalysisRules(): AnalysisRule[];
        getTransformRules(): TransformRule[];
        getValidationRules(): ValidationRule[];
        initialize(kernel: IKernel): Promise<void>;
    }

    Implemented by

    Index

    Properties

    author? description? name version

    Methods

    getAnalysisRules getTransformRules getValidationRules initialize

    Properties

    author?: string

    Plugin author information.

    description?: string

    Plugin description for documentation and tooling.

    name: string

    Unique plugin identifier. Must be unique across all plugins in the system.

    version: string

    Plugin version (semantic versioning recommended).

    Methods

    • Get all analysis rules provided by this plugin. Analysis rules examine code and report violations/insights.

      Returns AnalysisRule[]

      Array of analysis rules

    • Get all transformation rules provided by this plugin. Transformation rules modify code to fix violations or modernize patterns.

      Returns TransformRule[]

      Array of transformation rules

    • Get all validation rules provided by this plugin. Validation rules verify that transformations were successful.

      Returns ValidationRule[]

      Array of validation rules

    • Initialize the plugin. Called once during Kernel initialization.

      Parameters

      • kernel: IKernel

        The Kernel instance for accessing infrastructure

      Returns Promise<void>

      Error if initialization fails

    Settings

    Member Visibility

    On This Page

    Properties
    Methods