Some additions to tags and override for set

zkaplan · zkaplan · commit 152fc2934d89 · 2021-01-29T10:39:05.000-05:00
diff --git a/src/main/java/com/hubspot/jinjava/doc/JinjavaDocFactory.java b/src/main/java/com/hubspot/jinjava/doc/JinjavaDocFactory.java
@@ -4,6 +4,7 @@
 import com.hubspot.jinjava.doc.annotations.JinjavaMetaValue;
 import com.hubspot.jinjava.doc.annotations.JinjavaParam;
 import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.doc.annotations.JinjavaVSCodeSnippet;
 import com.hubspot.jinjava.lib.exptest.ExpTest;
 import com.hubspot.jinjava.lib.filter.Filter;
 import com.hubspot.jinjava.lib.fn.ELFunctionDefinition;
@@ -293,6 +294,12 @@ private com.hubspot.jinjava.doc.annotations.JinjavaDoc getJinjavaDocAnnotation(
   }
 
   private String getTagSnippet(Tag tag) {
+    JinjavaVSCodeSnippet annotation = tag
+      .getClass()
+      .getAnnotation(JinjavaVSCodeSnippet.class);
+    if (annotation != null) {
+      return annotation.code();
+    }
     com.hubspot.jinjava.doc.annotations.JinjavaDoc docAnnotation = getJinjavaDocAnnotation(
       tag.getClass()
     );
diff --git a/src/main/java/com/hubspot/jinjava/doc/annotations/JinjavaVSCodeSnippet.java b/src/main/java/com/hubspot/jinjava/doc/annotations/JinjavaVSCodeSnippet.java
@@ -0,0 +1,16 @@
+package com.hubspot.jinjava.doc.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+public @interface JinjavaVSCodeSnippet {
+  String desc() default "";
+
+  String code();
+
+  String output() default "";
+}
diff --git a/src/main/java/com/hubspot/jinjava/lib/tag/ElseIfTag.java b/src/main/java/com/hubspot/jinjava/lib/tag/ElseIfTag.java
@@ -1,10 +1,21 @@
 package com.hubspot.jinjava.lib.tag;
 
 import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import com.hubspot.jinjava.tree.TagNode;
 
-@JinjavaDoc(value = "", hidden = true)
+@JinjavaDoc(
+  value = "",
+  params = {
+    @JinjavaParam(
+      value = "condition",
+      type = "conditional expression",
+      desc = "An expression that evaluates to either true or false"
+    )
+  },
+  hidden = true
+)
 public class ElseIfTag implements Tag {
   public static final String TAG_NAME = "elif";
 
diff --git a/src/main/java/com/hubspot/jinjava/lib/tag/IfTag.java b/src/main/java/com/hubspot/jinjava/lib/tag/IfTag.java
@@ -16,6 +16,7 @@
 package com.hubspot.jinjava.lib.tag;
 
 import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
 import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import com.hubspot.jinjava.interpret.OutputTooBigException;
@@ -30,6 +31,13 @@
 
 @JinjavaDoc(
   value = "Outputs inner content if expression evaluates to true, otherwise evaluates any elif blocks, finally outputting content of any else block present",
+  params = {
+    @JinjavaParam(
+      value = "condition",
+      type = "conditional expression",
+      desc = "An expression that evaluates to either true or false"
+    )
+  },
   snippets = {
     @JinjavaSnippet(
       code = "{% if condition %}\n" +
diff --git a/src/main/java/com/hubspot/jinjava/lib/tag/SetTag.java b/src/main/java/com/hubspot/jinjava/lib/tag/SetTag.java
@@ -18,6 +18,7 @@
 import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
 import com.hubspot.jinjava.doc.annotations.JinjavaParam;
 import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.doc.annotations.JinjavaVSCodeSnippet;
 import com.hubspot.jinjava.interpret.DeferredValue;
 import com.hubspot.jinjava.interpret.DeferredValueException;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
@@ -63,6 +64,7 @@
     )
   }
 )
+@JinjavaVSCodeSnippet(code = "{% set ${1:var} = ${2:expr} %}")
 public class SetTag implements Tag {
   public static final String TAG_NAME = "set";
 

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`import com.hubspot.jinjava.doc.annotations.JinjavaDoc;`
`19`	`19`	`import com.hubspot.jinjava.doc.annotations.JinjavaParam;`
`20`	`20`	`import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;`
	`21`	`+import com.hubspot.jinjava.doc.annotations.JinjavaVSCodeSnippet;`
`21`	`22`	`import com.hubspot.jinjava.interpret.DeferredValue;`
`22`	`23`	`import com.hubspot.jinjava.interpret.DeferredValueException;`
`23`	`24`	`import com.hubspot.jinjava.interpret.JinjavaInterpreter;`
`@@ -63,6 +64,7 @@`
`63`	`64`	`)`
`64`	`65`	`}`
`65`	`66`	`)`
	`67`	`+@JinjavaVSCodeSnippet(code = "{% set ${1:var} = ${2:expr} %}")`
`66`	`68`	`public class SetTag implements Tag {`
`67`	`69`	`public static final String TAG_NAME = "set";`
`68`	`70`