✨ feat: Add condition to JaspilerContract.Change

caoccao · Jun 30, 2023 · 58270e1 · 58270e1
1 parent 380334c
commit 58270e1
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/scripts/node/jaspiler/jaspiler.js b/scripts/node/jaspiler/jaspiler.js
@@ -236,7 +236,9 @@ function evaluateAnnotationAttribute(annotation, context, attributeName, default
 function getChangeInstructionByAnnotations(annotations, context) {
   if (annotations) {
     const annotation = annotations.find(annotation => annotation.annotationType.toString() == 'JaspilerContract.Change');
-    return evaluateAnnotationAttribute(annotation, context, 'instruction', undefined, undefined);
+    if (evaluateAnnotationAttribute(annotation, context, 'condition', true, false)) {
+      return evaluateAnnotationAttribute(annotation, context, 'instruction', undefined, undefined);
+    }
   }
   return undefined;
 }

diff --git a/scripts/node/tutorials/03_builtin_annotations.js b/scripts/node/tutorials/03_builtin_annotations.js
@@ -43,10 +43,15 @@ const result = jaspiler.transformSync(
       System.out.println(str); // This method is cleared.
     }
 
-    @JaspilerContract.Change(instruction = "options = { type: 'clear' }")
+    @JaspilerContract.Change(condition = "x == 1", instruction = "options = { type: 'clear' }")
     public int f(int x, int y) {
       return x + y; // This method is cleared.
     }
+
+    @JaspilerContract.Change(condition = "x == 2", instruction = "options = { type: 'clear' }")
+    public int g(int x, int y) {
+      return x + y; // This method is not cleared.
+    }
   }
 
   @JaspilerContract.Ignore

diff --git a/src/main/java/com/caoccao/jaspiler/JaspilerContract.java b/src/main/java/com/caoccao/jaspiler/JaspilerContract.java
@@ -58,6 +58,15 @@ public boolean isNoChange() {
      */
     @Retention(RetentionPolicy.SOURCE)
     public @interface Change {
+        /**
+         * Condition is a JavaScript expression / statement / statements that returns a boolean
+         * indicating whether certain condition is true or false.
+         *
+         * @return the condition string
+         * @since 0.1.0
+         */
+        String condition() default "";
+
         /**
          * Instruction is a JavaScript expression / statement / statements that returns anything
          * instructing the plugins how to make the changes.