@openrewrite/rewrite-remote

Overview

@openrewrite/rewrite-remote is a package designed to provide remote services for working with OpenRewrite. This package serves as a server-side module that exposes the capabilities of OpenRewrite remotely. Example:

sequenceDiagram
    participant Client as Java client
    participant Server as Language Specific Remote Server

    Client->>Server: Connect to server
    Server-->>Client: Acknowledge connection

    Client->>Server: Send command (e.g., hello)
    Server->>Server: Process command
    Server-->>Client: Send response (e.g., OK)

    Client->>Server: Send command (e.g., load-recipe)
    Server->>Server: Process command
    Server-->>Client: Send response (e.g., recipe loaded)

    Client->>Server: Send command (e.g., run-recipe-visitor)
    Server->>Server: Process command
    Server-->>Client: Send response (e.g., visitor result)

    Client->>Server: Disconnect
    Server-->>Client: Acknowledge disconnection

Installation

To install the package, use npm:

npm install @openrewrite/rewrite-remote

Usage

Building the project

One time build:

npm run build

Build when files change:

npm run dev

Starting the server run:

npm run start-server

Running the tests

npm run test