Implement hints for function and command parameters

Author: APickledWalrus

src/main/java/ch/njol/skript/command/Argument.java

@@ -130,6 +130,10 @@ public void set(final ScriptCommandEvent e, final Object[] o) {
 	public T[] getCurrent(final Event e) {
 		return current.get(e);
 	}
+
+	public @Nullable String getName() {
+		return name;
+	}
 
 	public Class<T> getType() {
 		return type.getC();

src/main/java/ch/njol/skript/command/ScriptCommand.java

@@ -8,7 +8,9 @@
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.SkriptParser;
 import ch.njol.skript.lang.Trigger;
+import ch.njol.skript.lang.Variable;
 import ch.njol.skript.lang.VariableString;
+import ch.njol.skript.lang.parser.ParserInstance;
 import ch.njol.skript.lang.util.SimpleEvent;
 import ch.njol.skript.lang.util.SimpleLiteral;
 import ch.njol.skript.localization.Language;
@@ -23,6 +25,7 @@
 import ch.njol.skript.util.Utils;
 import ch.njol.skript.util.chat.BungeeConverter;
 import ch.njol.skript.util.chat.MessageComponent;
+import ch.njol.skript.variables.HintManager;
 import ch.njol.skript.variables.Variables;
 import ch.njol.util.StringUtils;
 import com.google.common.base.Preconditions;
@@ -204,8 +207,21 @@ public ScriptCommand(
 		this.pattern = pattern;
 		this.arguments = arguments;
 
-		trigger = new Trigger(script, "command /" + name, new SimpleEvent(), ScriptLoader.loadItems(node));
-		trigger.setLineNumber(node.getLine());
+		HintManager hintManager = ParserInstance.get().getHintManager();
+		try {
+			hintManager.enterScope();
+			for (Argument<?> argument : arguments) {
+				String hintName = argument.getName();
+				if (!argument.isSingle()) {
+					hintName += Variable.SEPARATOR + "*";
+				}
+				hintManager.set(hintName, argument.getType());
+			}
+			trigger = new Trigger(script, "command /" + name, new SimpleEvent(), ScriptLoader.loadItems(node));
+			trigger.setLineNumber(node.getLine());
+		} finally {
+			hintManager.exitScope();
+		}
 
 		bukkitCommand = setupBukkitCommand();
 	}

src/main/java/ch/njol/skript/lang/function/ScriptFunction.java

@@ -5,7 +5,10 @@
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ReturnHandler;
 import ch.njol.skript.lang.Trigger;
+import ch.njol.skript.lang.Variable;
+import ch.njol.skript.lang.parser.ParserInstance;
 import ch.njol.skript.lang.util.SimpleEvent;
+import ch.njol.skript.variables.HintManager;
 import ch.njol.skript.variables.Variables;
 import org.bukkit.event.Event;
 import org.jetbrains.annotations.ApiStatus;
@@ -31,9 +34,19 @@ public ScriptFunction(Signature<T> sign, SectionNode node) {
 		super(sign);
 
 		Functions.currentFunction = this;
+		HintManager hintManager = ParserInstance.get().getHintManager();
 		try {
+			hintManager.enterScope();
+			for (Parameter<?> parameter : sign.getParameters()) {
+				String hintName = parameter.getName();
+				if (!parameter.isSingleValue()) {
+					hintName += Variable.SEPARATOR + "*";
+				}
+				hintManager.set(hintName, parameter.getType().getC());
+			}
 			trigger = loadReturnableTrigger(node, "function " + sign.getName(), new SimpleEvent());
 		} finally {
+			hintManager.exitScope();
 			Functions.currentFunction = null;
 		}
 		trigger.setLineNumber(node.getLine());

src/test/skript/tests/syntaxes/structures/StructCommand.sk

@@ -1,7 +1,3 @@
-test "commands":
-	execute command "skriptcommand taco"
-	execute command "//somecommand burrito is tasty"
-
 options:
 	command: skriptcommand
 
@@ -24,3 +20,26 @@ command //somecommand [<text>]:
 command /commandtest <string="player">:
 	trigger:
 		stop
+
+test "commands":
+	execute command "skriptcommand taco"
+	execute command "//somecommand burrito is tasty"
+
+parse:
+	results: {StructCommand::hints::1::*}
+	code:
+		command /hint_test_1 <x:number>:
+			trigger:
+				set {_a} to {_x} in lowercase
+
+parse:
+	results: {StructCommand::hints::2::*}
+	code:
+		command /hint_test_2 <x:numbers>:
+			trigger:
+				set {_a::*} to {_x::*} in lowercase
+
+test "command structure type hints":
+	assert {StructCommand::hints::1::*} contains "Expected variable '{_x}' to be a text, but it is a number" with "Hint failed (%{StructCommand::hints::1::*}%)"
+	assert {StructCommand::hints::2::*} contains "Expected variable '{_x::*}' to be a text, but it is a number" with "Hint failed (%{StructCommand::hints::2::*}%)"
+

src/test/skript/tests/syntaxes/structures/StructFunction.sk

@@ -17,3 +17,19 @@ test "functions":
 	assert foo() is true with "function return type failed"
 	assert local() is not 1 with "global function parsed before local function"
 	assert bar() is true with "local function didn't execute correctly"
+
+parse:
+	results: {StructFunction::hints::1::*}
+	code:
+		function hint_test_1(x: number):
+			set {_a} to {_x} in lowercase
+
+parse:
+	results: {StructFunction::hints::2::*}
+	code:
+		function hint_test_2(x: numbers):
+			set {_a::*} to {_x::*} in lowercase
+
+test "function structure type hints":
+	assert {StructFunction::hints::1::*} contains "Expected variable '{_x}' to be a text, but it is a number" with "Hint failed (%{StructFunction::hints::1::*}%)"
+	assert {StructFunction::hints::2::*} contains "Expected variable '{_x::*}' to be a text, but it is a number" with "Hint failed (%{StructFunction::hints::2::*}%)"