Package net.neoforged.jst.api

Interface SourceTransformer

public interface SourceTransformer
Transformers are created through plugins, and handle source replacements.

Transformers will be given to picocli for option collection, so they can accept CLI parameters. It is strongly recommended that transformers prefix their options with the transformer name.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    afterRun(TransformContext context)
    Invoked after all source transformations are finished.
    default boolean
    beforeReplacement(FileEntry fileEntry, List<Replacement> replacements)
    Invoke after replacements are collected for a given file, but before they are applied.
    default void
    beforeRun(TransformContext context)
    Invoked before source files are visited for transformation.
    void
    visitFile(com.intellij.psi.PsiFile psiFile, Replacements replacements)
    Visit the given psiFile for transformation.

  • Method Details

    • beforeRun

      default void beforeRun(TransformContext context)
      Invoked before source files are visited for transformation.

      Can be used for loading data from CLI parameters.

      Parameters:
      context - the transform context

    • beforeReplacement

      default boolean beforeReplacement(FileEntry fileEntry, List<Replacement> replacements)
      Invoke after replacements are collected for a given file, but before they are applied.

      Can be used to react to or verify the replacements that were collected.

      Parameters:
      fileEntry - the file entry being transformed
      replacements - the replacements that were collected; read-only
      Returns:
      true if the transformation should continue, false if it should fail

    • afterRun

      default boolean afterRun(TransformContext context)
      Invoked after all source transformations are finished.

      Can be used for post-transformation validation.

      Parameters:
      context - the transform context
      Returns:
      true if the transformation was successful, false if it failed

    • visitFile

      void visitFile(com.intellij.psi.PsiFile psiFile, Replacements replacements)
      Visit the given psiFile for transformation.
      Parameters:
      psiFile - the file being transformed
      replacements - the replacement collector, used to replace the value of psi tree elements