From a8eacf4df13c5fccf9028f1a505cc38408618af3 Mon Sep 17 00:00:00 2001
From: Timi007 <timi007gp@gmail.com>
Date: Thu, 6 Feb 2025 15:42:48 +0100
Subject: [PATCH] Tools - Add function header snippet (#10682)

Co-authored-by: PabstMirror <pabstmirror@gmail.com>
---
 .gitignore                               |  1 -
 {tools/.vscode => .vscode}/settings.json |  0
 .vscode/sqf.code-snippets                | 40 ++++++++++++++++++++++++
 {tools/.vscode => .vscode}/tasks.json    |  1 -
 4 files changed, 40 insertions(+), 2 deletions(-)
 rename {tools/.vscode => .vscode}/settings.json (100%)
 create mode 100644 .vscode/sqf.code-snippets
 rename {tools/.vscode => .vscode}/tasks.json (99%)

diff --git a/.gitignore b/.gitignore
index 15cc59d0d5a..92aed11daa5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,7 +2,6 @@
 *.zip
 release/*
 releases/*
-.vscode/*
 hemtt
 hemtt.exe
 .hemttout
diff --git a/tools/.vscode/settings.json b/.vscode/settings.json
similarity index 100%
rename from tools/.vscode/settings.json
rename to .vscode/settings.json
diff --git a/.vscode/sqf.code-snippets b/.vscode/sqf.code-snippets
new file mode 100644
index 00000000000..ef1d10ede99
--- /dev/null
+++ b/.vscode/sqf.code-snippets
@@ -0,0 +1,40 @@
+{
+    "SQF Function Header": {
+        "description": "SQF function header",
+        "prefix": "header",
+        "body": [
+            "#include \"..\\script_component.hpp\"",
+            "/*",
+            " * Author: ${1:Author}",
+            " * ${2:Description}",
+            " *",
+            " * Arguments:",
+            " * ${8:0: ${9:Description} <${10|OBJECT,NUMBER,STRING,BOOL,ARRAY,CONTROL,DISPLAY,CONFIG,CODE,ANY,LOGIC,SIDE,GROUP,HASHMAP,NAMESPACE,LOCATION,TEXT|}>}$0",
+            " *",
+            " * Return Value:",
+            " * ${4:${5:Description} <${6|OBJECT,NUMBER,STRING,BOOL,ARRAY,CONTROL,DISPLAY,CONFIG,CODE,ANY,LOGIC,SIDE,GROUP,HASHMAP,NAMESPACE,LOCATION,TEXT|}>}",
+            " *",
+            " * Example:",
+            " * [$7] call ace_${TM_DIRECTORY/(.*)addons\\\\(.*)\\\\functions(.*)/$2/}_${TM_FILENAME_BASE}",
+            " *",
+            " * Public: ${3|No,Yes|}",
+            " */",
+            "",
+            ""
+        ],
+    },
+    "SQF Function Header Argument": {
+        "description": "SQF function header argument",
+        "prefix": "header_argument",
+        "body": [
+            "* ${1:1}: ${2:Description} <${3|OBJECT,NUMBER,STRING,BOOL,ARRAY,CONTROL,DISPLAY,CONFIG,CODE,ANY,LOGIC,SIDE,GROUP,HASHMAP,NAMESPACE,LOCATION,TEXT|}>",
+        ],
+    },
+    "SQF Function Header Return Value": {
+        "description": "SQF function header return value",
+        "prefix": "header_return",
+        "body": [
+            "* ${1:Description} <${2|OBJECT,NUMBER,STRING,BOOL,ARRAY,CONTROL,DISPLAY,CONFIG,CODE,ANY,LOGIC,SIDE,GROUP,HASHMAP,NAMESPACE,LOCATION,TEXT|}>",
+        ],
+    },
+}
diff --git a/tools/.vscode/tasks.json b/.vscode/tasks.json
similarity index 99%
rename from tools/.vscode/tasks.json
rename to .vscode/tasks.json
index ef04bb50f57..3ee52af3279 100644
--- a/tools/.vscode/tasks.json
+++ b/.vscode/tasks.json
@@ -81,7 +81,6 @@
                 "Validate Stringtables",
                 "Validate headers",
                 "Check Strings",
-                "SQFVM Checker",
                 "HEMTT check"
             ],
             "group": {