Back to Intellij Community

jps-bootstrap

platform/jps-bootstrap/README.md

2025.3-rc-21.9 KB
Original Source

jps-bootstrap

jps-bootstrap: a small utility that loads JPS project, compiles it, and runs any class from it.

It tries very hard to run your code that same way you'd run it from IDE's gutter.

Previous way of running build scripts

Locally: run *.gant from IDEA or via gant.xml

On buildserver: gant.xml

Downsides:

  • Supports only groovy code. We're tired of groovy.
  • Uses binary dependencies for JPS & Utils, which defies the monorepo approach and also creates duplicate classes in IDEA project
  • Hard to generate and process build output. On buildserver it's not easy to output something correctly, the output is intercepted and processed by both TeamCity code and ant

Running build scripts via jps-bootstrap

Locally

  • Run the CLASS_NAME from IDEA from the gutter ▶️ icon, or

  • Run any main class (written in Java/Kotlin) from the IntelliJ project from CLI via:

    shell
    ./jps-bootstrap.cmd PROJECT_HOME MODULE_NAME CLASS_NAME ARGS
    

    Where PROJECT_HOME is the path where the .idea folder is (either the ultimate or community root), the MODULE_NAME is the name of the JPS module that contains the class, and CLASS_NAME is the FQN of the class that contains the main() to run.

    Example:

    shell
    ./community/platform/jps-bootstrap/jps-bootstrap.sh . intellij.idea.ultimate.build DownloadLibrariesBuildTarget
    

Special wrappers could be written to make scripts easier, see e.g. build/downloadLibraries.cmd

On buildserver:

  • Separate build compiles jps-bootstrap (only when jps-bootstrap sources are changed)
  • jps-bootstrap is used to run Compile Inc (it compiles build scripts on the fly)
  • On any other build, jps-bootstrap uses already compiled classes from Compile Inc