Package io.codemodder

Annotation Interface Codemod

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface Codemod
Used to mark types providing codemod functionality and provide the necessary metadata.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    id
    The codemod ID, which must follow this nomenclature:
    ReviewGuidance
    reviewGuidance
    The review guidance for the changes introduced by this codemod

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    CodemodExecutionPriority
    executionPriority
    How important it is that this codemod execute sooner in the list of codemods being run.

  • Element Details

    • id

      String id
      The codemod ID, which must follow this nomenclature:

      [vendor]:[language]/[unique identifier]

      Some examples:

      • pixee:java/secure-random
      • codeql:java/xss

    • reviewGuidance

      ReviewGuidance reviewGuidance
      The review guidance for the changes introduced by this codemod
      Returns:
      review guidance

    • executionPriority

      CodemodExecutionPriority executionPriority
      How important it is that this codemod execute sooner in the list of codemods being run.
      Default:
      NORMAL