Skip to main content

How to set up and use JavaScript LSTs with the Moderne CLI

Moderne recently announced support for JavaScript and TypeScript LSTs. With this, JavaScript refactoring changes from being syntax-bound to semantically-aware – where recipes can distinguish between lookalike methods, resolve types, and understand dependency graphs.

In this guide, we'll walk you through how to configure the Moderne CLI to take advantage of this new JavaScript functionality.

Prerequisites​

This guide assumes that:

Step 1: Update your moderne.yml file​

In order to enable JavaScript support, you will need to update the build steps in your moderne.yml file to include JavaScript. This file is located at ~/.moderne/cli/moderne.yml and is created when you first set up the CLI.

If your moderne.yml file already includes a build section, you can just add the -type: javascript line to the end of your build steps. If it doesn't, you will need to add the entire section as seen in the example below:

moderne.yml
# Other keys and values...
license:
  key: some-license
tenant:
  host: https://app.moderne.io
  apiHost: https://api.app.moderne.io
  skipSsl: false
  authorization: Bearer mat-some-token
build:
  steps:
    - type: maven
    - type: gradle
    - type: bazel
    - type: javascript

Step 2: (Optionally) Clone a custom list of repositories​

If you don't have the repositories you want to work with cloned locally already, you can clone a group of them by defining a repos.csv file that lists them out such as in the following example:

repos.csv
cloneUrl,branch,origin,path
git@github.com:form-data/form-data.git,master,github.com,form-data/form-data
git@github.com:antoniopresto/react-native-local-mongodb.git,master,github.com,antoniopresto/react-native-local-mongodb
git@github.com:microsoft/android-app-size-diff.git,main,github.com,microsoft/android-app-size-diff
git@github.com:github0null/eide.git,master,github.com,github0null/eide
git@github.com:simoebenhida/laravel-intellisense.git,master,github.com,simoebenhida/laravel-intellisense
git@github.com:RechInformatica/rech-editor-cobol.git,master,github.com,RechInformatica/rech-editor-cobol
git@github.com:microsoftgraph/msgraph-ifttt-sample.git,master,github.com,microsoftgraph/msgraph-ifttt-sample
git@github.com:Zoro-6191/discOD.git,master,github.com,Zoro-6191/discOD
tip

Check out our documentation on creating a repos.csv file for more detailed information about what's expected in this file.

After creating the CSV, clone the repositories by running the following command:

mod git sync csv . repos.csv --with-sources

Step 3: Build your JavaScript repositories​

The next thing you'll need to do is build LSTs for each of your repositories. To build the LSTs, run:

mod build /path/to/your/repos

Presuming everything has been set up correctly, you should see output similar to:

▶ axios/axios@v1.x
    Build output will be written to build.log
    > Step 1 - build with JavaScript
        Selected Node 22.9.0
        Starting parsing of 169 files
    ✓ Built axios-20251010075558262-ast.jar
    Cleaned 1 older builds

Step 4: Install recipes​

In order to run recipes, you'll need to make sure the recipes are installed on your local machine.

You can install a specific JavaScript recipe module by running a command like:

mod config recipes npm install @openrewrite/recipes-nodejs

Step 5: Run recipes​

With the LSTs built and recipes installed, you can now run recipes against your JavaScript repositories. You can either specify the full recipe path for running such as in:

mod run . --recipe=org.openrewrite.node.migrate.util.use-native-type-checking-methods

Or, you can search for a specific recipe and set it as the active recipe to run:

➜ mod config recipes search util.isX

Replace deprecated `util.isX()` methods with native JavaScript
The `util` module's type-checking methods have been removed in Node 22.

Options
 -

Set as active recipe [Yn]? Y

Then you can run the active recipe by:

mod run . --active-recipe
tip

While the JavaScript recipe library is being built out, keep in mind that some Java recipes can be used to run against your JavaScript code. Below are some examples of Java recipes that work well with JavaScript repositories:

# Find all method calls to React hooks
mod run . --recipe org.openrewrite.java.search.FindMethods -PmethodPattern="React use*(..)"

# Find all React.CSSProperties components
mod run . --recipe org.openrewrite.java.search.FindTypes -PfullyQualifiedTypeName="React.CSSProperties"

# Change a method name to something else
mod run . --recipe org.openrewrite.java.ChangeMethodName -PmethodPattern="* test(..)" -PnewMethodName="customTest"

Step 6: View data tables​

Many recipes will also produce useful data tables that you can access via the mod study command such as in:

➜ mod study . --last-recipe-run --data-table MethodCalls

Moderne CLI 3.53.1

⏺ Reading organization

Found 1 organization containing 1 repository (1s)
Found recipe run 20251010101104-iWJXs

⏺ Building CSV output for each organization

▶ Popular JavaScript
    ✓ Data table produced
Done (1s)

⏺ Converting to Excel for each organization

▶ Popular JavaScript
    ✓ Added 5427 rows
    ✓ Data table produced
Done (9s)

Data tables for each organization with rows are linked above